Skip to main content
GET
Get the current project deployment status

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128

Path Parameters

project_id
string
required

Project identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

The current tenant-scoped project status.

project_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
handle
string
required
Required string length: 5 - 59
Pattern: ^[a-z]+-[a-z]+-[a-z]+$
lifecycle
enum<string>
required
Available options:
active,
deleting,
deleted
source
object | null
required
default_environment
object | null
required
head_deployment
object | null
required
dev_url
string<uri> | null
required
Pattern: ^https://dev-[a-z]+-[a-z]+-[a-z]+\.(?:dev\.)?check\.omh\.st$
prod_url
string<uri> | null
required
Pattern: ^https://[a-z]+-[a-z]+-[a-z]+\.(?:dev\.)?check\.omh\.st$
latest_operation
object | null
required

Durable record returned for an accepted asynchronous mutation. Optional reconciliation is a current observation for queued/running work, separate from immutable terminal state. A completed reconciliation attempt alone does not mean the operation succeeded.

cleanup_state
enum<string>
required
Available options:
not_started,
pending,
completed,
reconciliation_required
environments
object[]

Tenant-scoped Dev and Prod environment IDs for secrets and other environment-scoped commands. Select by name; never infer the Prod ID from the default Dev environment.

Maximum array length: 2