Skip to main content
POST
Create a project

Authorizations

Authorization
string
header
required

A personal access token (POST /v1/auth/tokens) or a machine identity token (POST /v1/projects/{project_id}/identities/{identity_id}/tokens), both prefixed qumo_pat_. A token's scopes cap what it can do; see Scopes and permissions. A personal token names no organization: on a route whose path names no project or organization, pass ?organization_id=.

Query Parameters

organization_id
string<uuid>

The organization the request acts in. Required with a personal token or a session, which name no organization themselves; an identity token's organization is implied.

Body

application/json
name
string
required

Display name. The project's slug is derived from it.

Minimum string length: 1
Example:

"Live"

environment
enum<string>
default:prod

prod (the default) or dev. production and test are accepted as older names for them.

Available options:
prod,
dev,
production,
test
Example:

"prod"

Response

The project was created.

A project inside an organization; signing keys and identities belong to one.

id
string<uuid>
required

The project's id.

Example:

"9b1d6e2f-4a3c-4f8b-a7e5-0c9d2b4f6e81"

organization_id
string<uuid>
required

The organization that owns the project.

Example:

"3f8c2a1e-7b4d-4e9a-9c61-2d5e8f0a1b7c"

name
string
required

Display name.

Example:

"Live"

slug
string
required

The project's name in broadcast paths, after the organization's slug. Unique within the organization, derived from the name at creation, and unchanged when the name changes.

Example:

"live"

environment
enum<string>
required

Which relays the project's credentials work on: prod on the managed relay network, dev on a relay you run yourself.

Available options:
prod,
dev
Example:

"prod"

created_at
string<date-time>
required

When the project was created.

Example:

"2026-09-14T08:21:37Z"

suspended_at
string<date-time> | null
required

When Qumo took the project off the managed relays, or null. While set, credentials signed with the project's keys are refused there.

Example:

null