Deployments

List Deployments

Retrieve all deployments.

Authorization

apiKey

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

deploymentGroup?string

Filter by deployment group ID or name

name?string

Filter by exact deployment name. Must be used with deploymentGroup.

Lengthlength <= 100

managerId?string

Filter by manager ID

purpose?string

Filter by deployment purpose

Value in

"application"
"encryption"
"ai"
"storage"
"container-registry"

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

search?string

Search deployments by name, public subdomain, or deployment group name

Lengthlength <= 256

status?array<>

Filter deployments by status

environment?array<>

Filter deployments by effective environment

include?array<>

Optional fields to include: release, deploymentGroup, 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/deployments?project=my-project"

{  "items": [    {      "id": "dep_0c29fq4a2yjb7kx3smwdgxlc",      "name": "string",      "status": "pending",      "projectId": "prj_mcytp6z3j91f7tn5ryqsfwtr",      "platform": "aws",      "deploymentProtocolVersion": 1,      "deploymentGroupId": "dg_r27ict8c7vcgsumpj90ackf7b",      "purpose": "application",      "environmentInfo": {        "accountId": "string",        "region": "string",        "platform": "aws"      },      "currentReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "desiredReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "pinnedReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "releaseChannel": "string",      "importSource": "cloudformation",      "setupMethod": "cloudformation",      "setupMetadata": {        "property1": null,        "property2": null      },      "setupTarget": "string",      "setupFingerprint": "string",      "setupFingerprintVersion": 1,      "operatorScope": "string",      "operatorPermission": "string",      "operatorVersion": "string",      "capabilities": [        {          "key": "string",          "state": "granted",          "detail": "string"        }      ],      "lastHeartbeatAt": "2019-08-24T14:15:22Z",      "error": {        "code": "string",        "context": null,        "hint": "string",        "httpStatusCode": 100,        "internal": true,        "message": "string",        "retryable": false,        "source": null      },      "retryRequested": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "managerId": "mgr_enxscjrqiiu2lrc672hwwuc5",      "workspaceId": "ws_It13CUaGEhLLAB87simX0",      "release": {        "id": "rel_WbhQgksrawSKIpEN0NAssHX9",        "version": "string",        "gitMetadata": {          "commitSha": "dc36199b2234c6586ebe05ec94078a895c707e29",          "commitMessage": "add method to measure Interaction to Next Paint (INP) (#36490)",          "commitRef": "main",          "commitDate": "2026-03-16T12:00:00Z",          "dirty": true,          "remoteUrl": "https://github.com/alienplatform/alien",          "commitAuthorName": "John Doe",          "commitAuthorEmail": "john@example.com",          "commitAuthorLogin": "johndoe",          "commitAuthorAvatarUrl": "https://github.com/johndoe.png",          "provider": {            "type": "github",            "org": "string",            "repo": "string"          }        },        "createdAt": "2019-08-24T14:15:22Z"      },      "deploymentGroup": {        "id": "dg_r27ict8c7vcgsumpj90ackf7b",        "name": "prod-us-east-1",        "externalId": "ext_example_01"      },      "project": {        "id": "prj_mcytp6z3j91f7tn5ryqsfwtr",        "name": "my-app"      }    }  ],  "nextCursor": "string"}

Create Deployment

Create a new deployment. Deployment group tokens automatically use their group. Workspace/project tokens must provide deploymentGroupId.

Authorization

apiKey

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.

Request schema for creating a new deployment

name*string

Deployment name.

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

Length2 <= length <= 100

platform*string

Target platform for the deployment

Value in

"aws"
"gcp"
"azure"
"kubernetes"
"machines"
"local"
"test"

deploymentGroupId?string

Required for workspace/project tokens. Deployment group tokens use their own group automatically.

managerId?string

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

pinnedReleaseId?|

ID of the pinned release

Matchrel_[0-9a-zA-Z]{28}$

environmentVariables?array<>|

Configuration of environment variables for the deployment

environmentInfo?|||||

Cloud environment information

project*string

Project ID or name

Lengthlength <= 100

stackSettings?

Stack settings for deployment customization

resourcePrefix?ResourcePrefix

Optional physical-name prefix for generated cloud resources. Omit to let the manager generate one.

Match^[a-z](?:[a-z0-9]|-(?=[a-z0-9])){1,38}[a-z0-9]$

publicSubdomain?string

Optional deployment subdomain under the project's generated-domain parent. Operator-only and requires a custom project domain; customer deploy-link tokens and the shared system domain are rejected. Omit to generate a random subdomain.

Match^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$

Length1 <= length <= 63

setupMethod?string

Value in

"cloudformation"
"google-oauth"
"terraform"
"helm"
"cli"
"manual"

setupMetadata?

inputValues?

Stack input values provided by the deployment creator.

Default{}

operatorScope?string

Display-only scope reported by the Operator manifest.

Length1 <= length <= 512

operatorPermission?string

Display-only permission tier reported by the Operator manifest.

Length1 <= length <= 64

initialDesiredRelease?string

Desired-release selection for a new deployment. Use none to register an environment without initially requesting a release; later updates can assign one.

Default"active"

Value in

"active"
"none"

releaseChannel?string

Release channel followed while this deployment is not pinned.

Match^[a-z][a-z0-9-]*$

Length1 <= length <= 63

Default"production"

setupItem?string

Customer setup item selected from this deployment-group token.

Value in

"deployment"
"models"
"keys"
"bucket"
"registry"

Response Body

`application/json`

curl -X POST "https://example.com/v1/deployments" \  -H "Content-Type: application/json" \  -d '{    "name": "acme-prod",    "platform": "aws",    "project": "string"  }'

{  "deployment": {    "id": "dep_0c29fq4a2yjb7kx3smwdgxlc",    "name": "acme-prod",    "publicSubdomain": "string",    "status": "pending",    "projectId": "prj_mcytp6z3j91f7tn5ryqsfwtr",    "platform": "aws",    "basePlatform": "aws",    "region": "string",    "deploymentProtocolVersion": 1,    "deploymentGroupId": "dg_r27ict8c7vcgsumpj90ackf7b",    "purpose": "application",    "environmentInfo": {      "accountId": "string",      "region": "string",      "platform": "aws"    },    "stackSettings": {      "compute": {        "pools": {          "property1": {            "failure_domains": {              "selectedFailureDomains": [                "string"              ],              "spread": 0            },            "machine": "string",            "machines": 0,            "mode": "fixed"          },          "property2": {            "failure_domains": {              "selectedFailureDomains": [                "string"              ],              "spread": 0            },            "machine": "string",            "machines": 0,            "mode": "fixed"          }        }      },      "deploymentModel": "push",      "domains": {        "customDomains": {          "property1": {            "certificate": {              "aws": {                "certificateArn": "string"              },              "azure": {                "keyVaultCertificateId": "string",                "keyVaultResourceId": "string"              },              "gcp": {                "certificateName": "string"              },              "kubernetes": {                "tlsSecretRef": {                  "namespace": "string",                  "secretName": "string"                }              }            },            "domain": "string"          },          "property2": {            "certificate": {              "aws": {                "certificateArn": "string"              },              "azure": {                "keyVaultCertificateId": "string",                "keyVaultResourceId": "string"              },              "gcp": {                "certificateName": "string"              },              "kubernetes": {                "tlsSecretRef": {                  "namespace": "string",                  "secretName": "string"                }              }            },            "domain": "string"          }        },        "publicEndpointTarget": {          "mode": "machineAddresses"        }      },      "externalBindings": {},      "heartbeats": "off",      "kubernetes": {        "cluster": {          "cloud": {            "accountId": "string",            "clusterId": "string",            "clusterName": "string",            "projectId": "string",            "region": "string",            "resourceGroup": "string",            "subscriptionId": "string"          },          "namespace": "string",          "ownership": "managed"        },        "exposure": {          "mode": "disabled"        }      },      "network": {        "type": "use-default"      },      "telemetry": "off",      "updates": "auto"    },    "stackState": {      "platform": "aws",      "resourcePrefix": "string",      "resources": {        "property1": {          "_internal": null,          "config": {            "id": "string",            "type": "string",            "property1": null,            "property2": null          },          "controllerPlatform": "aws",          "dependencies": [            {              "id": "string",              "type": "string"            }          ],          "error": {            "code": "string",            "context": null,            "hint": "string",            "httpStatusCode": 100,            "internal": true,            "message": "string",            "retryable": false,            "source": null          },          "lastFailedState": null,          "lifecycle": "frozen",          "outputs": {            "type": "string",            "property1": null,            "property2": null          },          "previousConfig": {            "id": "string",            "type": "string",            "property1": null,            "property2": null          },          "remoteBindingParams": null,          "retryAttempt": 0,          "status": "pending",          "type": "string"        },        "property2": {          "_internal": null,          "config": {            "id": "string",            "type": "string",            "property1": null,            "property2": null          },          "controllerPlatform": "aws",          "dependencies": [            {              "id": "string",              "type": "string"            }          ],          "error": {            "code": "string",            "context": null,            "hint": "string",            "httpStatusCode": 100,            "internal": true,            "message": "string",            "retryable": false,            "source": null          },          "lastFailedState": null,          "lifecycle": "frozen",          "outputs": {            "type": "string",            "property1": null,            "property2": null          },          "previousConfig": {            "id": "string",            "type": "string",            "property1": null,            "property2": null          },          "remoteBindingParams": null,          "retryAttempt": 0,          "status": "pending",          "type": "string"        }      }    },    "runtimeMetadata": {      "initialSetupAuthority": "importedHandoff",      "lastSyncedEnvVarsHash": "string",      "lastSyncedSecretNames": [        "string"      ],      "pendingPreparedStack": {        "id": "string",        "inputs": [          {            "default": {              "type": "string",              "value": "string"            },            "description": "string",            "env": [              {                "name": "string",                "targetResources": [                  "string"                ],                "type": "plain"              }            ],            "id": "string",            "kind": "string",            "label": "string",            "placeholder": "string",            "platforms": [              "aws"            ],            "providedBy": [              "developer"            ],            "required": true,            "validation": {              "format": "string",              "max": "string",              "maxItems": 0,              "maxLength": 0,              "min": "string",              "minItems": 0,              "minLength": 0,              "pattern": "string",              "values": [                "string"              ]            }          }        ],        "permissions": {          "management": {            "extend": {              "property1": [                {                  "description": "string",                  "id": "string",                  "platforms": {                    "aws": [                      {                        "binding": {                          "resource": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          }                        },                        "description": "string",                        "effect": "Allow",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "azure": [                      {                        "binding": {                          "resource": {                            "scope": "string"                          },                          "stack": {                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "gcp": [                      {                        "binding": {                          "resource": {                            "condition": {},                            "scope": "string"                          },                          "stack": {                            "condition": {},                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ]                  }                }              ],              "property2": [                {                  "description": "string",                  "id": "string",                  "platforms": {                    "aws": [                      {                        "binding": {                          "resource": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          }                        },                        "description": "string",                        "effect": "Allow",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "azure": [                      {                        "binding": {                          "resource": {                            "scope": "string"                          },                          "stack": {                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "gcp": [                      {                        "binding": {                          "resource": {                            "condition": {},                            "scope": "string"                          },                          "stack": {                            "condition": {},                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ]                  }                }              ]            }          },          "profiles": {            "property1": {              "property1": [                {                  "description": "string",                  "id": "string",                  "platforms": {                    "aws": [                      {                        "binding": {                          "resource": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          }                        },                        "description": "string",                        "effect": "Allow",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "azure": [                      {                        "binding": {                          "resource": {                            "scope": "string"                          },                          "stack": {                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "gcp": [                      {                        "binding": {                          "resource": {                            "condition": {},                            "scope": "string"                          },                          "stack": {                            "condition": {},                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ]                  }                }              ],              "property2": [                {                  "description": "string",                  "id": "string",                  "platforms": {                    "aws": [                      {                        "binding": {                          "resource": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          }                        },                        "description": "string",                        "effect": "Allow",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "azure": [                      {                        "binding": {                          "resource": {                            "scope": "string"                          },                          "stack": {                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "gcp": [                      {                        "binding": {                          "resource": {                            "condition": {},                            "scope": "string"                          },                          "stack": {                            "condition": {},                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ]                  }                }              ]            },            "property2": {              "property1": [                {                  "description": "string",                  "id": "string",                  "platforms": {                    "aws": [                      {                        "binding": {                          "resource": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          }                        },                        "description": "string",                        "effect": "Allow",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "azure": [                      {                        "binding": {                          "resource": {                            "scope": "string"                          },                          "stack": {                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "gcp": [                      {                        "binding": {                          "resource": {                            "condition": {},                            "scope": "string"                          },                          "stack": {                            "condition": {},                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ]                  }                }              ],              "property2": [                {                  "description": "string",                  "id": "string",                  "platforms": {                    "aws": [                      {                        "binding": {                          "resource": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          }                        },                        "description": "string",                        "effect": "Allow",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "azure": [                      {                        "binding": {                          "resource": {                            "scope": "string"                          },                          "stack": {                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "gcp": [                      {                        "binding": {                          "resource": {                            "condition": {},                            "scope": "string"                          },                          "stack": {                            "condition": {},                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ]                  }                }              ]            }          }        },        "resources": {          "property1": {            "config": {              "id": "string",              "type": "string",              "property1": null,              "property2": null            },            "dependencies": [              {                "id": "string",                "type": "string"              }            ],            "enabledWhen": "string",            "lifecycle": "frozen",            "remoteAccess": true          },          "property2": {            "config": {              "id": "string",              "type": "string",              "property1": null,              "property2": null            },            "dependencies": [              {                "id": "string",                "type": "string"              }            ],            "enabledWhen": "string",            "lifecycle": "frozen",            "remoteAccess": true          }        },        "supportedPlatforms": [          "aws"        ]      },      "persistedGateAnswers": {        "property1": true,        "property2": true      },      "preparedStack": {        "id": "string",        "inputs": [          {            "default": {              "type": "string",              "value": "string"            },            "description": "string",            "env": [              {                "name": "string",                "targetResources": [                  "string"                ],                "type": "plain"              }            ],            "id": "string",            "kind": "string",            "label": "string",            "placeholder": "string",            "platforms": [              "aws"            ],            "providedBy": [              "developer"            ],            "required": true,            "validation": {              "format": "string",              "max": "string",              "maxItems": 0,              "maxLength": 0,              "min": "string",              "minItems": 0,              "minLength": 0,              "pattern": "string",              "values": [                "string"              ]            }          }        ],        "permissions": {          "management": {            "extend": {              "property1": [                {                  "description": "string",                  "id": "string",                  "platforms": {                    "aws": [                      {                        "binding": {                          "resource": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          }                        },                        "description": "string",                        "effect": "Allow",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "azure": [                      {                        "binding": {                          "resource": {                            "scope": "string"                          },                          "stack": {                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "gcp": [                      {                        "binding": {                          "resource": {                            "condition": {},                            "scope": "string"                          },                          "stack": {                            "condition": {},                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ]                  }                }              ],              "property2": [                {                  "description": "string",                  "id": "string",                  "platforms": {                    "aws": [                      {                        "binding": {                          "resource": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          }                        },                        "description": "string",                        "effect": "Allow",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "azure": [                      {                        "binding": {                          "resource": {                            "scope": "string"                          },                          "stack": {                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "gcp": [                      {                        "binding": {                          "resource": {                            "condition": {},                            "scope": "string"                          },                          "stack": {                            "condition": {},                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ]                  }                }              ]            }          },          "profiles": {            "property1": {              "property1": [                {                  "description": "string",                  "id": "string",                  "platforms": {                    "aws": [                      {                        "binding": {                          "resource": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          }                        },                        "description": "string",                        "effect": "Allow",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "azure": [                      {                        "binding": {                          "resource": {                            "scope": "string"                          },                          "stack": {                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "gcp": [                      {                        "binding": {                          "resource": {                            "condition": {},                            "scope": "string"                          },                          "stack": {                            "condition": {},                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ]                  }                }              ],              "property2": [                {                  "description": "string",                  "id": "string",                  "platforms": {                    "aws": [                      {                        "binding": {                          "resource": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          }                        },                        "description": "string",                        "effect": "Allow",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "azure": [                      {                        "binding": {                          "resource": {                            "scope": "string"                          },                          "stack": {                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "gcp": [                      {                        "binding": {                          "resource": {                            "condition": {},                            "scope": "string"                          },                          "stack": {                            "condition": {},                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ]                  }                }              ]            },            "property2": {              "property1": [                {                  "description": "string",                  "id": "string",                  "platforms": {                    "aws": [                      {                        "binding": {                          "resource": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          }                        },                        "description": "string",                        "effect": "Allow",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "azure": [                      {                        "binding": {                          "resource": {                            "scope": "string"                          },                          "stack": {                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "gcp": [                      {                        "binding": {                          "resource": {                            "condition": {},                            "scope": "string"                          },                          "stack": {                            "condition": {},                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ]                  }                }              ],              "property2": [                {                  "description": "string",                  "id": "string",                  "platforms": {                    "aws": [                      {                        "binding": {                          "resource": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "resources": [                              null                            ]                          }                        },                        "description": "string",                        "effect": "Allow",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "azure": [                      {                        "binding": {                          "resource": {                            "scope": "string"                          },                          "stack": {                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ],                    "gcp": [                      {                        "binding": {                          "resource": {                            "condition": {},                            "scope": "string"                          },                          "stack": {                            "condition": {},                            "scope": "string"                          }                        },                        "description": "string",                        "grant": {                          "actions": [                            "string"                          ],                          "dataActions": [                            "string"                          ],                          "permissions": [                            "string"                          ],                          "predefinedRoles": [                            "string"                          ],                          "residualPermissions": [                            "string"                          ]                        },                        "label": "string"                      }                    ]                  }                }              ]            }          }        },        "resources": {          "property1": {            "config": {              "id": "string",              "type": "string",              "property1": null,              "property2": null            },            "dependencies": [              {                "id": "string",                "type": "string"              }            ],            "enabledWhen": "string",            "lifecycle": "frozen",            "remoteAccess": true          },          "property2": {            "config": {              "id": "string",              "type": "string",              "property1": null,              "property2": null            },            "dependencies": [              {                "id": "string",                "type": "string"              }            ],            "enabledWhen": "string",            "lifecycle": "frozen",            "remoteAccess": true          }        },        "supportedPlatforms": [          "aws"        ]      },      "registryAccessGranted": true,      "setupUpdateAuthorization": {        "baselineFrozenDigest": "string",        "nonce": "string",        "releaseId": "string",        "setupFingerprint": "string",        "setupFingerprintVersion": 0,        "setupTarget": "string",        "targetFrozenDigest": "string"      }    },    "currentReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",    "desiredReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",    "pinnedReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",    "releaseChannel": "string",    "importSource": "cloudformation",    "setupMethod": "cloudformation",    "setupMetadata": {      "property1": null,      "property2": null    },    "setupTarget": "string",    "setupFingerprint": "string",    "setupFingerprintVersion": 1,    "operatorScope": "string",    "operatorPermission": "string",    "operatorVersion": "string",    "capabilities": [      {        "key": "string",        "state": "granted",        "detail": "string"      }    ],    "retryRequested": true,    "lastHeartbeatAt": "2019-08-24T14:15:22Z",    "error": {      "code": "string",      "context": null,      "hint": "string",      "httpStatusCode": 100,      "internal": true,      "message": "string",      "retryable": false,      "source": null    },    "environmentVariables": [      {        "name": "string",        "value": "string",        "type": "plain",        "targetResources": [          "string"        ]      }    ],    "targetEnvironmentVariables": {      "variables": [        {          "name": "string",          "value": "string",          "type": "plain",          "targetResources": [            "string"          ]        }      ],      "hash": "string",      "createdAt": "2019-08-24T14:15:22Z"    },    "currentEnvironmentVariables": {      "variables": [        {          "name": "string",          "value": "string",          "type": "plain",          "targetResources": [            "string"          ]        }      ],      "hash": "string",      "createdAt": "2019-08-24T14:15:22Z"    },    "updateState": {      "active": {        "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",        "status": "queued",        "reasons": [          "configuration"        ],        "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",        "changedKeys": [          "string"        ],        "requestedAt": "2019-08-24T14:15:22Z",        "startedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z"      },      "next": {        "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",        "status": "queued",        "reasons": [          "configuration"        ],        "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",        "changedKeys": [          "string"        ],        "requestedAt": "2019-08-24T14:15:22Z",        "startedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z"      },      "latest": {        "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",        "status": "queued",        "reasons": [          "configuration"        ],        "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",        "changedKeys": [          "string"        ],        "requestedAt": "2019-08-24T14:15:22Z",        "startedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z"      }    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "managerId": "mgr_enxscjrqiiu2lrc672hwwuc5",    "workspaceId": "ws_It13CUaGEhLLAB87simX0"  },  "deploymentModel": "push",  "token": "string"}

Get Deployment Stats

Get aggregated deployment statistics. Returns total count and breakdown by status.

Authorization

apiKey

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

deploymentGroup?string

Filter by deployment group ID or name

managerId?string

Filter by manager ID

purpose?string

Filter by deployment purpose

Value in

"application"
"encryption"
"ai"
"storage"
"container-registry"

environment?array<>

Filter deployments by effective environment

status?array<>

Filter deployments by status

search?string

Search deployments by name or deployment group name

Lengthlength <= 256

Response Body

`application/json`

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

{  "total": 0,  "byStatus": {    "property1": 0,    "property2": 0  },  "byPlatform": {    "property1": 0,    "property2": 0  },  "byCurrentRelease": {    "property1": 0,    "property2": 0  },  "byPinnedRelease": {    "property1": 0,    "property2": 0  },  "byOrigin": {    "framework": 0,    "remoteOperator": 0  }}

List Deployment Filter Environments

List distinct effective environments used by deployments. Used for filter dropdowns.

Authorization

apiKey

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

Response Body

`application/json`

curl -X GET "https://example.com/v1/deployments/filter-environments?project=my-project"

{  "items": [    "aws"  ]}

List Deployment Filter Deployment Groups

List deployment groups with deployment counts. Used for filter dropdowns.

Authorization

apiKey

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?|

Search deployment groups by name

Lengthlength <= 256

limit?integer

Maximum number of items to return

Range1 <= value <= 100

Default20

Response Body

`application/json`

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

{  "items": [    {      "id": "dg_r27ict8c7vcgsumpj90ackf7b",      "name": "string",      "deploymentCount": 0,      "runningCount": 0,      "failedCount": 0,      "inProgressCount": 0    }  ]}

Get Deployment

Retrieve a deployment by ID.

Authorization

apiKey

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.

Matchdep_[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: release, deploymentGroup, project

Response Body

`application/json`

curl -X GET "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc"

{  "id": "dep_0c29fq4a2yjb7kx3smwdgxlc",  "name": "acme-prod",  "publicSubdomain": "string",  "status": "pending",  "projectId": "prj_mcytp6z3j91f7tn5ryqsfwtr",  "platform": "aws",  "basePlatform": "aws",  "region": "string",  "deploymentProtocolVersion": 1,  "deploymentGroupId": "dg_r27ict8c7vcgsumpj90ackf7b",  "purpose": "application",  "environmentInfo": {    "accountId": "string",    "region": "string",    "platform": "aws"  },  "stackSettings": {    "compute": {      "pools": {        "property1": {          "failure_domains": {            "selectedFailureDomains": [              "string"            ],            "spread": 0          },          "machine": "string",          "machines": 0,          "mode": "fixed"        },        "property2": {          "failure_domains": {            "selectedFailureDomains": [              "string"            ],            "spread": 0          },          "machine": "string",          "machines": 0,          "mode": "fixed"        }      }    },    "deploymentModel": "push",    "domains": {      "customDomains": {        "property1": {          "certificate": {            "aws": {              "certificateArn": "string"            },            "azure": {              "keyVaultCertificateId": "string",              "keyVaultResourceId": "string"            },            "gcp": {              "certificateName": "string"            },            "kubernetes": {              "tlsSecretRef": {                "namespace": "string",                "secretName": "string"              }            }          },          "domain": "string"        },        "property2": {          "certificate": {            "aws": {              "certificateArn": "string"            },            "azure": {              "keyVaultCertificateId": "string",              "keyVaultResourceId": "string"            },            "gcp": {              "certificateName": "string"            },            "kubernetes": {              "tlsSecretRef": {                "namespace": "string",                "secretName": "string"              }            }          },          "domain": "string"        }      },      "publicEndpointTarget": {        "mode": "machineAddresses"      }    },    "externalBindings": {},    "heartbeats": "off",    "kubernetes": {      "cluster": {        "cloud": {          "accountId": "string",          "clusterId": "string",          "clusterName": "string",          "projectId": "string",          "region": "string",          "resourceGroup": "string",          "subscriptionId": "string"        },        "namespace": "string",        "ownership": "managed"      },      "exposure": {        "mode": "disabled"      }    },    "network": {      "type": "use-default"    },    "telemetry": "off",    "updates": "auto"  },  "stackState": {    "platform": "aws",    "resourcePrefix": "string",    "resources": {      "property1": {        "_internal": null,        "config": {          "id": "string",          "type": "string",          "property1": null,          "property2": null        },        "controllerPlatform": "aws",        "dependencies": [          {            "id": "string",            "type": "string"          }        ],        "error": {          "code": "string",          "context": null,          "hint": "string",          "httpStatusCode": 100,          "internal": true,          "message": "string",          "retryable": false,          "source": null        },        "lastFailedState": null,        "lifecycle": "frozen",        "outputs": {          "type": "string",          "property1": null,          "property2": null        },        "previousConfig": {          "id": "string",          "type": "string",          "property1": null,          "property2": null        },        "remoteBindingParams": null,        "retryAttempt": 0,        "status": "pending",        "type": "string"      },      "property2": {        "_internal": null,        "config": {          "id": "string",          "type": "string",          "property1": null,          "property2": null        },        "controllerPlatform": "aws",        "dependencies": [          {            "id": "string",            "type": "string"          }        ],        "error": {          "code": "string",          "context": null,          "hint": "string",          "httpStatusCode": 100,          "internal": true,          "message": "string",          "retryable": false,          "source": null        },        "lastFailedState": null,        "lifecycle": "frozen",        "outputs": {          "type": "string",          "property1": null,          "property2": null        },        "previousConfig": {          "id": "string",          "type": "string",          "property1": null,          "property2": null        },        "remoteBindingParams": null,        "retryAttempt": 0,        "status": "pending",        "type": "string"      }    }  },  "runtimeMetadata": {    "initialSetupAuthority": "importedHandoff",    "lastSyncedEnvVarsHash": "string",    "lastSyncedSecretNames": [      "string"    ],    "pendingPreparedStack": {      "id": "string",      "inputs": [        {          "default": {            "type": "string",            "value": "string"          },          "description": "string",          "env": [            {              "name": "string",              "targetResources": [                "string"              ],              "type": "plain"            }          ],          "id": "string",          "kind": "string",          "label": "string",          "placeholder": "string",          "platforms": [            "aws"          ],          "providedBy": [            "developer"          ],          "required": true,          "validation": {            "format": "string",            "max": "string",            "maxItems": 0,            "maxLength": 0,            "min": "string",            "minItems": 0,            "minLength": 0,            "pattern": "string",            "values": [              "string"            ]          }        }      ],      "permissions": {        "management": {          "extend": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          }        },        "profiles": {          "property1": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          },          "property2": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          }        }      },      "resources": {        "property1": {          "config": {            "id": "string",            "type": "string",            "property1": null,            "property2": null          },          "dependencies": [            {              "id": "string",              "type": "string"            }          ],          "enabledWhen": "string",          "lifecycle": "frozen",          "remoteAccess": true        },        "property2": {          "config": {            "id": "string",            "type": "string",            "property1": null,            "property2": null          },          "dependencies": [            {              "id": "string",              "type": "string"            }          ],          "enabledWhen": "string",          "lifecycle": "frozen",          "remoteAccess": true        }      },      "supportedPlatforms": [        "aws"      ]    },    "persistedGateAnswers": {      "property1": true,      "property2": true    },    "preparedStack": {      "id": "string",      "inputs": [        {          "default": {            "type": "string",            "value": "string"          },          "description": "string",          "env": [            {              "name": "string",              "targetResources": [                "string"              ],              "type": "plain"            }          ],          "id": "string",          "kind": "string",          "label": "string",          "placeholder": "string",          "platforms": [            "aws"          ],          "providedBy": [            "developer"          ],          "required": true,          "validation": {            "format": "string",            "max": "string",            "maxItems": 0,            "maxLength": 0,            "min": "string",            "minItems": 0,            "minLength": 0,            "pattern": "string",            "values": [              "string"            ]          }        }      ],      "permissions": {        "management": {          "extend": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          }        },        "profiles": {          "property1": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          },          "property2": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          }        }      },      "resources": {        "property1": {          "config": {            "id": "string",            "type": "string",            "property1": null,            "property2": null          },          "dependencies": [            {              "id": "string",              "type": "string"            }          ],          "enabledWhen": "string",          "lifecycle": "frozen",          "remoteAccess": true        },        "property2": {          "config": {            "id": "string",            "type": "string",            "property1": null,            "property2": null          },          "dependencies": [            {              "id": "string",              "type": "string"            }          ],          "enabledWhen": "string",          "lifecycle": "frozen",          "remoteAccess": true        }      },      "supportedPlatforms": [        "aws"      ]    },    "registryAccessGranted": true,    "setupUpdateAuthorization": {      "baselineFrozenDigest": "string",      "nonce": "string",      "releaseId": "string",      "setupFingerprint": "string",      "setupFingerprintVersion": 0,      "setupTarget": "string",      "targetFrozenDigest": "string"    }  },  "currentReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",  "desiredReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",  "pinnedReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",  "releaseChannel": "string",  "importSource": "cloudformation",  "setupMethod": "cloudformation",  "setupMetadata": {    "property1": null,    "property2": null  },  "setupTarget": "string",  "setupFingerprint": "string",  "setupFingerprintVersion": 1,  "operatorScope": "string",  "operatorPermission": "string",  "operatorVersion": "string",  "capabilities": [    {      "key": "string",      "state": "granted",      "detail": "string"    }  ],  "retryRequested": true,  "lastHeartbeatAt": "2019-08-24T14:15:22Z",  "error": {    "code": "string",    "context": null,    "hint": "string",    "httpStatusCode": 100,    "internal": true,    "message": "string",    "retryable": false,    "source": null  },  "environmentVariables": [    {      "name": "string",      "value": "string",      "type": "plain",      "targetResources": [        "string"      ]    }  ],  "targetEnvironmentVariables": {    "variables": [      {        "name": "string",        "value": "string",        "type": "plain",        "targetResources": [          "string"        ]      }    ],    "hash": "string",    "createdAt": "2019-08-24T14:15:22Z"  },  "currentEnvironmentVariables": {    "variables": [      {        "name": "string",        "value": "string",        "type": "plain",        "targetResources": [          "string"        ]      }    ],    "hash": "string",    "createdAt": "2019-08-24T14:15:22Z"  },  "updateState": {    "active": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "queued",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "requestedAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    },    "next": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "queued",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "requestedAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    },    "latest": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "queued",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "requestedAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    }  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "managerId": "mgr_enxscjrqiiu2lrc672hwwuc5",  "workspaceId": "ws_It13CUaGEhLLAB87simX0",  "release": {    "id": "rel_WbhQgksrawSKIpEN0NAssHX9",    "version": "string",    "gitMetadata": {      "commitSha": "dc36199b2234c6586ebe05ec94078a895c707e29",      "commitMessage": "add method to measure Interaction to Next Paint (INP) (#36490)",      "commitRef": "main",      "commitDate": "2026-03-16T12:00:00Z",      "dirty": true,      "remoteUrl": "https://github.com/alienplatform/alien",      "commitAuthorName": "John Doe",      "commitAuthorEmail": "john@example.com",      "commitAuthorLogin": "johndoe",      "commitAuthorAvatarUrl": "https://github.com/johndoe.png",      "provider": {        "type": "github",        "org": "string",        "repo": "string"      }    },    "createdAt": "2019-08-24T14:15:22Z"  },  "deploymentGroup": {    "id": "dg_r27ict8c7vcgsumpj90ackf7b",    "name": "prod-us-east-1",    "externalId": "ext_example_01"  },  "project": {    "id": "prj_mcytp6z3j91f7tn5ryqsfwtr",    "name": "my-app"  }}

Get Deployment Connection Info

Get deployment connection information including command endpoint and resource URLs.

Authorization

apiKey

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.

Matchdep_[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/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/info"

{  "arc": {    "url": "http://example.com",    "deploymentId": "string"  },  "resources": {    "property1": {      "type": "string",      "publicEndpoints": {        "property1": {          "url": "http://example.com",          "protocol": "http",          "host": "string",          "port": 1,          "wildcardHost": "string"        },        "property2": {          "url": "http://example.com",          "protocol": "http",          "host": "string",          "port": 1,          "wildcardHost": "string"        }      }    },    "property2": {      "type": "string",      "publicEndpoints": {        "property1": {          "url": "http://example.com",          "protocol": "http",          "host": "string",          "port": 1,          "wildcardHost": "string"        },        "property2": {          "url": "http://example.com",          "protocol": "http",          "host": "string",          "port": 1,          "wildcardHost": "string"        }      }    }  },  "status": "pending",  "platform": "string"}

Import Deployment

Import a deployment from resolved setup infrastructure such as CloudFormation, Terraform, or Helm.

Authorization

apiKey

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.

Request schema for importing a deployment from resolved setup infrastructure

mode?"forward"

Default"forward"

Value in

"forward"

project?string

Project ID or name. Required for user-session callers.

Lengthlength <= 100

deploymentGroupId?string

Required for user-session callers. Deployment-group tokens use their own group automatically.

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

managerId?string

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

source*

Resolved setup import payload

setupItem?string

Exact item selected from a tailored customer setup link.

Value in

"deployment"
"models"
"keys"
"bucket"
"registry"

inputValues?

Default{}

Response Body

`application/json`

curl -X POST "https://example.com/v1/deployments/import" \  -H "Content-Type: application/json" \  -d '{    "source": {      "deploymentName": "string",      "resourcePrefix": "string",      "platform": "aws",      "region": "string",      "setupTarget": "string",      "setupImportFormatVersion": 1,      "setupFingerprint": "string",      "setupFingerprintVersion": 0,      "stackSettings": {},      "resources": [        {          "id": "string",          "type": "string",          "importData": {            "property1": null,            "property2": null          }        }      ]    }  }'

{  "id": "dep_0c29fq4a2yjb7kx3smwdgxlc",  "name": "acme-prod",  "publicSubdomain": "string",  "status": "pending",  "projectId": "prj_mcytp6z3j91f7tn5ryqsfwtr",  "platform": "aws",  "basePlatform": "aws",  "region": "string",  "deploymentProtocolVersion": 1,  "deploymentGroupId": "dg_r27ict8c7vcgsumpj90ackf7b",  "purpose": "application",  "environmentInfo": {    "accountId": "string",    "region": "string",    "platform": "aws"  },  "stackSettings": {    "compute": {      "pools": {        "property1": {          "failure_domains": {            "selectedFailureDomains": [              "string"            ],            "spread": 0          },          "machine": "string",          "machines": 0,          "mode": "fixed"        },        "property2": {          "failure_domains": {            "selectedFailureDomains": [              "string"            ],            "spread": 0          },          "machine": "string",          "machines": 0,          "mode": "fixed"        }      }    },    "deploymentModel": "push",    "domains": {      "customDomains": {        "property1": {          "certificate": {            "aws": {              "certificateArn": "string"            },            "azure": {              "keyVaultCertificateId": "string",              "keyVaultResourceId": "string"            },            "gcp": {              "certificateName": "string"            },            "kubernetes": {              "tlsSecretRef": {                "namespace": "string",                "secretName": "string"              }            }          },          "domain": "string"        },        "property2": {          "certificate": {            "aws": {              "certificateArn": "string"            },            "azure": {              "keyVaultCertificateId": "string",              "keyVaultResourceId": "string"            },            "gcp": {              "certificateName": "string"            },            "kubernetes": {              "tlsSecretRef": {                "namespace": "string",                "secretName": "string"              }            }          },          "domain": "string"        }      },      "publicEndpointTarget": {        "mode": "machineAddresses"      }    },    "externalBindings": {},    "heartbeats": "off",    "kubernetes": {      "cluster": {        "cloud": {          "accountId": "string",          "clusterId": "string",          "clusterName": "string",          "projectId": "string",          "region": "string",          "resourceGroup": "string",          "subscriptionId": "string"        },        "namespace": "string",        "ownership": "managed"      },      "exposure": {        "mode": "disabled"      }    },    "network": {      "type": "use-default"    },    "telemetry": "off",    "updates": "auto"  },  "stackState": {    "platform": "aws",    "resourcePrefix": "string",    "resources": {      "property1": {        "_internal": null,        "config": {          "id": "string",          "type": "string",          "property1": null,          "property2": null        },        "controllerPlatform": "aws",        "dependencies": [          {            "id": "string",            "type": "string"          }        ],        "error": {          "code": "string",          "context": null,          "hint": "string",          "httpStatusCode": 100,          "internal": true,          "message": "string",          "retryable": false,          "source": null        },        "lastFailedState": null,        "lifecycle": "frozen",        "outputs": {          "type": "string",          "property1": null,          "property2": null        },        "previousConfig": {          "id": "string",          "type": "string",          "property1": null,          "property2": null        },        "remoteBindingParams": null,        "retryAttempt": 0,        "status": "pending",        "type": "string"      },      "property2": {        "_internal": null,        "config": {          "id": "string",          "type": "string",          "property1": null,          "property2": null        },        "controllerPlatform": "aws",        "dependencies": [          {            "id": "string",            "type": "string"          }        ],        "error": {          "code": "string",          "context": null,          "hint": "string",          "httpStatusCode": 100,          "internal": true,          "message": "string",          "retryable": false,          "source": null        },        "lastFailedState": null,        "lifecycle": "frozen",        "outputs": {          "type": "string",          "property1": null,          "property2": null        },        "previousConfig": {          "id": "string",          "type": "string",          "property1": null,          "property2": null        },        "remoteBindingParams": null,        "retryAttempt": 0,        "status": "pending",        "type": "string"      }    }  },  "runtimeMetadata": {    "initialSetupAuthority": "importedHandoff",    "lastSyncedEnvVarsHash": "string",    "lastSyncedSecretNames": [      "string"    ],    "pendingPreparedStack": {      "id": "string",      "inputs": [        {          "default": {            "type": "string",            "value": "string"          },          "description": "string",          "env": [            {              "name": "string",              "targetResources": [                "string"              ],              "type": "plain"            }          ],          "id": "string",          "kind": "string",          "label": "string",          "placeholder": "string",          "platforms": [            "aws"          ],          "providedBy": [            "developer"          ],          "required": true,          "validation": {            "format": "string",            "max": "string",            "maxItems": 0,            "maxLength": 0,            "min": "string",            "minItems": 0,            "minLength": 0,            "pattern": "string",            "values": [              "string"            ]          }        }      ],      "permissions": {        "management": {          "extend": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          }        },        "profiles": {          "property1": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          },          "property2": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          }        }      },      "resources": {        "property1": {          "config": {            "id": "string",            "type": "string",            "property1": null,            "property2": null          },          "dependencies": [            {              "id": "string",              "type": "string"            }          ],          "enabledWhen": "string",          "lifecycle": "frozen",          "remoteAccess": true        },        "property2": {          "config": {            "id": "string",            "type": "string",            "property1": null,            "property2": null          },          "dependencies": [            {              "id": "string",              "type": "string"            }          ],          "enabledWhen": "string",          "lifecycle": "frozen",          "remoteAccess": true        }      },      "supportedPlatforms": [        "aws"      ]    },    "persistedGateAnswers": {      "property1": true,      "property2": true    },    "preparedStack": {      "id": "string",      "inputs": [        {          "default": {            "type": "string",            "value": "string"          },          "description": "string",          "env": [            {              "name": "string",              "targetResources": [                "string"              ],              "type": "plain"            }          ],          "id": "string",          "kind": "string",          "label": "string",          "placeholder": "string",          "platforms": [            "aws"          ],          "providedBy": [            "developer"          ],          "required": true,          "validation": {            "format": "string",            "max": "string",            "maxItems": 0,            "maxLength": 0,            "min": "string",            "minItems": 0,            "minLength": 0,            "pattern": "string",            "values": [              "string"            ]          }        }      ],      "permissions": {        "management": {          "extend": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          }        },        "profiles": {          "property1": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          },          "property2": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          }        }      },      "resources": {        "property1": {          "config": {            "id": "string",            "type": "string",            "property1": null,            "property2": null          },          "dependencies": [            {              "id": "string",              "type": "string"            }          ],          "enabledWhen": "string",          "lifecycle": "frozen",          "remoteAccess": true        },        "property2": {          "config": {            "id": "string",            "type": "string",            "property1": null,            "property2": null          },          "dependencies": [            {              "id": "string",              "type": "string"            }          ],          "enabledWhen": "string",          "lifecycle": "frozen",          "remoteAccess": true        }      },      "supportedPlatforms": [        "aws"      ]    },    "registryAccessGranted": true,    "setupUpdateAuthorization": {      "baselineFrozenDigest": "string",      "nonce": "string",      "releaseId": "string",      "setupFingerprint": "string",      "setupFingerprintVersion": 0,      "setupTarget": "string",      "targetFrozenDigest": "string"    }  },  "currentReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",  "desiredReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",  "pinnedReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",  "releaseChannel": "string",  "importSource": "cloudformation",  "setupMethod": "cloudformation",  "setupMetadata": {    "property1": null,    "property2": null  },  "setupTarget": "string",  "setupFingerprint": "string",  "setupFingerprintVersion": 1,  "operatorScope": "string",  "operatorPermission": "string",  "operatorVersion": "string",  "capabilities": [    {      "key": "string",      "state": "granted",      "detail": "string"    }  ],  "retryRequested": true,  "lastHeartbeatAt": "2019-08-24T14:15:22Z",  "error": {    "code": "string",    "context": null,    "hint": "string",    "httpStatusCode": 100,    "internal": true,    "message": "string",    "retryable": false,    "source": null  },  "environmentVariables": [    {      "name": "string",      "value": "string",      "type": "plain",      "targetResources": [        "string"      ]    }  ],  "targetEnvironmentVariables": {    "variables": [      {        "name": "string",        "value": "string",        "type": "plain",        "targetResources": [          "string"        ]      }    ],    "hash": "string",    "createdAt": "2019-08-24T14:15:22Z"  },  "currentEnvironmentVariables": {    "variables": [      {        "name": "string",        "value": "string",        "type": "plain",        "targetResources": [          "string"        ]      }    ],    "hash": "string",    "createdAt": "2019-08-24T14:15:22Z"  },  "updateState": {    "active": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "queued",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "requestedAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    },    "next": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "queued",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "requestedAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    },    "latest": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "queued",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "requestedAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    }  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "managerId": "mgr_enxscjrqiiu2lrc672hwwuc5",  "workspaceId": "ws_It13CUaGEhLLAB87simX0"}

Set First Party Deployment Inputs

Store operator-provided input values on a first-party deployment session token so CLI/local deploys apply them.

Authorization

apiKey

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.

platform*string

Represents the target cloud platform.

Value in

"aws"
"gcp"
"azure"
"kubernetes"
"machines"
"local"
"test"

inputValues?

Default{}

Response Body

`application/json`

curl -X PUT "https://example.com/v1/deployments/first-party-inputs" \  -H "Content-Type: application/json" \  -d '{    "platform": "aws"  }'

{  "ok": true}

Create Setup Registration Operation

Start a durable setup registration operation for CloudFormation, Terraform, or Helm.

Authorization

apiKey

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.

action*SetupRegistrationAction

Value in

"create"
"update"
"delete"

sourceKind*string

Value in

"cloudformation"
"terraform"
"helm"

source?|null

inputValues?

Default{}

deploymentId?|

Unique identifier for the deployment.

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

idempotencyKey?string

Length1 <= length <= 512

cloudFormation?|null

Response Body

`application/json`

curl -X POST "https://example.com/v1/deployments/setup-registration-operations" \  -H "Content-Type: application/json" \  -d '{    "action": "create",    "sourceKind": "cloudformation"  }'

{  "id": "setupop_y41lqnfosxuwqkzmiax7",  "action": "create",  "sourceKind": "cloudformation",  "status": "pending",  "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc",  "physicalResourceId": "string",  "result": {    "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc",    "deploymentToken": "string",    "helmValues": "string"  },  "error": {    "message": "string",    "retryable": true  }}

Get Setup Registration Operation

Get setup registration operation status.

Authorization

apiKey

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 setup registration operation.

Matchsetupop_[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/deployments/setup-registration-operations/setupop_y41lqnfosxuwqkzmiax7"

{  "id": "setupop_y41lqnfosxuwqkzmiax7",  "action": "create",  "sourceKind": "cloudformation",  "status": "pending",  "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc",  "physicalResourceId": "string",  "result": {    "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc",    "deploymentToken": "string",    "helmValues": "string"  },  "error": {    "message": "string",    "retryable": true  }}

Delete Deployment

Delete, detach, or forget a deployment by ID.

Authorization

apiKey

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.

Matchdep_[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.

action*string

Value in

"cleanup"
"detach"
"forget"

Response Body

`application/json`

curl -X POST "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/delete" \  -H "Content-Type: application/json" \  -d '{    "action": "cleanup"  }'

{  "action": "cleanup",  "message": "string"}

Redeploy Deployment

Redeploy a running deployment with the same release and fresh environment variables. Sets status to update-pending.

Authorization

apiKey

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.

Matchdep_[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/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/redeploy"

{  "message": "string",  "operation": {    "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",    "status": "queued",    "reasons": [      "configuration"    ],    "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",    "changedKeys": [      "string"    ],    "requestedAt": "2019-08-24T14:15:22Z",    "startedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z"  }}

Pin Deployment Release

Pin or unpin a running or runtime-failed deployment. Running deployments start an update; failed deployments retry toward the selected release.

Authorization

apiKey

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.

Matchdep_[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.

Request schema for pinning/unpinning deployment release

releaseId?|

Release ID to pin the deployment to. Set to null to resume its followed channel.

Matchrel_[0-9a-zA-Z]{28}$

Response Body

`application/json`

curl -X POST "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/pin-release" \  -H "Content-Type: application/json" \  -d '{}'

{  "message": "string"}

Set Deployment Release Channel

Authorization

apiKey

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.

Matchdep_[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.

channel*ReleaseChannelName

Match^[a-z][a-z0-9-]*$

Length1 <= length <= 63

Response Body

`application/json`

curl -X POST "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/release-channel" \  -H "Content-Type: application/json" \  -d '{    "channel": "string"  }'

{  "id": "dep_0c29fq4a2yjb7kx3smwdgxlc",  "name": "acme-prod",  "publicSubdomain": "string",  "status": "pending",  "projectId": "prj_mcytp6z3j91f7tn5ryqsfwtr",  "platform": "aws",  "basePlatform": "aws",  "region": "string",  "deploymentProtocolVersion": 1,  "deploymentGroupId": "dg_r27ict8c7vcgsumpj90ackf7b",  "purpose": "application",  "environmentInfo": {    "accountId": "string",    "region": "string",    "platform": "aws"  },  "stackSettings": {    "compute": {      "pools": {        "property1": {          "failure_domains": {            "selectedFailureDomains": [              "string"            ],            "spread": 0          },          "machine": "string",          "machines": 0,          "mode": "fixed"        },        "property2": {          "failure_domains": {            "selectedFailureDomains": [              "string"            ],            "spread": 0          },          "machine": "string",          "machines": 0,          "mode": "fixed"        }      }    },    "deploymentModel": "push",    "domains": {      "customDomains": {        "property1": {          "certificate": {            "aws": {              "certificateArn": "string"            },            "azure": {              "keyVaultCertificateId": "string",              "keyVaultResourceId": "string"            },            "gcp": {              "certificateName": "string"            },            "kubernetes": {              "tlsSecretRef": {                "namespace": "string",                "secretName": "string"              }            }          },          "domain": "string"        },        "property2": {          "certificate": {            "aws": {              "certificateArn": "string"            },            "azure": {              "keyVaultCertificateId": "string",              "keyVaultResourceId": "string"            },            "gcp": {              "certificateName": "string"            },            "kubernetes": {              "tlsSecretRef": {                "namespace": "string",                "secretName": "string"              }            }          },          "domain": "string"        }      },      "publicEndpointTarget": {        "mode": "machineAddresses"      }    },    "externalBindings": {},    "heartbeats": "off",    "kubernetes": {      "cluster": {        "cloud": {          "accountId": "string",          "clusterId": "string",          "clusterName": "string",          "projectId": "string",          "region": "string",          "resourceGroup": "string",          "subscriptionId": "string"        },        "namespace": "string",        "ownership": "managed"      },      "exposure": {        "mode": "disabled"      }    },    "network": {      "type": "use-default"    },    "telemetry": "off",    "updates": "auto"  },  "stackState": {    "platform": "aws",    "resourcePrefix": "string",    "resources": {      "property1": {        "_internal": null,        "config": {          "id": "string",          "type": "string",          "property1": null,          "property2": null        },        "controllerPlatform": "aws",        "dependencies": [          {            "id": "string",            "type": "string"          }        ],        "error": {          "code": "string",          "context": null,          "hint": "string",          "httpStatusCode": 100,          "internal": true,          "message": "string",          "retryable": false,          "source": null        },        "lastFailedState": null,        "lifecycle": "frozen",        "outputs": {          "type": "string",          "property1": null,          "property2": null        },        "previousConfig": {          "id": "string",          "type": "string",          "property1": null,          "property2": null        },        "remoteBindingParams": null,        "retryAttempt": 0,        "status": "pending",        "type": "string"      },      "property2": {        "_internal": null,        "config": {          "id": "string",          "type": "string",          "property1": null,          "property2": null        },        "controllerPlatform": "aws",        "dependencies": [          {            "id": "string",            "type": "string"          }        ],        "error": {          "code": "string",          "context": null,          "hint": "string",          "httpStatusCode": 100,          "internal": true,          "message": "string",          "retryable": false,          "source": null        },        "lastFailedState": null,        "lifecycle": "frozen",        "outputs": {          "type": "string",          "property1": null,          "property2": null        },        "previousConfig": {          "id": "string",          "type": "string",          "property1": null,          "property2": null        },        "remoteBindingParams": null,        "retryAttempt": 0,        "status": "pending",        "type": "string"      }    }  },  "runtimeMetadata": {    "initialSetupAuthority": "importedHandoff",    "lastSyncedEnvVarsHash": "string",    "lastSyncedSecretNames": [      "string"    ],    "pendingPreparedStack": {      "id": "string",      "inputs": [        {          "default": {            "type": "string",            "value": "string"          },          "description": "string",          "env": [            {              "name": "string",              "targetResources": [                "string"              ],              "type": "plain"            }          ],          "id": "string",          "kind": "string",          "label": "string",          "placeholder": "string",          "platforms": [            "aws"          ],          "providedBy": [            "developer"          ],          "required": true,          "validation": {            "format": "string",            "max": "string",            "maxItems": 0,            "maxLength": 0,            "min": "string",            "minItems": 0,            "minLength": 0,            "pattern": "string",            "values": [              "string"            ]          }        }      ],      "permissions": {        "management": {          "extend": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          }        },        "profiles": {          "property1": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          },          "property2": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          }        }      },      "resources": {        "property1": {          "config": {            "id": "string",            "type": "string",            "property1": null,            "property2": null          },          "dependencies": [            {              "id": "string",              "type": "string"            }          ],          "enabledWhen": "string",          "lifecycle": "frozen",          "remoteAccess": true        },        "property2": {          "config": {            "id": "string",            "type": "string",            "property1": null,            "property2": null          },          "dependencies": [            {              "id": "string",              "type": "string"            }          ],          "enabledWhen": "string",          "lifecycle": "frozen",          "remoteAccess": true        }      },      "supportedPlatforms": [        "aws"      ]    },    "persistedGateAnswers": {      "property1": true,      "property2": true    },    "preparedStack": {      "id": "string",      "inputs": [        {          "default": {            "type": "string",            "value": "string"          },          "description": "string",          "env": [            {              "name": "string",              "targetResources": [                "string"              ],              "type": "plain"            }          ],          "id": "string",          "kind": "string",          "label": "string",          "placeholder": "string",          "platforms": [            "aws"          ],          "providedBy": [            "developer"          ],          "required": true,          "validation": {            "format": "string",            "max": "string",            "maxItems": 0,            "maxLength": 0,            "min": "string",            "minItems": 0,            "minLength": 0,            "pattern": "string",            "values": [              "string"            ]          }        }      ],      "permissions": {        "management": {          "extend": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          }        },        "profiles": {          "property1": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          },          "property2": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ],            "property2": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "resources": [                            "string"                          ]                        }                      },                      "description": "string",                      "effect": "Allow",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "azure": [                    {                      "binding": {                        "resource": {                          "scope": "string"                        },                        "stack": {                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ],                  "gcp": [                    {                      "binding": {                        "resource": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        },                        "stack": {                          "condition": {                            "expression": "string",                            "title": "string"                          },                          "scope": "string"                        }                      },                      "description": "string",                      "grant": {                        "actions": [                          "string"                        ],                        "dataActions": [                          "string"                        ],                        "permissions": [                          "string"                        ],                        "predefinedRoles": [                          "string"                        ],                        "residualPermissions": [                          "string"                        ]                      },                      "label": "string"                    }                  ]                }              }            ]          }        }      },      "resources": {        "property1": {          "config": {            "id": "string",            "type": "string",            "property1": null,            "property2": null          },          "dependencies": [            {              "id": "string",              "type": "string"            }          ],          "enabledWhen": "string",          "lifecycle": "frozen",          "remoteAccess": true        },        "property2": {          "config": {            "id": "string",            "type": "string",            "property1": null,            "property2": null          },          "dependencies": [            {              "id": "string",              "type": "string"            }          ],          "enabledWhen": "string",          "lifecycle": "frozen",          "remoteAccess": true        }      },      "supportedPlatforms": [        "aws"      ]    },    "registryAccessGranted": true,    "setupUpdateAuthorization": {      "baselineFrozenDigest": "string",      "nonce": "string",      "releaseId": "string",      "setupFingerprint": "string",      "setupFingerprintVersion": 0,      "setupTarget": "string",      "targetFrozenDigest": "string"    }  },  "currentReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",  "desiredReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",  "pinnedReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",  "releaseChannel": "string",  "importSource": "cloudformation",  "setupMethod": "cloudformation",  "setupMetadata": {    "property1": null,    "property2": null  },  "setupTarget": "string",  "setupFingerprint": "string",  "setupFingerprintVersion": 1,  "operatorScope": "string",  "operatorPermission": "string",  "operatorVersion": "string",  "capabilities": [    {      "key": "string",      "state": "granted",      "detail": "string"    }  ],  "retryRequested": true,  "lastHeartbeatAt": "2019-08-24T14:15:22Z",  "error": {    "code": "string",    "context": null,    "hint": "string",    "httpStatusCode": 100,    "internal": true,    "message": "string",    "retryable": false,    "source": null  },  "environmentVariables": [    {      "name": "string",      "value": "string",      "type": "plain",      "targetResources": [        "string"      ]    }  ],  "targetEnvironmentVariables": {    "variables": [      {        "name": "string",        "value": "string",        "type": "plain",        "targetResources": [          "string"        ]      }    ],    "hash": "string",    "createdAt": "2019-08-24T14:15:22Z"  },  "currentEnvironmentVariables": {    "variables": [      {        "name": "string",        "value": "string",        "type": "plain",        "targetResources": [          "string"        ]      }    ],    "hash": "string",    "createdAt": "2019-08-24T14:15:22Z"  },  "updateState": {    "active": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "queued",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "requestedAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    },    "next": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "queued",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "requestedAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    },    "latest": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "queued",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "requestedAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    }  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "managerId": "mgr_enxscjrqiiu2lrc672hwwuc5",  "workspaceId": "ws_It13CUaGEhLLAB87simX0"}

Retry Deployment

Retry a failed deployment operation. Uses alien-infra's retry mechanisms to resume from exact failure point.

Authorization

apiKey

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.

Matchdep_[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/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/retry"

{  "message": "string"}

Get Deployment Inputs

Get the active input definitions and current non-secret values for a deployment.

Authorization

apiKey

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.

Matchdep_[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/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/inputs"

{  "inputs": [    {      "default": {        "type": "string",        "value": "string"      },      "description": "string",      "env": [        {          "name": "string",          "targetResources": [            "string"          ],          "type": "plain"        }      ],      "id": "string",      "kind": "string",      "label": "string",      "placeholder": "string",      "platforms": [        "aws"      ],      "providedBy": [        "developer"      ],      "required": true,      "validation": {        "format": "string",        "max": "string",        "maxItems": 0,        "maxLength": 0,        "min": "string",        "minItems": 0,        "minLength": 0,        "pattern": "string",        "values": [          "string"        ]      }    }  ],  "values": {    "property1": "string",    "property2": "string"  },  "providedInputIds": [    "string"  ]}

Update Deployment Inputs

Update runtime stack inputs, rebuild their environment-variable mappings, and request a deployment update when runtime configuration changes.

Authorization

apiKey

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.

Matchdep_[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.

inputValues?

Default{}

clearInputIds?array<string>

Default[]

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/inputs" \  -H "Content-Type: application/json" \  -d '{}'

{  "inputs": [    {      "default": {        "type": "string",        "value": "string"      },      "description": "string",      "env": [        {          "name": "string",          "targetResources": [            "string"          ],          "type": "plain"        }      ],      "id": "string",      "kind": "string",      "label": "string",      "placeholder": "string",      "platforms": [        "aws"      ],      "providedBy": [        "developer"      ],      "required": true,      "validation": {        "format": "string",        "max": "string",        "maxItems": 0,        "maxLength": 0,        "min": "string",        "minItems": 0,        "minLength": 0,        "pattern": "string",        "values": [          "string"        ]      }    }  ],  "values": {    "property1": "string",    "property2": "string"  },  "providedInputIds": [    "string"  ],  "runtimeUpdateRequested": true,  "outcome": "accepted",  "operation": {    "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",    "status": "queued",    "reasons": [      "configuration"    ],    "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",    "changedKeys": [      "string"    ],    "requestedAt": "2019-08-24T14:15:22Z",    "startedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z"  }}

Update Deployment Environment Variables

Update a deployment's environment variables. If the deployment is running and not locked, the status will be changed to update-pending to trigger a deployment.

Authorization

apiKey

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.

Matchdep_[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.

Request schema for updating deployment environment variables

variables*array<>

Environment variables for the deployment

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/environment-variables" \  -H "Content-Type: application/json" \  -d '{    "variables": [      {        "name": "string",        "value": "string",        "type": "plain"      }    ]  }'

{  "message": "string"}

Create Deployment Token

Create a deployment token (deployment-scoped API key). The deployment must exist before creating a token.

Authorization

apiKey

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.

Matchdep_[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*|

Optional description for the deployment token

Length3 <= length <= 128

expiresAt?|

Optional expiration date for the deployment token

Formatdate-time

Response Body

`application/json`

curl -X POST "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/token" \  -H "Content-Type: application/json" \  -d '{    "description": "string"  }'

{  "token": "string",  "deploymentId": "string"}

200application/json

400application/json

500application/json

200application/json

201application/json

400application/json

403application/json

404application/json

409application/json

500application/json

200application/json

500application/json

200application/json

500application/json

200application/json

500application/json

200application/json

404application/json

500application/json

200application/json

400application/json

404application/json

500application/json

200application/json

201application/json

409application/json

500application/json

200application/json

400application/json

403application/json

500application/json

202application/json

400application/json

500application/json

200application/json

404application/json

500application/json

202application/json

400application/json

404application/json

409application/json

500application/json

202application/json

400application/json

404application/json

500application/json

202application/json

400application/json

404application/json

500application/json

200application/json

400application/json

404application/json

202application/json

400application/json

404application/json

500application/json

200application/json

403application/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`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`