Deployments.ai Docs
Apps

List apps, or find one by its slug

GET /v1/apps · SDK listApps · CLI deployments app list

GET
/v1/apps

Requires apps:read; admits human and service-account callers.

Authorization

platformBearer
headerAuthorizationBearer <token>

Platform bearer credential accepted as an opaque API key or JWT.

Query Parameters

cursor?string
Length1 <= length <= 4096
limit?integer
Range1 <= value <= 100
slug?string

Only the app with this exact slug. The list then holds that app, or nothing when no app in the environment has the slug.

Length1 <= length <= 35

Header Parameters

x-deployments-environment*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

ListAppsResponse

application/json
  1. response
items*array<>
nextCursor?|null|null
curl -X GET "https://example.com/v1/apps" \  -H "x-deployments-environment: string"
{  "items": [    {      "access": {        "organizationMembers": "none"      },      "agentDefinitionId": "string",      "createdAt": "2019-08-24T14:15:22Z",      "createdBy": {        "principalId": "string",        "runId": "string"      },      "environmentId": "string",      "id": "string",      "lifecycle": {        "requestedAt": "2019-08-24T14:15:22Z",        "state": "provisioning"      },      "name": "string",      "organizationId": "string",      "projectId": "string",      "publication": {        "audience": "members",        "serving": "single-page"      },      "slug": "string",      "updatedAt": "2019-08-24T14:15:22Z",      "url": "string",      "workspaceId": "string"    }  ],  "nextCursor": "string"}