Deployment groups

List deployment groups

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

project?string

Filter by project ID or name.

Lengthlength <= 100

search?string

Search deployment groups by name

include?array<>

Optional fields to include: project

limit?integer

Maximum number of items to return per page

Range1 <= value <= 100

Default20

cursor?string

Cursor for pagination - omit for first page

`application/json`

curl -X GET "https://example.com/v1/deployment-groups?project=my-project"

{  "items": [    {      "id": "dg_r27ict8c7vcgsumpj90ackf7b",      "name": "prod-us-east-1",      "externalId": "ext_example_01",      "projectId": "prj_mcytp6z3j91f7tn5ryqsfwtr",      "workspaceId": "ws_It13CUaGEhLLAB87simX0",      "maxDeployments": 100,      "createdAt": "2019-08-24T14:15:22Z",      "project": {        "id": "string",        "name": "string"      }    }  ],  "nextCursor": "string"}

Create a new deployment group

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Deployment group name.

Match^(?!dg[-_])[a-z0-9](-?[a-z0-9])*$

Length2 <= length <= 100

externalId?string

Case-sensitive, URL- and header-safe identifier from the integrating application.

Match^[A-Za-z0-9][A-Za-z0-9._~-]*$

Length1 <= length <= 128

project*string

Project ID or name this deployment group belongs to

Lengthlength <= 100

maxDeployments?integer

Maximum number of deployments in this deployment group

Range1 <= value

Default100

`application/json`

curl -X POST "https://example.com/v1/deployment-groups" \  -H "Content-Type: application/json" \  -d '{    "name": "prod-us-east-1",    "project": "string"  }'

{  "id": "dg_r27ict8c7vcgsumpj90ackf7b",  "name": "prod-us-east-1",  "externalId": "ext_example_01",  "projectId": "prj_mcytp6z3j91f7tn5ryqsfwtr",  "workspaceId": "ws_It13CUaGEhLLAB87simX0",  "maxDeployments": 100,  "createdAt": "2019-08-24T14:15:22Z"}

Get or create a deployment group by project and name

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Deployment group name.

Match^(?!dg[-_])[a-z0-9](-?[a-z0-9])*$

Length2 <= length <= 100

project*string

Project ID or name this deployment group belongs to

Lengthlength <= 100

maxDeployments?integer

Maximum number of deployments for newly created groups

Range1 <= value

Default100

`application/json`

curl -X PUT "https://example.com/v1/deployment-groups/by-name" \  -H "Content-Type: application/json" \  -d '{    "name": "prod-us-east-1",    "project": "string"  }'

{  "id": "dg_r27ict8c7vcgsumpj90ackf7b",  "name": "prod-us-east-1",  "externalId": "ext_example_01",  "projectId": "prj_mcytp6z3j91f7tn5ryqsfwtr",  "workspaceId": "ws_It13CUaGEhLLAB87simX0",  "maxDeployments": 100,  "createdAt": "2019-08-24T14:15:22Z"}

Get a deployment group by project and external ID

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

project?string

Project ID or name. Optional for project-scoped API keys.

Lengthlength <= 100

externalId*string

Case-sensitive, URL- and header-safe identifier from the integrating application.

Match^[A-Za-z0-9][A-Za-z0-9._~-]*$

Length1 <= length <= 128

`application/json`

curl -X GET "https://example.com/v1/deployment-groups/by-external-id?externalId=ext_example_01"

{  "id": "dg_r27ict8c7vcgsumpj90ackf7b",  "name": "prod-us-east-1",  "externalId": "ext_example_01",  "projectId": "prj_mcytp6z3j91f7tn5ryqsfwtr",  "workspaceId": "ws_It13CUaGEhLLAB87simX0",  "maxDeployments": 100,  "createdAt": "2019-08-24T14:15:22Z"}

Get or create a deployment group by project and external ID

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

externalId*string

Case-sensitive, URL- and header-safe identifier from the integrating application.

Match^[A-Za-z0-9][A-Za-z0-9._~-]*$

Length1 <= length <= 128

name*string

Deployment group name.

Match^(?!dg[-_])[a-z0-9](-?[a-z0-9])*$

Length2 <= length <= 100

project*string

Project ID or name this deployment group belongs to

Lengthlength <= 100

maxDeployments?integer

Maximum number of deployments for newly created groups

Range1 <= value

Default100

`application/json`

curl -X PUT "https://example.com/v1/deployment-groups/by-external-id" \  -H "Content-Type: application/json" \  -d '{    "externalId": "ext_example_01",    "name": "prod-us-east-1",    "project": "string"  }'

{  "id": "dg_r27ict8c7vcgsumpj90ackf7b",  "name": "prod-us-east-1",  "externalId": "ext_example_01",  "projectId": "prj_mcytp6z3j91f7tn5ryqsfwtr",  "workspaceId": "ws_It13CUaGEhLLAB87simX0",  "maxDeployments": 100,  "createdAt": "2019-08-24T14:15:22Z"}

Get deployment group details

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

include?array<>

Optional fields to include: project

`application/json`

curl -X GET "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b"

{  "id": "dg_r27ict8c7vcgsumpj90ackf7b",  "name": "prod-us-east-1",  "externalId": "ext_example_01",  "projectId": "prj_mcytp6z3j91f7tn5ryqsfwtr",  "workspaceId": "ws_It13CUaGEhLLAB87simX0",  "maxDeployments": 100,  "createdAt": "2019-08-24T14:15:22Z",  "project": {    "id": "string",    "name": "string"  },  "deploymentCount": 0}

Update deployment group

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Deployment group name.

Match^(?!dg[-_])[a-z0-9](-?[a-z0-9])*$

Length2 <= length <= 100

maxDeployments?integer

Maximum number of deployments in this deployment group

Range1 <= value

`application/json`

curl -X PATCH "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "dg_r27ict8c7vcgsumpj90ackf7b",  "name": "prod-us-east-1",  "externalId": "ext_example_01",  "projectId": "prj_mcytp6z3j91f7tn5ryqsfwtr",  "workspaceId": "ws_It13CUaGEhLLAB87simX0",  "maxDeployments": 100,  "createdAt": "2019-08-24T14:15:22Z"}

Set or clear a deployment group's external ID

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

externalId*|

Case-sensitive, URL- and header-safe identifier from the integrating application.

Match^[A-Za-z0-9][A-Za-z0-9._~-]*$

Length1 <= length <= 128

`application/json`

curl -X PUT "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/external-id" \  -H "Content-Type: application/json" \  -d '{    "externalId": "ext_example_01"  }'

{  "id": "dg_r27ict8c7vcgsumpj90ackf7b",  "name": "prod-us-east-1",  "externalId": "ext_example_01",  "projectId": "prj_mcytp6z3j91f7tn5ryqsfwtr",  "workspaceId": "ws_It13CUaGEhLLAB87simX0",  "maxDeployments": 100,  "createdAt": "2019-08-24T14:15:22Z"}

Create deployment group token

Creates a deployment-group scoped API key and returns both the token and formatted deployment link

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?string

Description for the API key

expiresAt?|

Optional expiration date for the API key

Formatdate-time

deploymentSetupConfig?

setupItems?|array<>

Setup to include. Use 'all' for every capability enabled for the Project. Omit to preserve the standard deployment-link behavior.

entryPoint?

Portal destination to open first. This controls navigation, not authorization.

inputValues?

Default{}

`application/json`

curl -X POST "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/tokens" \  -H "Content-Type: application/json" \  -d '{}'

{  "token": "string",  "deploymentLink": "string"}

Get the AWS external ID for this deployment group

Returns the value to enter as the ManagementExternalId parameter when installing or updating this group's CloudFormation or Terraform setup from a template file. The management roles require it as sts:ExternalId. Requires the same permission as creating a setup link.

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Response Body

`application/json`

curl -X GET "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/management-external-id"

{  "managementExternalId": "string"}

Create first-party deployment session

Mints a short-lived deployment-group token with the recommended self-deploy policy for the authenticated developer.

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Response Body

`application/json`

curl -X POST "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/first-party-session"

{  "token": "string"}

Get external AI connection state

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Response Body

`application/json`

curl -X GET "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/ai/external"

{  "binding": {    "id": "string",    "provider": "anthropic",    "providerEndpoint": "string",    "providerClientId": "string",    "keyFingerprint": "string",    "credentialRevision": 1,    "credentialStatus": "pending",    "credentialCheckedAt": "2019-08-24T14:15:22Z",    "catalogProviderModelIds": [      "string"    ],    "catalogObservedAt": "2019-08-24T14:15:22Z",    "requiredModelCoverage": [      {        "publicModelId": "string",        "available": true,        "accessStatus": "verified",        "accessObservedAt": "2019-08-24T14:15:22Z"      }    ],    "updatedAt": "2019-08-24T14:15:22Z"  }}

Revoke the external AI connection

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/ai/external"

Empty

Connect or rotate an external AI provider key

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

provider*string

Value in

"anthropic"
"openai"

apiKey*string

Length1 <= length <= 512

acknowledgeAlienCredentialAccess*true

Value in

true

Response Body

`application/json`

curl -X PUT "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/ai/external" \  -H "Content-Type: application/json" \  -d '{    "provider": "anthropic",    "apiKey": "string",    "acknowledgeAlienCredentialAccess": true  }'

{  "id": "string",  "provider": "anthropic",  "providerEndpoint": "string",  "providerClientId": "string",  "keyFingerprint": "string",  "credentialRevision": 1,  "credentialStatus": "pending",  "credentialCheckedAt": "2019-08-24T14:15:22Z",  "catalogProviderModelIds": [    "string"  ],  "catalogObservedAt": "2019-08-24T14:15:22Z",  "requiredModelCoverage": [    {      "publicModelId": "string",      "available": true,      "accessStatus": "verified",      "accessObservedAt": "2019-08-24T14:15:22Z"    }  ],  "updatedAt": "2019-08-24T14:15:22Z"}

Queue an explicit external model access check

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

publicModelId*string

Length1 <= length <= 256

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Response Body

`application/json`

curl -X POST "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/ai/external/models/string/checks"

{  "id": "string",  "publicModel": "string",  "status": "pending",  "blockerCode": "string",  "error": null,  "requestedAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z"}

Get an external model access check

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

checkId*string

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Response Body

`application/json`

curl -X GET "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/ai/external/model-checks/string"

{  "id": "string",  "publicModel": "string",  "status": "pending",  "blockerCode": "string",  "error": null,  "requestedAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z"}

Get Container Registry

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Response Body

`application/json`

curl -X GET "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/container-registry"

{  "route": {    "id": "crroute_c9t4xoy7fmiq7equtu20",    "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc",    "managerId": "string",    "resourceId": "string",    "resourceRevision": "string",    "desiredRevision": 0,    "appliedRevision": 0,    "status": "resolving",    "lastVerifiedAt": "2019-08-24T14:15:22Z",    "lastError": "string"  },  "endpoint": {    "url": "http://example.com",    "source": "runtime"  },  "repositories": [    {      "id": "crrepo_625temdq3bnu25jw9rcux",      "logicalName": "string",      "desiredState": "present",      "status": "pending",      "verifiedAt": "2019-08-24T14:15:22Z"    }  ],  "credentials": [    {      "id": "crcred_oz1xjr82f37j17g4gtmyu",      "label": "string",      "scope": "pull",      "repositorySubset": [        "string"      ],      "expiresAt": "2019-08-24T14:15:22Z",      "lastUsedAt": "2019-08-24T14:15:22Z",      "revokedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z"    }  ]}

Put Container Registry

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

deploymentId*string

Unique identifier for the deployment.

Matchdep_[0-9a-z]{28}$

resourceId*string

Length1 <= length <= 128

Response Body

`application/json`

curl -X PUT "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/container-registry" \  -H "Content-Type: application/json" \  -d '{    "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc",    "resourceId": "string"  }'

{  "id": "crroute_c9t4xoy7fmiq7equtu20",  "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc",  "managerId": "string",  "resourceId": "string",  "resourceRevision": "string",  "desiredRevision": 0,  "appliedRevision": 0,  "status": "resolving",  "lastVerifiedAt": "2019-08-24T14:15:22Z",  "lastError": "string"}

Create Container Registry Repository

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Match^[a-z0-9]+(?:[._-][a-z0-9]+)*(?:\/[a-z0-9]+(?:[._-][a-z0-9]+)*)*$

Length1 <= length <= 128

Response Body

`application/json`

curl -X POST "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/container-registry/repositories" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "id": "crrepo_625temdq3bnu25jw9rcux",  "logicalName": "string",  "desiredState": "present",  "status": "pending",  "verifiedAt": "2019-08-24T14:15:22Z"}

Create Container Registry Credential

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

label*string

Length1 <= length <= 64

scope*string

Value in

"pull"
"pushPull"

repositorySubset?array<>|

Items1 <= items <= 100

expiresAt?|

Formatdate-time

Response Body

`application/json`

curl -X POST "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/container-registry/credentials" \  -H "Content-Type: application/json" \  -d '{    "label": "string",    "scope": "pull"  }'

{  "credential": {    "id": "crcred_oz1xjr82f37j17g4gtmyu",    "label": "string",    "scope": "pull",    "repositorySubset": [      "string"    ],    "expiresAt": "2019-08-24T14:15:22Z",    "lastUsedAt": "2019-08-24T14:15:22Z",    "revokedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z"  },  "username": "alien",  "password": "string"}

Revoke Container Registry Credential

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

credentialId*string

Unique identifier for the container registry credential.

Matchcrcred_[0-9a-z]{28}$

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/container-registry/credentials/crcred_oz1xjr82f37j17g4gtmyu"

Empty

Delete Container Registry Repository

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

repositoryId*string

Unique identifier for the container registry repository.

Matchcrrepo_[0-9a-z]{28}$

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

confirmName*string

Match^[a-z0-9]+(?:[._-][a-z0-9]+)*(?:\/[a-z0-9]+(?:[._-][a-z0-9]+)*)*$

Length1 <= length <= 128

disposition*string

Value in

"preserve"
"deleteContents"

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/container-registry/repositories/crrepo_625temdq3bnu25jw9rcux" \  -H "Content-Type: application/json" \  -d '{    "confirmName": "string",    "disposition": "preserve"  }'

{  "id": "crrepo_625temdq3bnu25jw9rcux",  "logicalName": "string",  "desiredState": "present",  "status": "pending",  "verifiedAt": "2019-08-24T14:15:22Z"}

Verify Container Registry

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Response Body

`application/json`

curl -X POST "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/container-registry/verify"

{  "id": "crroute_c9t4xoy7fmiq7equtu20",  "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc",  "managerId": "string",  "resourceId": "string",  "resourceRevision": "string",  "desiredRevision": 0,  "appliedRevision": 0,  "status": "resolving",  "lastVerifiedAt": "2019-08-24T14:15:22Z",  "lastError": "string"}

Revoke Container Registry

Authorization

AuthorizationBearer <token>

API key for authentication, must be provided as a Bearer token. Generate an API key at https://alien.dev/api-keys

In: header

Path Parameters

id*string

Unique identifier for the deployment group.

Matchdg_[0-9a-z]{28}$

Query Parameters

workspace?string

Workspace name or ID. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must identify the key's workspace.

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$

Length4 <= length <= 100

Response Body

`application/json`

curl -X POST "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/container-registry/revoke"

{  "id": "crroute_c9t4xoy7fmiq7equtu20",  "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc",  "managerId": "string",  "resourceId": "string",  "resourceRevision": "string",  "desiredRevision": 0,  "appliedRevision": 0,  "status": "resolving",  "lastVerifiedAt": "2019-08-24T14:15:22Z",  "lastError": "string"}

List deployment groupsCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

500application/json

Create a new deployment groupCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

404application/json

409application/json

500application/json

Get or create a deployment group by project and nameCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

404application/json

500application/json

Get a deployment group by project and external IDCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

404application/json

500application/json

Get or create a deployment group by project and external IDCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

404application/json

409application/json

500application/json

Get deployment group detailsCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

404application/json

500application/json

Update deployment groupCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

404application/json

409application/json

500application/json

Delete deployment groupCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

204

400application/json

404application/json

500application/json

Set or clear a deployment group's external IDCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

404application/json

409application/json

500application/json

Create deployment group tokenCopy Anchor Link

AuthorizationCopy Anchor Link

List deployment groups

Authorization

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

Create a new deployment group

Authorization

Query Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Get or create a deployment group by project and name

Authorization

Query Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

Get a deployment group by project and external ID

Authorization

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

Get or create a deployment group by project and external ID

Authorization

Query Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Get deployment group details

Authorization

Path Parameters

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

Update deployment group

Authorization

Path Parameters

Query Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Delete deployment group

Authorization

Path Parameters

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

Set or clear a deployment group's external ID

Authorization

Path Parameters

Query Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Create deployment group token

Authorization

Path Parameters

Query Parameters