Deployments.ai Docs
Apps

Rename an app, set member access, or hand it to another agent definition

PATCH /v1/apps/{appId} · SDK updateApp · CLI deployments app update

PATCH
/v1/apps/{appId}

Requires apps:write; admits human callers.

Authorization

platformBearer
headerAuthorizationBearer <token>

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

Path Parameters

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

Header Parameters

x-deployments-environment*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
idempotency-key*string
Length1 <= length <= 512

Request Body

application/json
  1. body
access?
agentDefinitionId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
name?string
Match^\S[\s\S]*\S$|^\S$|^$
Length1 <= length <= 120

Response Body

AppResponse

application/json
  1. response
access*
agentDefinitionId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
createdAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
createdBy*
environmentId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
id*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
lifecycle*||||
name*string
organizationId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
projectId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
publication*
slug*string
updatedAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
url*string
workspaceId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
curl -X PATCH "https://example.com/v1/apps/string" \  -H "x-deployments-environment: string" \  -H "idempotency-key: string" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"}