v1

latestOpenAPI 3.1.12026-08-063445179.6 KB
apps

List apps

List apps with optional filtering by labels or layer.

Use labels[key]=value query parameters to filter by label values. Use layer to filter apps that reference a specific layer.

get/v2/apps

Query parameters

cursorstring

The pagination cursor

limitinteger

The maximum number of items to return

labelsobject

Filter by labels (e.g. labels[key]=value)

{
  "custom.customer_id": "cust_123",
  "custom.environment": "production",
  "custom.regions": [
    "us-east",
    "eu-west"
  ]
}
layerstring

Layer ID or slug. Slugs cannot contain underscores; IDs always do.

Response

OK

idstring uuid required

Unique app identifier (UUID)

slugstring required

Human-readable app slug. App slugs must be 3–32 characters long, may contain only lowercase letters, numbers, and hyphens, cannot contain underscores, must not start or end with a hyphen, must not have consecutive hyphens in positions 3 and 4, and cannot be a reserved slug.

labelsLabels
updated_atstring required

ISO 8601 timestamp of last modification

created_atstring required

ISO 8601 timestamp of creation

Example response

[
  {
    "labels": {
      "custom.customer_id": "cust_123",
      "custom.environment": "production",
      "custom.regions": [
        "us-east",
        "eu-west"
      ]
    },
    "layers": [
      {
        "id": "lyr_abc123",
        "slug": "shared-secrets"
      }
    ]
  }
]