Project Runtime
5 operations.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/projects/{projectId}/environments/{environmentId}/runtime-binding | Get environment runtime binding |
| POST | /api/v1/projects/{projectId}/environments/{environmentId}/runtime-binding | Provision an environment runtime binding |
| DELETE | /api/v1/projects/{projectId}/environments/{environmentId}/runtime-binding | Request environment runtime deletion |
| GET | /api/v1/projects/{projectId}/environments/{environmentId}/runtime/tables | List active runtime tables |
| GET | /api/v1/projects/{projectId}/environments/{environmentId}/runtime/tables/{tableName} | Read active runtime table |
Get environment runtime binding
GET/api/v1/projects/{projectId}/environments/{environmentId}/runtime-binding
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Get environment runtime binding. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Get environment runtime binding. |
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. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Provision an environment runtime binding
POST/api/v1/projects/{projectId}/environments/{environmentId}/runtime-binding
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Provision an environment runtime binding. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Provision an environment runtime binding. |
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. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Request environment runtime deletion
DELETE/api/v1/projects/{projectId}/environments/{environmentId}/runtime-binding
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Request environment runtime deletion. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Request environment runtime 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 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. | 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 active runtime tables
GET/api/v1/projects/{projectId}/environments/{environmentId}/runtime/tables
Lists domain tables from the active immutable Deployment only. Results are limited to 100 tables per request and require the projects:read-runtime-data operation; the opaque cursor is bound to the Project, Environment, and active Deployment and must be restarted after activation changes.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to List active runtime tables. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to List active runtime tables. |
query
| Name | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List active runtime tables. |
| cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List active runtime tables. |
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
|
Read active runtime table
GET/api/v1/projects/{projectId}/environments/{environmentId}/runtime/tables/{tableName}
Reads a bounded preview from an allowlisted domain table in the active Environment Runtime and requires the projects:read-runtime-data operation. Arbitrary SQL, provider metadata, connection details, and schema internals are not exposed.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Read active runtime table. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Read active runtime table. |
| tableName | string | required | Identifies the runtime database table being addressed. Applies to Read active runtime table. |
query
| Name | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to Read active runtime table. |
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
|