Projects
47 operations.
List provider credentials
GET/api/v1/organizations/{organizationIdOrSlug}/provider-credentials
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to List provider credentials. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Create a provider credential
POST/api/v1/organizations/{organizationIdOrSlug}/provider-credentials
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to Create a provider credential. |
Request body
required — Request body for: Create a provider credential.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| label | string | required | |
| provider | one of 2 types | required | |
| credentialType | "api_key" | "oauth" | "service_account" | "connection_string" | required | |
| secret | string | required | |
| expiresAt | one of 2 types | optional |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Get a provider credential
GET/api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to Get a provider credential. |
| credentialId | string | required | Identifies the provider credential being addressed. Applies to Get a provider credential. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Update a provider credential
PATCH/api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to Update a provider credential. |
| credentialId | string | required | Identifies the provider credential being addressed. Applies to Update a provider credential. |
Request body
required — Request body for: Update a provider credential.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| label | string | optional | |
| status | "active" | "disabled" | "deleting" | optional | |
| expiresAt | one of 2 types | optional |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Delete a provider credential
DELETE/api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to Delete a provider credential. |
| credentialId | string | required | Identifies the provider credential being addressed. Applies to Delete a provider credential. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | type none |
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Rotate a provider credential
POST/api/v1/organizations/{organizationIdOrSlug}/provider-credentials/{credentialId}/versions
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to Rotate a provider credential. |
| credentialId | string | required | Identifies the provider credential being addressed. Applies to Rotate a provider credential. |
Request body
required — Request body for: Rotate a provider credential.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| secret | string | required |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
List projects
GET/api/v1/projects
Parameters
query
| Name | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List projects. |
| cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List projects. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | Bad Request | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Create a project
POST/api/v1/projects
Request body
required — Request body for: Create a project.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| slug | string | required | |
| name | string | required | |
| templateId | string | optional |
Responses
| Status | Description | Body |
|---|---|---|
| 201 | Response for status 201 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Get a project
GET/api/v1/projects/{projectId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Get a project. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Update a project
PATCH/api/v1/projects/{projectId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Update a project. |
Request body
required — Request body for: Update a project.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | optional | |
| slug | string | optional | |
| status | "active" | "paused" | optional |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Request project deletion
DELETE/api/v1/projects/{projectId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Request project deletion. |
Responses
| Status | Description | Body |
|---|---|---|
| 202 | Response for status 202 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
| 503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json PublicApiError
|
List project agents
GET/api/v1/projects/{projectId}/agents
Returns the canonical Agents owned by this Project with cursor pagination.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to List project agents. |
query
| Name | Type | Required | Description |
|---|---|---|---|
| cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List project agents. |
| limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List project agents. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Create a project agent
POST/api/v1/projects/{projectId}/agents
Creates a Project Agent identity. Publish an immutable Agent revision separately before selecting it for a Release.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Create a project agent. |
Request body
required — Request body for: Create a project agent.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| slug | string | required | |
| name | string | required | |
| description | string | optional |
Responses
| Status | Description | Body |
|---|---|---|
| 201 | Response for status 201 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Get a project agent
GET/api/v1/projects/{projectId}/agents/{agentId}
Returns one canonical Project Agent identity and its lifecycle status within the requested Project.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Get a project agent. |
| agentId | string | required | Identifies the Project Agent being addressed. Applies to Get a project agent. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Update a project agent
PATCH/api/v1/projects/{projectId}/agents/{agentId}
Updates the Project Agent display metadata. Immutable Agent revisions and their content are not changed by this request.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Update a project agent. |
| agentId | string | required | Identifies the Project Agent being addressed. Applies to Update a project agent. |
Request body
required — Request body for: Update a project agent.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | optional | |
| description | one of 2 types | optional |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Delete a project agent
DELETE/api/v1/projects/{projectId}/agents/{agentId}
Queues deletion of the Project Agent and returns 202 with the canonical resource. Deletion is rejected with 409 while an active Deployment, enabled Agent Job, non-terminal AgentRun, or live delegation depends on the Agent.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Delete a project agent. |
| agentId | string | required | Identifies the Project Agent being addressed. Applies to Delete a project agent. |
Responses
| Status | Description | Body |
|---|---|---|
| 202 | Response for status 202 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
List Agent revisions
GET/api/v1/projects/{projectId}/agents/{agentId}/revisions
Lists immutable revisions for the canonical Project Agent. Cursors continue the same Project and Agent scope.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to List Agent revisions. |
| agentId | string | required | Identifies the Project Agent being addressed. Applies to List Agent revisions. |
query
| Name | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List Agent revisions. |
| cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List Agent revisions. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json getApiV1ProjectsByProjectIdAgentsByAgentIdRevisions
|
| 400 | Bad Request | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Create an Agent revision
POST/api/v1/projects/{projectId}/agents/{agentId}/revisions
Creates one immutable Agent revision. The returned revision ID is the exact pin accepted by Release creation; it does not silently follow a later revision.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Create an Agent revision. |
| agentId | string | required | Identifies the Project Agent being addressed. Applies to Create an Agent revision. |
Request body
required — Request body for: Create an Agent revision.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| content | object | required | |
| grantedOperations | array<"agents:invoke-operation" | "agents:manage-workflows" | "agents:render-presentation" | "projects:list" | "projects:get" | "projects:create" | "projects:update" | "projects:delete" | "projects:read-runtime-data" | "analytics:read" | "projects:manage-access-grants" | "deployments:create" | "activations:create" | "env:variables:list" | "env:variables:get" | "env:variables:create" | "env:variables:update" | "env:variables:delete" | "provider-credentials:list" | "provider-credentials:get" | "provider-credentials:create" | "provider-credentials:update" | "provider-credentials:delete" | "provider-credentials:versions:create" | "organizations:get" | "organizations:delete" | "organizations:update" | "organizations:manage-user-groups" | "organizations:manage-members" | "organization-integrations:list" | "organization-integrations:get" | "organization-integrations:create" | "organization-integrations:update" | "organization-integrations:delete" | "organization-integrations:verify" | "organization-integrations:presets:list" | "organization-variables:list" | "organization-variables:manage" | "connections:list" | "connections:get" | "connections:create" | "connections:update" | "connections:delete" | "connections:start-oauth" | "connections:presets:list" | "api-keys:list" | "api-keys:get" | "api-keys:create" | "api-keys:update" | "api-keys:revoke" | "definitions:list" | "definitions:get" | "definitions:create" | "definitions:update" | "definitions:delete" | "operation-invocations:list" | "operation-approvals:list" | "operation-approvals:approve" | "operation-approvals:reject" | "agents:get" | "agents:list" | "agents:revisions:create" | "agents:revisions:get" | "agents:revisions:list" | "agents:delete" | "agents:push" | "agent-runs:cancel" | "agent-runs:continue" | "agent-runs:create" | "agent-runs:personalize" | "agent-runs:get" | "agent-runs:list" | "agent-runs:stream" | "agent-runs:update" | "agent-runs:steps:create" | "agent-runs:steps:get" | "agent-runs:steps:list" | "agent-runs:steps:checkpoints:create" | "agent-runs:steps:checkpoints:get" | "agent-runs:checkpoints:list" | "agent-runs:attempts:complete" | "agent-runs:attempts:heartbeat" | "agent-jobs:list" | "agent-jobs:get" | "agent-jobs:create" | "agent-jobs:update" | "agent-jobs:delete" | "agent-jobs:run-now" | "webhooks:list" | "webhooks:create" | "webhooks:delete" | "webhooks:rotate-secret" | "webhooks:replay" | "webhooks:retry-dead" | "webhooks:rebaseline" | "webhooks:events:read" | "templates:search" | "templates:read" | "billing:read" | "billing:manage"> | optional |
Responses
| Status | Description | Body |
|---|---|---|
| 201 | Response for status 201 | application/json postApiV1ProjectsByProjectIdAgentsByAgentIdRevisions
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Get an Agent revision
GET/api/v1/projects/{projectId}/agents/{agentId}/revisions/{agentRevisionId}
Returns the exact immutable Agent revision identified by the URL, without resolving the Agent's latest revision or merging another Agent.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Get an Agent revision. |
| agentId | string | required | Identifies the Project Agent being addressed. Applies to Get an Agent revision. |
| agentRevisionId | string | required | Identifies the immutable Project Agent revision being addressed. Applies to Get an Agent revision. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json getApiV1ProjectsByProjectIdAgentsByAgentIdRevisionsByAgentRevisionId
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
List project environments
GET/api/v1/projects/{projectId}/environments
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to List project environments. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Create a custom project environment
POST/api/v1/projects/{projectId}/environments
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Create a custom project environment. |
Request body
required — Request body for: Create a custom project environment.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| slug | string | required | |
| displayName | string | required |
Responses
| Status | Description | Body |
|---|---|---|
| 201 | Response for status 201 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Get project environment
GET/api/v1/projects/{projectId}/environments/{environmentId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Get project environment. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Get project environment. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Update project environment
PATCH/api/v1/projects/{projectId}/environments/{environmentId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Update project environment. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Update project environment. |
Request body
required — Request body for: Update project environment.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| lifecycle | "provisioning" | "active" | "paused" | "deleting" | optional | |
| expectedLifecycle | "provisioning" | "active" | "paused" | "deleting" | optional | |
| slug | string | optional | |
| displayName | string | optional |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | Bad Request | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Delete custom project environment
DELETE/api/v1/projects/{projectId}/environments/{environmentId}
Marks a custom Project Environment for deletion and queues exact owned runtime cleanup. Built-in development, preview, and production Environments are protected and return 409. The response is an asynchronous deletion receipt; it does not claim that provider cleanup has already finished.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Delete custom project environment. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Delete custom project environment. |
Responses
| Status | Description | Body |
|---|---|---|
| 202 | Response for status 202 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
| 503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json PublicApiError
|
Get active deployment
GET/api/v1/projects/{projectId}/environments/{environmentId}/activation
Returns the current active Deployment coordinate for this Environment, including its Release and configuration revision. A valid Environment with no active Deployment returns 404; no provider or runtime locator is exposed.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Get active deployment. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Get active deployment. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
List activation history
GET/api/v1/projects/{projectId}/environments/{environmentId}/activations
Lists immutable activation records for one exact Project Environment. Use pagination.nextCursor for the next page; the cursor is opaque and bound to this Project/Environment. A missing or inaccessible coordinate is 404, and malformed pagination is 422.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to List activation history. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to List activation history. |
query
| Name | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List activation history. |
| cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List activation history. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Activate deployment
POST/api/v1/projects/{projectId}/environments/{environmentId}/activations
Synchronously activates an eligible ready Deployment and atomically advances this Environment's active pointer and generation. The expectedGeneration field is a compare-and-set guard; non-ready or stale/conflicting requests return 409, while a missing or foreign Project/Environment/Deployment coordinate returns 404.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Activate deployment. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Activate deployment. |
Request body
required — Request body for: Activate deployment.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| deploymentId | string | required | |
| expectedGeneration | integer | required |
Responses
| Status | Description | Body |
|---|---|---|
| 201 | Response for status 201 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Get an activation
GET/api/v1/projects/{projectId}/environments/{environmentId}/activations/{activationId}
Returns one immutable Activation for the exact Project Environment coordinate. The response includes the pinned Deployment, Release, configuration revision, generation, actor, and timestamps; an unknown or foreign activation is 404.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Get an activation. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Get an activation. |
| activationId | string | required | Identifies the Project Environment activation being addressed. Applies to Get an activation. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
List deployments
GET/api/v1/projects/{projectId}/environments/{environmentId}/deployments
Lists Deployments belonging to the exact Project Environment coordinate. Deployment execution state is reported by the returned lifecycle status.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to List deployments. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to List deployments. |
query
| Name | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List deployments. |
| cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List deployments. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | Bad Request | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Create a deployment
POST/api/v1/projects/{projectId}/environments/{environmentId}/deployments
Submits a Deployment using an existing immutable Release and the Environment's existing configuration revision head. Artifact validation occurs before the durable submission; execution is queued asynchronously. Reuse the same Idempotency-Key and payload to safely retry. A mismatched key returns 409, an in-progress claim may return 503 with Retry-After, and missing or incompatible pins return 404 or 422.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Create a deployment. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Create a deployment. |
header
| Name | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | required |
Request body
required — Request body for: Create a deployment.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| releaseId | string | optional | Immutable Release whose exact Agent and Definition revision pins will be deployed. |
| configurationRevisionId | string | required | Existing immutable configuration revision head for this Project Environment. |
| sourceReleaseId | string | optional | |
| expectedActiveDeploymentId | string | optional | |
| reason | string | optional |
Responses
| Status | Description | Body |
|---|---|---|
| 201 | Response for status 201 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
| 503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json PublicApiError
|
Get deployment
GET/api/v1/projects/{projectId}/environments/{environmentId}/deployments/{deploymentId}
Returns one Deployment for the exact Project and Environment coordinate, including its immutable Release and configuration revision pins.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Get deployment. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Get deployment. |
| deploymentId | string | required | Identifies the Project Deployment being addressed. Applies to Get deployment. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Cancel a deployment
PATCH/api/v1/projects/{projectId}/environments/{environmentId}/deployments/{deploymentId}
Requests terminal cancellation with an expected-state CAS. Existing materialized resources are retained for cleanup.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Cancel a deployment. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Cancel a deployment. |
| deploymentId | string | required | Identifies the Project Deployment being addressed. Applies to Cancel a deployment. |
Request body
required — Request body for: Cancel a deployment.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| status | "canceled" | required | |
| expectedStatus | "queued" | "validating" | "provisioning" | "materializing" | "ready" | "failed" | "canceled" | optional | |
| reason | string | required |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Invoke an operation
POST/api/v1/projects/{projectId}/environments/{environmentId}/operations/{definitionIdOrName}/invocations
Execute an operation from the selected deployment. Definition data constraint failures return 422 with details.invocationId and a safe details.diagnostic. Inspect persisted diagnostics through the operation invocation list. A required auto-managed field must be included in the deployed domain's auto declarations; it must not be supplied manually. Infrastructure failures remain server errors, not input validation errors.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Invoke an operation. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Invoke an operation. |
| definitionIdOrName | one of 2 types | required | Identifies the definition element by its stable identifier or name. Applies to Invoke an operation. |
Request body
required — Request body for: Invoke an operation.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| agentId | string | required | |
| params | object | optional | |
| actorUserId | string | optional | |
| approvalId | string | optional | |
| requestKey | string | optional |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json postApiV1ProjectsByProjectIdEnvironmentsByEnvironmentIdOperationsByDefinitionIdOrNameInvocations |
| 202 | Response for status 202 | application/json object
|
| 400 | Bad Request | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Render a deployed presentation
POST/api/v1/projects/{projectId}/environments/{environmentId}/presentations/{definitionIdOrName}/renders
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Render a deployed presentation. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Render a deployed presentation. |
| definitionIdOrName | one of 2 types | required | Identifies the definition element by its stable identifier or name. Applies to Render a deployed presentation. |
Request body
required — Request body for: Render a deployed presentation.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| agentId | string | required | |
| params | object | optional | |
| actorUserId | string | optional | |
| requestKey | string | optional |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json postApiV1ProjectsByProjectIdEnvironmentsByEnvironmentIdPresentationsByDefinitionIdOrNameRenders
|
| 400 | Bad Request | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
List Project members
GET/api/v1/projects/{projectId}/members
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to List Project members. |
query
| Name | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List Project members. |
| cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List Project members. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Add a Project member
POST/api/v1/projects/{projectId}/members
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Add a Project member. |
Request body
required — Request body for: Add a Project member.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| userId | string | required | |
| role | "admin" | "developer" | "viewer" | required |
Responses
| Status | Description | Body |
|---|---|---|
| 201 | Response for status 201 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Update a Project member role
PATCH/api/v1/projects/{projectId}/members/{userId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Update a Project member role. |
| userId | string | required | Identifies the user whose membership or grant is being addressed. Applies to Update a Project member role. |
Request body
required — Request body for: Update a Project member role.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| role | "admin" | "developer" | "viewer" | required |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Remove a Project member
DELETE/api/v1/projects/{projectId}/members/{userId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Remove a Project member. |
| userId | string | required | Identifies the user whose membership or grant is being addressed. Applies to Remove a Project member. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
List project releases
GET/api/v1/projects/{projectId}/releases
Lists immutable Releases belonging to the Project. Each Release records the exact Agent and Definition revision pins used to build it.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to List project releases. |
query
| Name | Type | Required | Description |
|---|---|---|---|
| cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List project releases. |
| limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List project releases. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Create project release
POST/api/v1/projects/{projectId}/releases
Creates an immutable Release from the explicitly supplied Agent and Definition revision IDs. The server validates the complete pin and delegate graph before accepting the Release.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Create project release. |
Request body
required — Request body for: Create project release.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| agentRevisions | array<object> | required | |
| definitionRevisions | array<object> | required |
Responses
| Status | Description | Body |
|---|---|---|
| 201 | Response for status 201 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Get project release
GET/api/v1/projects/{projectId}/releases/{releaseId}
Returns one immutable Project Release and its revision-pinned manifest; it does not expose provider locators or internal storage details.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Get project release. |
| releaseId | string | required | Identifies the immutable Project Release being addressed. Applies to Get project release. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
List Project user-group grants
GET/api/v1/projects/{projectId}/user-groups
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to List Project user-group grants. |
query
| Name | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List Project user-group grants. |
| cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List Project user-group grants. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Grant a Project user group access
POST/api/v1/projects/{projectId}/user-groups
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Grant a Project user group access. |
Request body
required — Request body for: Grant a Project user group access.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| userGroupId | string | required | |
| role | "admin" | "developer" | "viewer" | required |
Responses
| Status | Description | Body |
|---|---|---|
| 201 | Response for status 201 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Update a Project user-group grant
PATCH/api/v1/projects/{projectId}/user-groups/{userGroupId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Update a Project user-group grant. |
| userGroupId | string | required | Identifies the Organization or Project user group being addressed. Applies to Update a Project user-group grant. |
Request body
required — Request body for: Update a Project user-group grant.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| role | "admin" | "developer" | "viewer" | required |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Remove a Project user-group grant
DELETE/api/v1/projects/{projectId}/user-groups/{userGroupId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Remove a Project user-group grant. |
| userGroupId | string | required | Identifies the Organization or Project user group being addressed. Applies to Remove a Project user-group grant. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Get a user
GET/api/v1/users/{userId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| userId | string | required | Identifies the user whose membership or grant is being addressed. Applies to Get a user. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Update own user profile
PATCH/api/v1/users/{userId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| userId | string | required | Identifies the user whose membership or grant is being addressed. Applies to Update own user profile. |
Request body
required — Request body for: Update own user profile.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | optional | |
| image | one of 2 types | optional |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid credentials | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|