Docs

Deployments

POST
/v1/deployments/{id}/move

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/move" \  -H "Content-Type: application/json" \  -d '{    "deploymentGroupId": "dg_r27ict8c7vcgsumpj90ackf7b"  }'
{  "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc",  "previousDeploymentGroupId": "dg_r27ict8c7vcgsumpj90ackf7b",  "deploymentGroupId": "dg_r27ict8c7vcgsumpj90ackf7b",  "membershipRevision": 0,  "result": "preview",  "blockers": [    "string"  ],  "projectionStatus": "not-required"}

List Deployments

GET
/v1/deployments

Retrieve all deployments.

Authorization

AuthorizationBearer <token>

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

In: header

Query Parameters

project?string

Filter by project ID or name.

Lengthlength <= 100
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"
  • "sandbox"
workspace?string

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

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$
Length4 <= length <= 100
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

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/deployments?project=my-project"
{  "items": [    {      "id": "dep_0c29fq4a2yjb7kx3smwdgxlc",      "name": "string",      "status": "pending",      "customerKeyUnavailable": true,      "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,      "updateBlocked": 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",        "title": "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

POST
/v1/deployments

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

Authorization

AuthorizationBearer <token>

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

In: header

Query Parameters

workspace?string

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request schema for creating a new deployment

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

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",    "membershipRevision": 0,    "membershipProjectionRevision": null,    "purpose": "application",    "environmentInfo": {      "accountId": "string",      "region": "string",      "platform": "aws"    },    "stackSettings": {      "compute": {        "containers": {          "property1": {            "cpu": 0,            "memory": "string",            "volumeSizeGib": 0          },          "property2": {            "cpu": 0,            "memory": "string",            "volumeSizeGib": 0          }        },        "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"        }      },      "endpointAccess": "internet",      "externalBindings": {        "property1": {          "accessKeyId": null,          "bucketName": null,          "endpoint": null,          "forcePathStyle": true,          "region": null,          "secretAccessKey": null,          "service": "s3",          "type": "storage"        },        "property2": {          "accessKeyId": null,          "bucketName": null,          "endpoint": null,          "forcePathStyle": true,          "region": null,          "secretAccessKey": null,          "service": "s3",          "type": "storage"        }      },      "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"      },      "publicEndpoints": {        "property1": {          "property1": "string",          "property2": "string"        },        "property2": {          "property1": "string",          "property2": "string"        }      },      "quotaWarningOverrides": [        "string"      ],      "setupManagement": "manual",      "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": {      "automaticSetup": true,      "credentialRetry": {        "startedAt": "2019-08-24T14:15:22Z",        "status": "pending"      },      "deployerSecrets": [        {          "inputId": "string",          "label": "string",          "location": {            "cliCommand": "string",            "commands": {              "checkCommand": "string",              "target": "string",              "unix": {                "inline": "string",                "prompt": "string"              },              "windows": {                "inline": "string",                "prompt": "string"              }            },            "consoleUrl": "string",            "deleteCommand": "string",            "name": "string",            "store": "aws-parameter-store",            "vaultName": "string"          },          "message": "string",          "required": true,          "status": "present",          "version": "string"        }      ],      "directSetupRevision": "string",      "initialSetupAuthority": "importedHandoff",      "lastSyncedEnvVarsHash": "string",      "lastSyncedSecretNames": [        "string"      ],      "pendingPreparedReleaseId": "string",      "pendingPreparedStack": {        "dynamicContainerImageResources": [          "string"        ],        "dynamicContainerRepositories": [          "string"        ],        "id": "string",        "inputs": [          {            "default": {              "type": "string",              "value": "string"            },            "description": "string",            "env": [              {                "name": "string",                "targetResources": [                  "string"                ],                "type": "plain"              }            ],            "generate": {              "length": 0            },            "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"              ]            }          }        ],        "operations": {          "custom": [            {              "approval": {                "property1": "auto",                "property2": "auto"              },              "settings": {                "property1": "string",                "property2": "string"              },              "name": "string",              "version": "string"            }          ],          "plugins": {            "property1": {              "approval": {                "property1": "auto",                "property2": "auto"              },              "settings": {                "property1": "string",                "property2": "string"              }            },            "property2": {              "approval": {                "property1": "auto",                "property2": "auto"              },              "settings": {                "property1": "string",                "property2": "string"              }            }          }        },        "permissions": {          "management": {            "extend": {              "property1": [                {                  "description": "string",                  "id": "string",                  "platforms": {                    "aws": [                      {                        "binding": {                          "resource": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "notResources": [                              null                            ],                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "notResources": [                              null                            ],                            "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": {}                            },                            "notResources": [                              null                            ],                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "notResources": [                              null                            ],                            "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": {}                            },                            "notResources": [                              null                            ],                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "notResources": [                              null                            ],                            "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": {}                            },                            "notResources": [                              null                            ],                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "notResources": [                              null                            ],                            "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": {}                            },                            "notResources": [                              null                            ],                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "notResources": [                              null                            ],                            "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": {}                            },                            "notResources": [                              null                            ],                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "notResources": [                              null                            ],                            "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": {        "dynamicContainerImageResources": [          "string"        ],        "dynamicContainerRepositories": [          "string"        ],        "id": "string",        "inputs": [          {            "default": {              "type": "string",              "value": "string"            },            "description": "string",            "env": [              {                "name": "string",                "targetResources": [                  "string"                ],                "type": "plain"              }            ],            "generate": {              "length": 0            },            "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"              ]            }          }        ],        "operations": {          "custom": [            {              "approval": {                "property1": "auto",                "property2": "auto"              },              "settings": {                "property1": "string",                "property2": "string"              },              "name": "string",              "version": "string"            }          ],          "plugins": {            "property1": {              "approval": {                "property1": "auto",                "property2": "auto"              },              "settings": {                "property1": "string",                "property2": "string"              }            },            "property2": {              "approval": {                "property1": "auto",                "property2": "auto"              },              "settings": {                "property1": "string",                "property2": "string"              }            }          }        },        "permissions": {          "management": {            "extend": {              "property1": [                {                  "description": "string",                  "id": "string",                  "platforms": {                    "aws": [                      {                        "binding": {                          "resource": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "notResources": [                              null                            ],                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "notResources": [                              null                            ],                            "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": {}                            },                            "notResources": [                              null                            ],                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "notResources": [                              null                            ],                            "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": {}                            },                            "notResources": [                              null                            ],                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "notResources": [                              null                            ],                            "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": {}                            },                            "notResources": [                              null                            ],                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "notResources": [                              null                            ],                            "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": {}                            },                            "notResources": [                              null                            ],                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "notResources": [                              null                            ],                            "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": {}                            },                            "notResources": [                              null                            ],                            "resources": [                              null                            ]                          },                          "stack": {                            "condition": {                              "property1": {},                              "property2": {}                            },                            "notResources": [                              null                            ],                            "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"        ]      },      "registryAccess": {        "repositories": [          "string"        ],        "serviceTypes": [          "string"        ]      },      "registryAccessGranted": true,      "setupScaffolding": {        "property1": {          "buildRoleName": "string",          "egress": {            "connectorArn": "string",            "connectorRequest": "string",            "operatorRoleName": "string",            "securityGroupId": "string"          },          "imageArn": "string",          "type": "awsSandbox"        },        "property2": {          "buildRoleName": "string",          "egress": {            "connectorArn": "string",            "connectorRequest": "string",            "operatorRoleName": "string",            "securityGroupId": "string"          },          "imageArn": "string",          "type": "awsSandbox"        }      },      "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"      }    ],    "observedOperationsBundleHash": "string",    "observedOperations": [      {        "plugin": "string",        "pluginVersion": "string",        "name": "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    },    "updateState": {      "active": {        "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",        "status": "blocked",        "reasons": [          "configuration"        ],        "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",        "changedKeys": [          "string"        ],        "blocker": {          "kind": "input",          "message": "string",          "inputId": "string"        },        "actionRequired": "string",        "cause": {          "kind": "promotion",          "actor": {            "email": "string",            "id": "string",            "kind": "user",            "via": "mcp"          },          "at": "2019-08-24T14:15:22Z",          "channel": "string",          "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9"        },        "requestedAt": "2019-08-24T14:15:22Z",        "startedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z"      },      "next": {        "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",        "status": "blocked",        "reasons": [          "configuration"        ],        "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",        "changedKeys": [          "string"        ],        "blocker": {          "kind": "input",          "message": "string",          "inputId": "string"        },        "actionRequired": "string",        "cause": {          "kind": "promotion",          "actor": {            "email": "string",            "id": "string",            "kind": "user",            "via": "mcp"          },          "at": "2019-08-24T14:15:22Z",          "channel": "string",          "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9"        },        "requestedAt": "2019-08-24T14:15:22Z",        "startedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z"      },      "latest": {        "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",        "status": "blocked",        "reasons": [          "configuration"        ],        "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",        "changedKeys": [          "string"        ],        "blocker": {          "kind": "input",          "message": "string",          "inputId": "string"        },        "actionRequired": "string",        "cause": {          "kind": "promotion",          "actor": {            "email": "string",            "id": "string",            "kind": "user",            "via": "mcp"          },          "at": "2019-08-24T14:15:22Z",          "channel": "string",          "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9"        },        "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",    "customerKeyUnavailable": true  },  "deploymentModel": "push",  "token": "string"}

Get Deployment Stats

GET
/v1/deployments/stats

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

Authorization

AuthorizationBearer <token>

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

In: header

Query Parameters

workspace?string

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

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$
Length4 <= length <= 100
project?string

Filter by project ID or name.

Lengthlength <= 100
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"
  • "sandbox"
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

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

Get Deployment

GET
/v1/deployments/{id}

Retrieve a deployment by ID.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$
Length4 <= length <= 100
include?array<>

Optional fields to include: release, deploymentGroup, project

Response Body

application/json

application/json

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",  "membershipRevision": 0,  "membershipProjectionRevision": null,  "purpose": "application",  "environmentInfo": {    "accountId": "string",    "region": "string",    "platform": "aws"  },  "stackSettings": {    "compute": {      "containers": {        "property1": {          "cpu": 0,          "memory": "string",          "volumeSizeGib": 0        },        "property2": {          "cpu": 0,          "memory": "string",          "volumeSizeGib": 0        }      },      "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"      }    },    "endpointAccess": "internet",    "externalBindings": {      "property1": {        "accessKeyId": null,        "bucketName": null,        "endpoint": null,        "forcePathStyle": true,        "region": null,        "secretAccessKey": null,        "service": "s3",        "type": "storage"      },      "property2": {        "accessKeyId": null,        "bucketName": null,        "endpoint": null,        "forcePathStyle": true,        "region": null,        "secretAccessKey": null,        "service": "s3",        "type": "storage"      }    },    "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"    },    "publicEndpoints": {      "property1": {        "property1": "string",        "property2": "string"      },      "property2": {        "property1": "string",        "property2": "string"      }    },    "quotaWarningOverrides": [      "string"    ],    "setupManagement": "manual",    "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": {    "automaticSetup": true,    "credentialRetry": {      "startedAt": "2019-08-24T14:15:22Z",      "status": "pending"    },    "deployerSecrets": [      {        "inputId": "string",        "label": "string",        "location": {          "cliCommand": "string",          "commands": {            "checkCommand": "string",            "target": "string",            "unix": {              "inline": "string",              "prompt": "string"            },            "windows": {              "inline": "string",              "prompt": "string"            }          },          "consoleUrl": "string",          "deleteCommand": "string",          "name": "string",          "store": "aws-parameter-store",          "vaultName": "string"        },        "message": "string",        "required": true,        "status": "present",        "version": "string"      }    ],    "directSetupRevision": "string",    "initialSetupAuthority": "importedHandoff",    "lastSyncedEnvVarsHash": "string",    "lastSyncedSecretNames": [      "string"    ],    "pendingPreparedReleaseId": "string",    "pendingPreparedStack": {      "dynamicContainerImageResources": [        "string"      ],      "dynamicContainerRepositories": [        "string"      ],      "id": "string",      "inputs": [        {          "default": {            "type": "string",            "value": "string"          },          "description": "string",          "env": [            {              "name": "string",              "targetResources": [                "string"              ],              "type": "plain"            }          ],          "generate": {            "length": 0          },          "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"            ]          }        }      ],      "operations": {        "custom": [          {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            },            "name": "string",            "version": "string"          }        ],        "plugins": {          "property1": {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            }          },          "property2": {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            }          }        }      },      "permissions": {        "management": {          "extend": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {      "dynamicContainerImageResources": [        "string"      ],      "dynamicContainerRepositories": [        "string"      ],      "id": "string",      "inputs": [        {          "default": {            "type": "string",            "value": "string"          },          "description": "string",          "env": [            {              "name": "string",              "targetResources": [                "string"              ],              "type": "plain"            }          ],          "generate": {            "length": 0          },          "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"            ]          }        }      ],      "operations": {        "custom": [          {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            },            "name": "string",            "version": "string"          }        ],        "plugins": {          "property1": {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            }          },          "property2": {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            }          }        }      },      "permissions": {        "management": {          "extend": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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"      ]    },    "registryAccess": {      "repositories": [        "string"      ],      "serviceTypes": [        "string"      ]    },    "registryAccessGranted": true,    "setupScaffolding": {      "property1": {        "buildRoleName": "string",        "egress": {          "connectorArn": "string",          "connectorRequest": "string",          "operatorRoleName": "string",          "securityGroupId": "string"        },        "imageArn": "string",        "type": "awsSandbox"      },      "property2": {        "buildRoleName": "string",        "egress": {          "connectorArn": "string",          "connectorRequest": "string",          "operatorRoleName": "string",          "securityGroupId": "string"        },        "imageArn": "string",        "type": "awsSandbox"      }    },    "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"    }  ],  "observedOperationsBundleHash": "string",  "observedOperations": [    {      "plugin": "string",      "pluginVersion": "string",      "name": "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  },  "updateState": {    "active": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "blocked",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "blocker": {        "kind": "input",        "message": "string",        "inputId": "string"      },      "actionRequired": "string",      "cause": {        "kind": "promotion",        "actor": {          "email": "string",          "id": "string",          "kind": "user",          "via": "mcp"        },        "at": "2019-08-24T14:15:22Z",        "channel": "string",        "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9"      },      "requestedAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    },    "next": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "blocked",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "blocker": {        "kind": "input",        "message": "string",        "inputId": "string"      },      "actionRequired": "string",      "cause": {        "kind": "promotion",        "actor": {          "email": "string",          "id": "string",          "kind": "user",          "via": "mcp"        },        "at": "2019-08-24T14:15:22Z",        "channel": "string",        "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9"      },      "requestedAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    },    "latest": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "blocked",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "blocker": {        "kind": "input",        "message": "string",        "inputId": "string"      },      "actionRequired": "string",      "cause": {        "kind": "promotion",        "actor": {          "email": "string",          "id": "string",          "kind": "user",          "via": "mcp"        },        "at": "2019-08-24T14:15:22Z",        "channel": "string",        "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9"      },      "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",  "customerKeyUnavailable": true,  "resourceObservedAt": "2019-08-24T14:15:22Z",  "release": {    "id": "rel_WbhQgksrawSKIpEN0NAssHX9",    "version": "string",    "title": "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"  },  "desiredRelease": {    "id": "rel_WbhQgksrawSKIpEN0NAssHX9",    "version": "string",    "title": "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"  },  "operatorSync": {    "id": "dosy_uxveigz3biyrosqycaqubbr",    "status": "preparing",    "stuckReason": "download-failed",    "statusMessage": "string",    "targetBundleHash": "string",    "observedBundleHash": "string",    "missingOperations": [      "string"    ],    "plugins": [      {        "name": "string",        "version": "string",        "source": "builtin",        "state": "running",        "previousVersion": "string"      }    ],    "targetSetAt": "2019-08-24T14:15:22Z",    "observedAt": "2019-08-24T14:15:22Z"  }}
GET
/v1/deployments/{id}/update-operations/{operationId}

Retrieve a deployment update operation by its durable operation ID.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Unique identifier for the deployment update operation.

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

Query Parameters

workspace?string

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

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

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/update-operations/duop_0vtxpb1sw4sbcdwg2xo37q6"
{  "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",  "status": "blocked",  "reasons": [    "configuration"  ],  "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",  "changedKeys": [    "string"  ],  "blocker": {    "kind": "input",    "message": "string",    "inputId": "string"  },  "actionRequired": "string",  "cause": {    "kind": "promotion",    "actor": {      "email": "string",      "id": "string",      "kind": "user",      "via": "mcp"    },    "at": "2019-08-24T14:15:22Z",    "channel": "string",    "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9"  },  "requestedAt": "2019-08-24T14:15:22Z",  "startedAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z"}
GET
/v1/deployments/{id}/info

Get deployment connection information including command endpoint and resource URLs.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Response Body

application/json

application/json

application/json

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

POST
/v1/deployments/import

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

Authorization

AuthorizationBearer <token>

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

In: header

Query Parameters

workspace?string

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request schema for importing a deployment from resolved setup infrastructure

Request schema for importing a deployment from resolved setup infrastructure

Response Body

application/json

application/json

application/json

application/json

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",  "membershipRevision": 0,  "membershipProjectionRevision": null,  "purpose": "application",  "environmentInfo": {    "accountId": "string",    "region": "string",    "platform": "aws"  },  "stackSettings": {    "compute": {      "containers": {        "property1": {          "cpu": 0,          "memory": "string",          "volumeSizeGib": 0        },        "property2": {          "cpu": 0,          "memory": "string",          "volumeSizeGib": 0        }      },      "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"      }    },    "endpointAccess": "internet",    "externalBindings": {      "property1": {        "accessKeyId": null,        "bucketName": null,        "endpoint": null,        "forcePathStyle": true,        "region": null,        "secretAccessKey": null,        "service": "s3",        "type": "storage"      },      "property2": {        "accessKeyId": null,        "bucketName": null,        "endpoint": null,        "forcePathStyle": true,        "region": null,        "secretAccessKey": null,        "service": "s3",        "type": "storage"      }    },    "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"    },    "publicEndpoints": {      "property1": {        "property1": "string",        "property2": "string"      },      "property2": {        "property1": "string",        "property2": "string"      }    },    "quotaWarningOverrides": [      "string"    ],    "setupManagement": "manual",    "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": {    "automaticSetup": true,    "credentialRetry": {      "startedAt": "2019-08-24T14:15:22Z",      "status": "pending"    },    "deployerSecrets": [      {        "inputId": "string",        "label": "string",        "location": {          "cliCommand": "string",          "commands": {            "checkCommand": "string",            "target": "string",            "unix": {              "inline": "string",              "prompt": "string"            },            "windows": {              "inline": "string",              "prompt": "string"            }          },          "consoleUrl": "string",          "deleteCommand": "string",          "name": "string",          "store": "aws-parameter-store",          "vaultName": "string"        },        "message": "string",        "required": true,        "status": "present",        "version": "string"      }    ],    "directSetupRevision": "string",    "initialSetupAuthority": "importedHandoff",    "lastSyncedEnvVarsHash": "string",    "lastSyncedSecretNames": [      "string"    ],    "pendingPreparedReleaseId": "string",    "pendingPreparedStack": {      "dynamicContainerImageResources": [        "string"      ],      "dynamicContainerRepositories": [        "string"      ],      "id": "string",      "inputs": [        {          "default": {            "type": "string",            "value": "string"          },          "description": "string",          "env": [            {              "name": "string",              "targetResources": [                "string"              ],              "type": "plain"            }          ],          "generate": {            "length": 0          },          "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"            ]          }        }      ],      "operations": {        "custom": [          {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            },            "name": "string",            "version": "string"          }        ],        "plugins": {          "property1": {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            }          },          "property2": {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            }          }        }      },      "permissions": {        "management": {          "extend": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {      "dynamicContainerImageResources": [        "string"      ],      "dynamicContainerRepositories": [        "string"      ],      "id": "string",      "inputs": [        {          "default": {            "type": "string",            "value": "string"          },          "description": "string",          "env": [            {              "name": "string",              "targetResources": [                "string"              ],              "type": "plain"            }          ],          "generate": {            "length": 0          },          "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"            ]          }        }      ],      "operations": {        "custom": [          {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            },            "name": "string",            "version": "string"          }        ],        "plugins": {          "property1": {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            }          },          "property2": {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            }          }        }      },      "permissions": {        "management": {          "extend": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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"      ]    },    "registryAccess": {      "repositories": [        "string"      ],      "serviceTypes": [        "string"      ]    },    "registryAccessGranted": true,    "setupScaffolding": {      "property1": {        "buildRoleName": "string",        "egress": {          "connectorArn": "string",          "connectorRequest": "string",          "operatorRoleName": "string",          "securityGroupId": "string"        },        "imageArn": "string",        "type": "awsSandbox"      },      "property2": {        "buildRoleName": "string",        "egress": {          "connectorArn": "string",          "connectorRequest": "string",          "operatorRoleName": "string",          "securityGroupId": "string"        },        "imageArn": "string",        "type": "awsSandbox"      }    },    "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"    }  ],  "observedOperationsBundleHash": "string",  "observedOperations": [    {      "plugin": "string",      "pluginVersion": "string",      "name": "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  },  "updateState": {    "active": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "blocked",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "blocker": {        "kind": "input",        "message": "string",        "inputId": "string"      },      "actionRequired": "string",      "cause": {        "kind": "promotion",        "actor": {          "email": "string",          "id": "string",          "kind": "user",          "via": "mcp"        },        "at": "2019-08-24T14:15:22Z",        "channel": "string",        "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9"      },      "requestedAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    },    "next": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "blocked",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "blocker": {        "kind": "input",        "message": "string",        "inputId": "string"      },      "actionRequired": "string",      "cause": {        "kind": "promotion",        "actor": {          "email": "string",          "id": "string",          "kind": "user",          "via": "mcp"        },        "at": "2019-08-24T14:15:22Z",        "channel": "string",        "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9"      },      "requestedAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    },    "latest": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "blocked",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "blocker": {        "kind": "input",        "message": "string",        "inputId": "string"      },      "actionRequired": "string",      "cause": {        "kind": "promotion",        "actor": {          "email": "string",          "id": "string",          "kind": "user",          "via": "mcp"        },        "at": "2019-08-24T14:15:22Z",        "channel": "string",        "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9"      },      "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",  "customerKeyUnavailable": true}
POST
/v1/deployments/setup-registration-operations

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

Authorization

AuthorizationBearer <token>

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

In: header

Query Parameters

workspace?string

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

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
/v1/deployments/setup-registration-operations/{id}

Get setup registration operation status.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the setup registration operation.

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

Query Parameters

workspace?string

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

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

Response Body

application/json

application/json

application/json

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

POST
/v1/deployments/{id}/delete

Delete, detach, or forget a deployment by ID.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

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

POST
/v1/deployments/{id}/redeploy

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

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/redeploy"
{  "message": "string",  "operation": {    "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",    "status": "blocked",    "reasons": [      "configuration"    ],    "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",    "changedKeys": [      "string"    ],    "blocker": {      "kind": "input",      "message": "string",      "inputId": "string"    },    "actionRequired": "string",    "cause": {      "kind": "promotion",      "actor": {        "email": "string",        "id": "string",        "kind": "user",        "via": "mcp"      },      "at": "2019-08-24T14:15:22Z",      "channel": "string",      "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9"    },    "requestedAt": "2019-08-24T14:15:22Z",    "startedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z"  }}

Pin Deployment Release

POST
/v1/deployments/{id}/pin-release

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

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request schema for pinning/unpinning deployment release

Response Body

application/json

application/json

application/json

application/json

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

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

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",  "membershipRevision": 0,  "membershipProjectionRevision": null,  "purpose": "application",  "environmentInfo": {    "accountId": "string",    "region": "string",    "platform": "aws"  },  "stackSettings": {    "compute": {      "containers": {        "property1": {          "cpu": 0,          "memory": "string",          "volumeSizeGib": 0        },        "property2": {          "cpu": 0,          "memory": "string",          "volumeSizeGib": 0        }      },      "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"      }    },    "endpointAccess": "internet",    "externalBindings": {      "property1": {        "accessKeyId": null,        "bucketName": null,        "endpoint": null,        "forcePathStyle": true,        "region": null,        "secretAccessKey": null,        "service": "s3",        "type": "storage"      },      "property2": {        "accessKeyId": null,        "bucketName": null,        "endpoint": null,        "forcePathStyle": true,        "region": null,        "secretAccessKey": null,        "service": "s3",        "type": "storage"      }    },    "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"    },    "publicEndpoints": {      "property1": {        "property1": "string",        "property2": "string"      },      "property2": {        "property1": "string",        "property2": "string"      }    },    "quotaWarningOverrides": [      "string"    ],    "setupManagement": "manual",    "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": {    "automaticSetup": true,    "credentialRetry": {      "startedAt": "2019-08-24T14:15:22Z",      "status": "pending"    },    "deployerSecrets": [      {        "inputId": "string",        "label": "string",        "location": {          "cliCommand": "string",          "commands": {            "checkCommand": "string",            "target": "string",            "unix": {              "inline": "string",              "prompt": "string"            },            "windows": {              "inline": "string",              "prompt": "string"            }          },          "consoleUrl": "string",          "deleteCommand": "string",          "name": "string",          "store": "aws-parameter-store",          "vaultName": "string"        },        "message": "string",        "required": true,        "status": "present",        "version": "string"      }    ],    "directSetupRevision": "string",    "initialSetupAuthority": "importedHandoff",    "lastSyncedEnvVarsHash": "string",    "lastSyncedSecretNames": [      "string"    ],    "pendingPreparedReleaseId": "string",    "pendingPreparedStack": {      "dynamicContainerImageResources": [        "string"      ],      "dynamicContainerRepositories": [        "string"      ],      "id": "string",      "inputs": [        {          "default": {            "type": "string",            "value": "string"          },          "description": "string",          "env": [            {              "name": "string",              "targetResources": [                "string"              ],              "type": "plain"            }          ],          "generate": {            "length": 0          },          "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"            ]          }        }      ],      "operations": {        "custom": [          {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            },            "name": "string",            "version": "string"          }        ],        "plugins": {          "property1": {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            }          },          "property2": {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            }          }        }      },      "permissions": {        "management": {          "extend": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {      "dynamicContainerImageResources": [        "string"      ],      "dynamicContainerRepositories": [        "string"      ],      "id": "string",      "inputs": [        {          "default": {            "type": "string",            "value": "string"          },          "description": "string",          "env": [            {              "name": "string",              "targetResources": [                "string"              ],              "type": "plain"            }          ],          "generate": {            "length": 0          },          "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"            ]          }        }      ],      "operations": {        "custom": [          {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            },            "name": "string",            "version": "string"          }        ],        "plugins": {          "property1": {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            }          },          "property2": {            "approval": {              "property1": "auto",              "property2": "auto"            },            "settings": {              "property1": "string",              "property2": "string"            }          }        }      },      "permissions": {        "management": {          "extend": {            "property1": [              {                "description": "string",                "id": "string",                "platforms": {                  "aws": [                    {                      "binding": {                        "resource": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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": {}                          },                          "notResources": [                            "string"                          ],                          "resources": [                            "string"                          ]                        },                        "stack": {                          "condition": {                            "property1": {},                            "property2": {}                          },                          "notResources": [                            "string"                          ],                          "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"      ]    },    "registryAccess": {      "repositories": [        "string"      ],      "serviceTypes": [        "string"      ]    },    "registryAccessGranted": true,    "setupScaffolding": {      "property1": {        "buildRoleName": "string",        "egress": {          "connectorArn": "string",          "connectorRequest": "string",          "operatorRoleName": "string",          "securityGroupId": "string"        },        "imageArn": "string",        "type": "awsSandbox"      },      "property2": {        "buildRoleName": "string",        "egress": {          "connectorArn": "string",          "connectorRequest": "string",          "operatorRoleName": "string",          "securityGroupId": "string"        },        "imageArn": "string",        "type": "awsSandbox"      }    },    "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"    }  ],  "observedOperationsBundleHash": "string",  "observedOperations": [    {      "plugin": "string",      "pluginVersion": "string",      "name": "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  },  "updateState": {    "active": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "blocked",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "blocker": {        "kind": "input",        "message": "string",        "inputId": "string"      },      "actionRequired": "string",      "cause": {        "kind": "promotion",        "actor": {          "email": "string",          "id": "string",          "kind": "user",          "via": "mcp"        },        "at": "2019-08-24T14:15:22Z",        "channel": "string",        "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9"      },      "requestedAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    },    "next": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "blocked",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "blocker": {        "kind": "input",        "message": "string",        "inputId": "string"      },      "actionRequired": "string",      "cause": {        "kind": "promotion",        "actor": {          "email": "string",          "id": "string",          "kind": "user",          "via": "mcp"        },        "at": "2019-08-24T14:15:22Z",        "channel": "string",        "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9"      },      "requestedAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    },    "latest": {      "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",      "status": "blocked",      "reasons": [        "configuration"      ],      "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "changedKeys": [        "string"      ],      "blocker": {        "kind": "input",        "message": "string",        "inputId": "string"      },      "actionRequired": "string",      "cause": {        "kind": "promotion",        "actor": {          "email": "string",          "id": "string",          "kind": "user",          "via": "mcp"        },        "at": "2019-08-24T14:15:22Z",        "channel": "string",        "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9"      },      "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",  "customerKeyUnavailable": true}

Retry Deployment

POST
/v1/deployments/{id}/retry

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

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/retry"
{  "message": "string"}

Get Deployment Inputs

GET
/v1/deployments/{id}/inputs

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

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Response Body

application/json

application/json

application/json

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"        }      ],      "generate": {        "length": 0      },      "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

PATCH
/v1/deployments/{id}/inputs

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

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

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"        }      ],      "generate": {        "length": 0      },      "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": "blocked",    "reasons": [      "configuration"    ],    "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",    "changedKeys": [      "string"    ],    "blocker": {      "kind": "input",      "message": "string",      "inputId": "string"    },    "actionRequired": "string",    "cause": {      "kind": "promotion",      "actor": {        "email": "string",        "id": "string",        "kind": "user",        "via": "mcp"      },      "at": "2019-08-24T14:15:22Z",      "channel": "string",      "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9"    },    "requestedAt": "2019-08-24T14:15:22Z",    "startedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z"  }}
PATCH
/v1/deployments/{id}/compute

Update deployment-time compute selections or quota warning overrides and request reconciliation by the hosted manager.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/compute" \  -H "Content-Type: application/json" \  -d '{}'
{  "outcome": "accepted",  "operation": {    "id": "duop_0vtxpb1sw4sbcdwg2xo37q6",    "status": "blocked",    "reasons": [      "configuration"    ],    "targetReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",    "changedKeys": [      "string"    ],    "blocker": {      "kind": "input",      "message": "string",      "inputId": "string"    },    "actionRequired": "string",    "cause": {      "kind": "promotion",      "actor": {        "email": "string",        "id": "string",        "kind": "user",        "via": "mcp"      },      "at": "2019-08-24T14:15:22Z",      "channel": "string",      "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9"    },    "requestedAt": "2019-08-24T14:15:22Z",    "startedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z"  }}
PATCH
/v1/deployments/{id}/environment-variables

Replace a deployment's advanced environment variables. Stack-input-backed variables are write-only through the input endpoint. If the deployment is running and not locked, the status will be changed to update-pending to trigger a deployment.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request schema for updating deployment environment variables

Response Body

application/json

application/json

application/json

application/json

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"}
POST
/v1/deployments/{id}/installation

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/installation"
{  "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc",  "token": "string",  "runtimeEncryptionKey": "string",  "managementExternalId": "string",  "installation": {    "method": "cloudformation",    "region": "string",    "stackName": "string",    "launchUrl": "http://example.com",    "terraform": {      "target": "aws",      "hcl": "string",      "moduleDownloadUrl": "http://example.com",      "isAzureTarget": true    },    "helm": {      "command": "string",      "managerUrl": "http://example.com"    }  }}

Request Deployment Check

POST
/v1/deployments/{id}/check

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/check"
{  "requestedAt": "2019-08-24T14:15:22Z"}

Create Deployment Token

POST
/v1/deployments/{id}/token

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

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

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"}
GET
/v1/deployments/{id}/metrics-history

Metrics Horizon reported for each replica, from the deployment's heartbeats in [from, to): the latest sample per replica per bucket, with empty buckets as null. Kept for 30 days, best effort.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

Match^(?:ws_[0-9a-zA-Z]{24}|(?!ws[-_])[a-z0-9](-?[a-z0-9])*)$
Length4 <= length <= 100
from*string
Formatdate-time
to*string
Formatdate-time
service?string

Resource ID of the service.

Lengthlength <= 256
replica?string
Lengthlength <= 256

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/metrics-history?from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z"
{  "requiresFilter": true,  "bucketSeconds": 0,  "services": [    "string"  ],  "replicas": [    "string"  ],  "series": [    {      "resourceId": "string",      "replicaId": "string",      "points": [        {          "timestamp": "string",          "sample": {            "observedAt": "string",            "sourceAt": "string",            "metrics": {              "cpuPercent": 0,              "memoryBytes": 0,              "memoryPercent": 0,              "inFlightRequests": 0,              "requestsPerSecond": 0,              "status2xxPerSecond": 0,              "status4xxPerSecond": 0,              "status5xxPerSecond": 0,              "latencyP95Ms": 0,              "latencyP99Ms": 0            },            "payload": "string"          }        }      ]    }  ]}

List Deployment Machines

GET
/v1/deployments/{id}/machines

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/machines"
{  "machines": [    {      "clusterResourceId": "string",      "machineId": "string",      "status": "string",      "capacityGroup": "string",      "zone": "string",      "cpu": {        "allocated": 0,        "systemReserve": 0,        "total": 0      },      "memory": {        "allocated": 0,        "systemReserve": 0,        "total": 0      },      "storage": {        "allocated": 0,        "systemReserve": 0,        "total": 0      },      "drainBlockers": [        {          "reason": "string",          "workloadId": "string",          "workloadName": "string",          "replicaId": "string",          "schedulingMode": "string",          "state": "string"        }      ],      "drainDeadlineAt": "string",      "drainForce": true,      "drainRequestedAt": "string",      "drainedAt": "string",      "publicIp": "string",      "overlayIp": "string",      "lastHeartbeat": "string",      "horizondVersion": "string",      "networkHealth": "unknown",      "wireguardMesh": {        "expectedPeerCount": 0,        "reachablePeerCount": 0,        "missingPeerMachineIds": [          "string"        ]      },      "wireguardMeshObservedAt": "string",      "localOverrides": [        {          "activeDigest": "string",          "actor": "string",          "baseAssignmentHash": "string",          "baseDigest": "string",          "candidateDigest": "string",          "createdAt": "string",          "failureCategory": "string",          "fallbackDigest": "string",          "forcedStop": true,          "healthySince": "string",          "incidentId": "string",          "lifecycle": "string",          "phaseStartedAt": "string",          "replicaId": "string",          "workloadName": "string"        }      ],      "localOverridesObservedAt": "string",      "replicaCount": 0    }  ]}
GET
/v1/deployments/{id}/credential-rotation

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/credential-rotation"
{  "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc",  "revision": 0,  "rotation": {    "id": "string",    "revision": 1,    "status": "prepared",    "expiresAt": "string"  }}
POST
/v1/deployments/{id}/credential-rotation

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/credential-rotation" \  -H "Content-Type: application/json" \  -d '{    "expectedRevision": 0  }'
{  "id": "string",  "revision": 1,  "status": "prepared",  "expiresAt": "string"}
POST
/v1/deployments/{id}/credential-rotation/cancel

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/credential-rotation/cancel" \  -H "Content-Type: application/json" \  -d '{    "rotationId": "string"  }'
{  "id": "string",  "revision": 1,  "status": "prepared",  "expiresAt": "string"}
POST
/v1/deployments/{id}/credential-rotation/values

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/credential-rotation/values" \  -H "Content-Type: application/json" \  -d '{    "rotationId": "string"  }'
{  "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc",  "revision": 1,  "token": "string"}
GET
/v1/deployments/{id}/volume-restores

List a deployment's volume restore requests, newest first.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/volume-restores"
{  "items": [    {      "id": "vrst_rs1j4dytswpy7wbc819jdcx",      "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc",      "resourceId": "string",      "ordinal": 0,      "snapshotId": "string",      "status": "pending",      "createdBy": {        "email": "string",        "id": "string",        "kind": "user",        "via": "mcp"      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "cancelledAt": "2019-08-24T14:15:22Z"    }  ]}
POST
/v1/deployments/{id}/volume-restores

Replace one replica's persistent volume with a new volume made from a snapshot. The deployment must be running (an update may already be queued or in progress). The replica is stopped while its volume is swapped, and the replaced volume is snapshotted before it is deleted.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/volume-restores" \  -H "Content-Type: application/json" \  -d '{    "resourceId": "string",    "ordinal": 0,    "snapshotId": "string"  }'
{  "id": "vrst_rs1j4dytswpy7wbc819jdcx",  "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc",  "resourceId": "string",  "ordinal": 0,  "snapshotId": "string",  "status": "pending",  "createdBy": {    "email": "string",    "id": "string",    "kind": "user",    "via": "mcp"  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "cancelledAt": "2019-08-24T14:15:22Z"}
DELETE
/v1/deployments/{id}/volume-restores/{requestId}

Cancel a pending volume restore. Use it when a restore keeps failing: the deployment stops attempting it. A restore whose volume was already swapped still finishes. Allowed in any deployment status, including update-failed.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Unique identifier for the volume restore.

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

Query Parameters

workspace?string

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

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/volume-restores/vrst_rs1j4dytswpy7wbc819jdcx"
{  "id": "vrst_rs1j4dytswpy7wbc819jdcx",  "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc",  "resourceId": "string",  "ordinal": 0,  "snapshotId": "string",  "status": "pending",  "createdBy": {    "email": "string",    "id": "string",    "kind": "user",    "via": "mcp"  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "cancelledAt": "2019-08-24T14:15:22Z"}