Setup Links

Create a customer setup link

Ensures the Deployment Group identified by Project and external ID, then creates a replacement group-scoped setup link with exact captured sources.

Authorization

apiKey

AuthorizationBearer <token>

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

In: header

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

externalId*string

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

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

Length1 <= length <= 128

name*string

Deployment group name.

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

Length2 <= length <= 100

project*string

Project ID or name this deployment group belongs to

Lengthlength <= 100

maxDeployments?integer

Maximum number of deployments for newly created groups

Range1 <= value

Default100

description?string

Description for the API key

expiresAt?|

Optional expiration date for the API key

Formatdate-time

deploymentSetupConfig*

setupItems?array<>

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

Itemsitems <= 8

inputValues?

Default{}

Response Body

`application/json`

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

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

Create a customer setup link

Authorization

Query Parameters

Request Body

Response Body

200application/json

400application/json

404application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`