Deployments (v2)

List Deployments

List all deployments.

get/v2/deployments

Request

The document declares no server URL.
Auth
- API key in header X-API-Key
- or API key in header X-Tenant-Id
- or HTTP bearer

Query parameters

limitinteger

Maximum number of resources to return.

offsetinteger

Pagination offset. Pass this value to subsequent requests to fetch the next page of resources.

name_containsstring nullable

Name of the deployment to filter by.

statusstring nullable

status of the deployment to filter by.

remote_reconciledboolean nullable

Flag to filter by remote reconciled deployments.

tag_value_idsstring nullable

Comma separated list of tag value IDs of the deployment to filter by.

image_versionstring nullable

Image version to filter by.

deployment_type'dev_free' | 'dev' | 'prod' | 'dev_zero' | 'dev_free_zero' nullable

Deployment type to filter by.

deployment_idsstring nullable

Comma separated list of deployment IDs to filter by.

Response

Successful Response

offsetinteger required

Pagination offset. Pass this value to subsequent requests to fetch the next page.

Example response

{
  "resources": [
    {
      "source_config": {
        "resource_spec": {
          "cpu": 0.1,
          "cpu_limit": 0.2,
          "queue_cpu": 0.1,
          "queue_cpu_limit": 0.2,
          "redis_cpu": 0.1,
          "redis_cpu_limit": 0.2
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.