Platform

Check API health

Returns a successful response when the Alien API process is serving requests.

Response Body

`application/json`

curl -X GET "https://example.com/health"

{  "status": "ok"}

Get Workspace Invitation Preview

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

token*string

Length1 <= length <= 128

Response Body

`application/json`

curl -X GET "https://example.com/v1/invitations/string"

{  "kind": "email",  "workspace": {    "id": "ws_It13CUaGEhLLAB87simX0",    "name": "string",    "logoUrl": "http://example.com"  },  "inviter": {    "name": "string",    "image": "http://example.com"  },  "role": "workspace.member",  "expiresAt": "2019-08-24T14:15:22Z",  "state": "active",  "emailHint": "string"}

Accept Workspace Invitation

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

token*string

Length1 <= length <= 128

Response Body

`application/json`

curl -X POST "https://example.com/v1/user/invitations/string/accept"

{  "outcome": "joined",  "workspaceId": "ws_It13CUaGEhLLAB87simX0",  "workspaceName": "string",  "role": "workspace.member"}

List Workspace Invitations

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 workspace.

Matchws_[0-9a-zA-Z]{24}$

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Response Body

`application/json`

curl -X GET "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/invitations"

{  "items": [    {      "id": "winv_DsgltMIFV0GmqtxV5NYTtrknrna",      "email": "user@example.com",      "role": "workspace.member",      "status": "pending",      "deliveryStatus": "pending",      "expiresAt": "2019-08-24T14:15:22Z",      "lastSentAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "inviteUrl": "http://example.com"    }  ]}

Create Workspace Invitation

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 workspace.

Matchws_[0-9a-zA-Z]{24}$

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Formatemail

role*WorkspaceRole

Role for workspace-scoped service accounts

Value in

"workspace.viewer"
"workspace.member"
"workspace.admin"

Response Body

`application/json`

curl -X POST "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/invitations" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "role": "workspace.member"  }'

{  "id": "winv_DsgltMIFV0GmqtxV5NYTtrknrna",  "email": "user@example.com",  "role": "workspace.member",  "status": "pending",  "deliveryStatus": "pending",  "expiresAt": "2019-08-24T14:15:22Z",  "lastSentAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "inviteUrl": "http://example.com"}

Resend Workspace Invitation

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 workspace.

Matchws_[0-9a-zA-Z]{24}$

invitationId*string

Length1 <= length <= 128

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Response Body

`application/json`

curl -X POST "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/invitations/string/resend"

{  "id": "winv_DsgltMIFV0GmqtxV5NYTtrknrna",  "email": "user@example.com",  "role": "workspace.member",  "status": "pending",  "deliveryStatus": "pending",  "expiresAt": "2019-08-24T14:15:22Z",  "lastSentAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "inviteUrl": "http://example.com"}

Revoke Workspace Invitation

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 workspace.

Matchws_[0-9a-zA-Z]{24}$

invitationId*string

Length1 <= length <= 128

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/invitations/string"

Empty

Get Workspace Invite 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 workspace.

Matchws_[0-9a-zA-Z]{24}$

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Response Body

`application/json`

curl -X GET "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/invite-link"

{  "id": "wil_RgcthDSZ37rmFLekuItpFS7btjXoYwou1gE4",  "role": "workspace.member",  "expiresAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "useCount": 0,  "lastUsedAt": "2019-08-24T14:15:22Z",  "inviteUrl": "http://example.com"}

Revoke Workspace Invite 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 workspace.

Matchws_[0-9a-zA-Z]{24}$

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/invite-link"

Empty

Create Workspace Invite 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 workspace.

Matchws_[0-9a-zA-Z]{24}$

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

role*WorkspaceRole

Role for workspace-scoped service accounts

Value in

"workspace.viewer"
"workspace.member"
"workspace.admin"

Response Body

`application/json`

curl -X PUT "https://example.com/v1/workspaces/ws_It13CUaGEhLLAB87simX0/invite-link" \  -H "Content-Type: application/json" \  -d '{    "role": "workspace.member"  }'

{  "id": "wil_RgcthDSZ37rmFLekuItpFS7btjXoYwou1gE4",  "role": "workspace.member",  "expiresAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "useCount": 0,  "lastUsedAt": "2019-08-24T14:15:22Z",  "inviteUrl": "http://example.com"}

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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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

Response Body

`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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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

Response Body

`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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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

Response Body

`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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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

Response Body

`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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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

Response Body

`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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

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

Length4 <= length <= 100

include?array<>

Optional fields to include: project

Response Body

`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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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

Response Body

`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"}

Delete 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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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"

Empty

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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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

Response Body

`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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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<>

Customer infrastructure to include. The server snapshots its exact reviewed sources.

Itemsitems <= 8

inputValues?

Default{}

Response Body

`application/json`

curl -X POST "https://example.com/v1/deployment-groups/dg_r27ict8c7vcgsumpj90ackf7b/tokens" \  -H "Content-Type: application/json" \  -d '{    "deploymentSetupConfig": {      "metadata": {        "property1": null,        "property2": null      },      "policy": {        "allowedPlatforms": [          "aws"        ],        "allowedSetupMethods": [          "cloudformation"        ]      },      "environmentVariables": [        {          "name": "string",          "value": "string",          "type": "plain",          "targetResources": [            "string"          ]        }      ]    }  }'

{  "token": "string",  "deploymentLink": "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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

Match^(?!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"}

Get Container Registry Manager Snapshot

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

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/v1/managers/string/container-registry/snapshot"

{  "generatedAt": "2019-08-24T14:15:22Z",  "routes": [    {      "id": "crroute_c9t4xoy7fmiq7equtu20",      "deploymentId": "string",      "resourceId": "string",      "resourceRevision": "string",      "desiredRevision": 0,      "appliedRevision": 0,      "status": "resolving",      "repositories": [        {          "id": "crrepo_625temdq3bnu25jw9rcux",          "logicalName": "string",          "desiredState": "present",          "routableUpstreamName": "string",          "remoteResourceRevision": "string"        }      ],      "credentials": [        {          "id": "crcred_oz1xjr82f37j17g4gtmyu",          "secretPrefix": "string",          "secretDigest": "string",          "scope": "pull",          "repositorySubset": [            "string"          ],          "expiresAt": "2019-08-24T14:15:22Z",          "revokedAt": "2019-08-24T14:15:22Z"        }      ]    }  ]}

Apply Container Registry Manager Snapshot

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

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

routeId*string

Unique identifier for the container registry route.

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

desiredRevision*integer

Range0 <= value

repositories*array<>

verification*|null

Response Body

`application/json`

curl -X POST "https://example.com/v1/managers/string/container-registry/applied" \  -H "Content-Type: application/json" \  -d '{    "routeId": "crroute_c9t4xoy7fmiq7equtu20",    "desiredRevision": 0,    "repositories": [      {        "id": "crrepo_625temdq3bnu25jw9rcux",        "status": "ready",        "routableUpstreamName": "string",        "error": "string"      }    ],    "verification": {      "succeeded": true,      "observedAt": "2019-08-24T14:15:22Z",      "error": "string"    }  }'

{  "appliedRevision": 0,  "status": "applying"}

Prepare the white-labeled Operator image for an Operate install

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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

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

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

project*ProjectIDOrNameQueryParam

Filter by project ID or name.

Lengthlength <= 100

Response Body

`application/json`

curl -X POST "https://example.com/v1/operator-manifests/prepare" \  -H "Content-Type: application/json" \  -d '{    "project": "string"  }'

{  "package": {    "id": "pkg_jebo2o5jmm7raefl2m1pe3cz",    "projectId": "prj_mcytp6z3j91f7tn5ryqsfwtr",    "workspaceId": "ws_It13CUaGEhLLAB87simX0",    "type": "cli",    "status": "pending",    "version": "string",    "sourceReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",    "setupFingerprints": {      "property1": {        "target": "string",        "fingerprint": "string",        "version": 1      },      "property2": {        "target": "string",        "fingerprint": "string",        "version": 1      }    },    "packageBuildInputHash": "string",    "config": {      "binaryTargets": [        "windows-x64"      ],      "displayName": "string",      "name": "string",      "type": "cli"    },    "outputs": {      "binaries": {        "property1": {          "sha256": "string",          "size": 0,          "url": "string"        },        "property2": {          "sha256": "string",          "size": 0,          "url": "string"        }      },      "buildInfo": {        "alienSha": "string",        "horizonSha": "string",        "machineBundleManifestUrl": "string",        "platformSha": "string",        "sourceAgentBinarySha256": "string",        "sourceCliBinarySha256": "string"      },      "type": "cli"    },    "error": null,    "sourceBinarySha256": "string",    "retries": 0,    "lockedAt": "2019-08-24T14:15:22Z",    "lockedBy": "string",    "leaseExpiresAt": "2019-08-24T14:15:22Z",    "buildPhase": "building",    "lastProgressAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z"  }}

Render a Kubernetes Operator manifest

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. Required for user/session/OAuth requests. Optional for API keys because API keys are workspace-scoped; if provided with an API key, it must match the key's workspace.

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

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

project*ProjectIDOrNameQueryParam

Filter by project ID or name.

Lengthlength <= 100

format?string

raw: a kubectl-applyable manifest for one cluster. helm: a paste-into-your-chart template whose namespace and environment name come from Helm at install time.

Default"raw"

Value in

"raw"
"helm"

environmentName?string

Per-environment identity. Required for raw output, ignored for helm.

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

Length4 <= length <= 100

namespace?string

Namespace to observe and install into. Omit for helm to use the release namespace.

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

Length1 <= length <= 63

scope?string

namespace: a namespaced Role that manages the install namespace. cluster: a ClusterRole that manages every namespace.

Default"namespace"

Value in

"namespace"
"cluster"

labelSelector?string

Optional Kubernetes label selector narrowing what is managed, applied within the scope.

Length1 <= length <= 256

permission?string

Operator permission tier

Default"diagnostics"

Value in

"diagnostics"
"remediation"

operatorImagePackageId?string

Ready operator-image package to use for the Operator image. If omitted, the latest ready operator-image package for the project is used.

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

deploymentGroupToken*string

Deployment-group token embedded in the operator Secret

Length1 <= length

logCollector?

Enable the node log collector DaemonSet for raw pod logs.

stackSettings?

User-customizable deployment settings specified at deploy time.

These settings are provided by the customer via CloudFormation parameters, Terraform attributes, CLI flags, or Helm values. They customize how the deployment runs and what capabilities are enabled.

Key distinction: StackSettings is user-customizable, while ManagementConfig is platform-derived (from the Manager's ServiceAccount).

Response Body

`application/json`

curl -X POST "https://example.com/v1/operator-manifests/render" \  -H "Content-Type: application/json" \  -d '{    "project": "string",    "deploymentGroupToken": "string"  }'

{  "manifest": "string",  "applyCommand": "string",  "filename": "string",  "managerUrl": "http://example.com",  "imagePending": true}

List Pending Access Requests

Operator-facing: the queued access requests for a deployment, for the access-request sync loop to materialize as grant CRs.

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

deploymentId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/access-requests/pending?deploymentId=string"

{  "requests": [    {      "id": "string",      "title": "string",      "reason": "string",      "commands": [        {          "command": "kubernetes/get-pods",          "summary": "List pods in the ingestion namespace",          "params": {            "pod": "ingester-p4kwm"          }        }      ]    }  ]}

Report Materialized Access Requests

Operator-facing: record the namespace + CRD plural the operator materialized the grant CRs in, so the control plane can render the customer's exact kubectl approve command.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

deploymentId*string

requestIds*array<string>

namespace*string

Length1 <= length

resourcePlural*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://example.com/v1/access-requests/materialized" \  -H "Content-Type: application/json" \  -d '{    "deploymentId": "string",    "requestIds": [      "string"    ],    "namespace": "string",    "resourcePlural": "string"  }'

{  "recorded": 0}

Report Access Approvals

Operator-facing: record the customer's approval windows reported back by the sync loop. Moves each request to customer-approved and resumes the investigation to dispatch commands.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

deploymentId*string

approvals*array<>

Response Body

`application/json`

curl -X POST "https://example.com/v1/access-requests/approvals" \  -H "Content-Type: application/json" \  -d '{    "deploymentId": "string",    "approvals": [      {        "requestId": "string",        "approvedUntil": "string"      }    ]  }'

{  "recorded": 0}

List AWS Virtual Keys

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

project*string

Filter by project ID or name.

Lengthlength <= 100

Response Body

`application/json`

curl -X GET "https://example.com/v1/aws-virtual-keys?project=my-project"

{  "virtualKeys": [    {      "id": "vkey_0p9nwqgtftugsoey99lqyqq",      "projectId": "string",      "status": "provisioning",      "externalKeyId": "string",      "awsAccountId": "string",      "awsRegion": "string",      "customKeyStoreId": "string",      "kmsKeyArn": "string",      "alias": "string",      "description": "string",      "deletionWindowDays": 0,      "tags": {        "property1": "string",        "property2": "string"      },      "observedAt": "2019-08-24T14:15:22Z",      "canaryPassedAt": "2019-08-24T14:15:22Z",      "deletionScheduledAt": "2019-08-24T14:15:22Z",      "finalDeletionObservedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Create AWS Virtual 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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

project?ProjectIDOrNameQueryParam

Filter by project ID or name.

Lengthlength <= 100

selector*|

awsAccountId*string

Match^\d{12}$

awsRegion*string

Match^[a-z]{2}(?:-gov)?-[a-z]+-\d$

idempotencyKey*string

Length1 <= length <= 128

alias?|

Length1 <= length <= 256

description?|

Lengthlength <= 8192

deletionWindowDays?integer

Range7 <= value <= 30

Default30

tags?

Default{}

Response Body

`application/json`

curl -X POST "https://example.com/v1/aws-virtual-keys" \  -H "Content-Type: application/json" \  -d '{    "selector": {      "externalId": "ext_example_01"    },    "awsAccountId": "string",    "awsRegion": "string",    "idempotencyKey": "string"  }'

{  "virtualKey": {    "id": "vkey_0p9nwqgtftugsoey99lqyqq",    "projectId": "string",    "status": "provisioning",    "externalKeyId": "string",    "awsAccountId": "string",    "awsRegion": "string",    "customKeyStoreId": "string",    "kmsKeyArn": "string",    "alias": "string",    "description": "string",    "deletionWindowDays": 0,    "tags": {      "property1": "string",      "property2": "string"    },    "observedAt": "2019-08-24T14:15:22Z",    "canaryPassedAt": "2019-08-24T14:15:22Z",    "deletionScheduledAt": "2019-08-24T14:15:22Z",    "finalDeletionObservedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "setup": {    "proxyUriEndpoint": "http://example.com",    "proxyUriPath": "string",    "accessKeyId": "string",    "secretAccessKey": "string",    "externalKeyId": "string"  }}

Rotate AWS Virtual Key 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 aws virtual key.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

generation*integer

Range2 <= value

Response Body

`application/json`

curl -X POST "https://example.com/v1/aws-virtual-keys/vkey_0p9nwqgtftugsoey99lqyqq/rotate-credential" \  -H "Content-Type: application/json" \  -d '{    "generation": 2  }'

{  "virtualKey": {    "id": "vkey_0p9nwqgtftugsoey99lqyqq",    "projectId": "string",    "status": "provisioning",    "externalKeyId": "string",    "awsAccountId": "string",    "awsRegion": "string",    "customKeyStoreId": "string",    "kmsKeyArn": "string",    "alias": "string",    "description": "string",    "deletionWindowDays": 0,    "tags": {      "property1": "string",      "property2": "string"    },    "observedAt": "2019-08-24T14:15:22Z",    "canaryPassedAt": "2019-08-24T14:15:22Z",    "deletionScheduledAt": "2019-08-24T14:15:22Z",    "finalDeletionObservedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "setup": {    "proxyUriEndpoint": "http://example.com",    "proxyUriPath": "string",    "accessKeyId": "string",    "secretAccessKey": "string",    "externalKeyId": "string"  }}

Restore AWS Virtual 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 aws virtual key.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

kmsKeyArn*string

Match^arn:(?:aws|aws-us-gov):kms:[a-z0-9-]+:\d{12}:key\/[A-Za-z0-9-]+$

Response Body

`application/json`

curl -X POST "https://example.com/v1/aws-virtual-keys/vkey_0p9nwqgtftugsoey99lqyqq/restore" \  -H "Content-Type: application/json" \  -d '{    "kmsKeyArn": "string"  }'

{  "id": "vkey_0p9nwqgtftugsoey99lqyqq",  "projectId": "string",  "status": "provisioning",  "externalKeyId": "string",  "awsAccountId": "string",  "awsRegion": "string",  "customKeyStoreId": "string",  "kmsKeyArn": "string",  "alias": "string",  "description": "string",  "deletionWindowDays": 0,  "tags": {    "property1": "string",    "property2": "string"  },  "observedAt": "2019-08-24T14:15:22Z",  "canaryPassedAt": "2019-08-24T14:15:22Z",  "deletionScheduledAt": "2019-08-24T14:15:22Z",  "finalDeletionObservedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Finalize AWS Virtual Key Deletion

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 aws virtual key.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

kmsKeyArn*string

Match^arn:(?:aws|aws-us-gov):kms:[a-z0-9-]+:\d{12}:key\/[A-Za-z0-9-]+$

Response Body

`application/json`

curl -X POST "https://example.com/v1/aws-virtual-keys/vkey_0p9nwqgtftugsoey99lqyqq/finalize-deletion" \  -H "Content-Type: application/json" \  -d '{    "kmsKeyArn": "string"  }'

{  "id": "vkey_0p9nwqgtftugsoey99lqyqq",  "projectId": "string",  "status": "provisioning",  "externalKeyId": "string",  "awsAccountId": "string",  "awsRegion": "string",  "customKeyStoreId": "string",  "kmsKeyArn": "string",  "alias": "string",  "description": "string",  "deletionWindowDays": 0,  "tags": {    "property1": "string",    "property2": "string"  },  "observedAt": "2019-08-24T14:15:22Z",  "canaryPassedAt": "2019-08-24T14:15:22Z",  "deletionScheduledAt": "2019-08-24T14:15:22Z",  "finalDeletionObservedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Decommission AWS Virtual 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 aws virtual key.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

kmsKeyArn*string

Match^arn:(?:aws|aws-us-gov):kms:[a-z0-9-]+:\d{12}:key\/[A-Za-z0-9-]+$

deletionScheduledAt*string

Formatdate-time

Response Body

`application/json`

curl -X POST "https://example.com/v1/aws-virtual-keys/vkey_0p9nwqgtftugsoey99lqyqq/decommission" \  -H "Content-Type: application/json" \  -d '{    "kmsKeyArn": "string",    "deletionScheduledAt": "2019-08-24T14:15:22Z"  }'

{  "id": "vkey_0p9nwqgtftugsoey99lqyqq",  "projectId": "string",  "status": "provisioning",  "externalKeyId": "string",  "awsAccountId": "string",  "awsRegion": "string",  "customKeyStoreId": "string",  "kmsKeyArn": "string",  "alias": "string",  "description": "string",  "deletionWindowDays": 0,  "tags": {    "property1": "string",    "property2": "string"  },  "observedAt": "2019-08-24T14:15:22Z",  "canaryPassedAt": "2019-08-24T14:15:22Z",  "deletionScheduledAt": "2019-08-24T14:15:22Z",  "finalDeletionObservedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get AWS Virtual 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 aws virtual key.

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

Response Body

`application/json`

curl -X GET "https://example.com/v1/aws-virtual-keys/vkey_0p9nwqgtftugsoey99lqyqq"

{  "id": "vkey_0p9nwqgtftugsoey99lqyqq",  "projectId": "string",  "status": "provisioning",  "externalKeyId": "string",  "awsAccountId": "string",  "awsRegion": "string",  "customKeyStoreId": "string",  "kmsKeyArn": "string",  "alias": "string",  "description": "string",  "deletionWindowDays": 0,  "tags": {    "property1": "string",    "property2": "string"  },  "observedAt": "2019-08-24T14:15:22Z",  "canaryPassedAt": "2019-08-24T14:15:22Z",  "deletionScheduledAt": "2019-08-24T14:15:22Z",  "finalDeletionObservedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Continue AWS Virtual 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 aws virtual key.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customKeyStoreId*string

Match^cks-[A-Za-z0-9]+$

kmsKeyArn*string

Match^arn:(?:aws|aws-us-gov):kms:[a-z0-9-]+:\d{12}:key\/[A-Za-z0-9-]+$

Response Body

`application/json`

curl -X POST "https://example.com/v1/aws-virtual-keys/vkey_0p9nwqgtftugsoey99lqyqq/continue" \  -H "Content-Type: application/json" \  -d '{    "customKeyStoreId": "string",    "kmsKeyArn": "string"  }'

{  "id": "vkey_0p9nwqgtftugsoey99lqyqq",  "projectId": "string",  "status": "provisioning",  "externalKeyId": "string",  "awsAccountId": "string",  "awsRegion": "string",  "customKeyStoreId": "string",  "kmsKeyArn": "string",  "alias": "string",  "description": "string",  "deletionWindowDays": 0,  "tags": {    "property1": "string",    "property2": "string"  },  "observedAt": "2019-08-24T14:15:22Z",  "canaryPassedAt": "2019-08-24T14:15:22Z",  "deletionScheduledAt": "2019-08-24T14:15:22Z",  "finalDeletionObservedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

200application/json

200application/json

404application/json

500application/json

200application/json

404application/json

409application/json

500application/json

200application/json

404application/json

500application/json

201application/json

403application/json

404application/json

409application/json

500application/json

200application/json

404application/json

500application/json

204

404application/json

500application/json

200application/json

404application/json

500application/json

204

404application/json

500application/json

200application/json

404application/json

500application/json

200application/json

500application/json

200application/json

404application/json

409application/json

500application/json

200application/json

404application/json

500application/json

200application/json

404application/json

500application/json

200application/json

404application/json

409application/json

500application/json

200application/json

404application/json

500application/json

200application/json

404application/json

409application/json

500application/json

204

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`