Docs

Machines

List Machines Join Tokens

GET
/v1/machines/deployments/{id}/join-tokens

Authorization

apiKey
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

Match^(?!ws[-_])[a-z0-9](-?[a-z0-9])*$
Length4 <= length <= 100

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/machines/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/join-tokens"
{  "tokens": [    {      "id": "string",      "createdAt": "string",      "createdBy": "string",      "expiresAt": "string",      "maxJoins": 0,      "joinCount": 0,      "lastUsedAt": "string",      "revokedAt": "string"    }  ]}

Create Machines Join Token

POST
/v1/machines/deployments/{id}/join-tokens

Authorization

apiKey
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

Match^(?!ws[-_])[a-z0-9](-?[a-z0-9])*$
Length4 <= length <= 100

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/machines/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/join-tokens"
{  "joinToken": "string",  "controlPlaneUrl": "http://example.com",  "clusterId": "string",  "token": {    "id": "string",    "createdAt": "string",    "createdBy": "string",    "expiresAt": "string",    "maxJoins": 0,    "joinCount": 0,    "lastUsedAt": "string",    "revokedAt": "string"  },  "cliInstallScriptUrl": "http://example.com",  "cliCommandName": "string"}

Rotate Machines Join Token

POST
/v1/machines/deployments/{id}/join-tokens/rotate

Authorization

apiKey
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

Match^(?!ws[-_])[a-z0-9](-?[a-z0-9])*$
Length4 <= length <= 100

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/machines/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/join-tokens/rotate"
{  "joinToken": "string",  "controlPlaneUrl": "http://example.com",  "clusterId": "string",  "token": {    "id": "string",    "createdAt": "string",    "createdBy": "string",    "expiresAt": "string",    "maxJoins": 0,    "joinCount": 0,    "lastUsedAt": "string",    "revokedAt": "string"  },  "cliInstallScriptUrl": "http://example.com",  "cliCommandName": "string"}

Revoke Machines Join Token

DELETE
/v1/machines/deployments/{id}/join-tokens/{tokenId}

Authorization

apiKey
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

Matchdep_[0-9a-z]{28}$
tokenId*string
Length1 <= length

Query Parameters

workspace?string

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

Match^(?!ws[-_])[a-z0-9](-?[a-z0-9])*$
Length4 <= length <= 100

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/machines/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/join-tokens/string"
{  "tokenId": "string",  "revoked": true}

List Machines Inventory

GET
/v1/machines/deployments/{id}/inventory

Authorization

apiKey
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

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

Query Parameters

workspace?string

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

Match^(?!ws[-_])[a-z0-9](-?[a-z0-9])*$
Length4 <= length <= 100

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/machines/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/inventory"
{  "machines": [    {      "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    }  ]}

Drain Machines Machine

POST
/v1/machines/deployments/{id}/machines/{machineId}/drain

Authorization

apiKey
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

Matchdep_[0-9a-z]{28}$
machineId*string
Length1 <= length

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.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/machines/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/machines/string/drain" \  -H "Content-Type: application/json" \  -d '{}'
{  "machineId": "string",  "requested": true}

Cancel Machines Machine Drain

DELETE
/v1/machines/deployments/{id}/machines/{machineId}/drain

Authorization

apiKey
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

Matchdep_[0-9a-z]{28}$
machineId*string
Length1 <= length

Query Parameters

workspace?string

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

Match^(?!ws[-_])[a-z0-9](-?[a-z0-9])*$
Length4 <= length <= 100

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/machines/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/machines/string/drain"
{  "machineId": "string",  "cancelled": true}

Remove Machines Machine

DELETE
/v1/machines/deployments/{id}/machines/{machineId}

Authorization

apiKey
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for the deployment.

Matchdep_[0-9a-z]{28}$
machineId*string
Length1 <= length

Query Parameters

workspace?string

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

Match^(?!ws[-_])[a-z0-9](-?[a-z0-9])*$
Length4 <= length <= 100

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/machines/deployments/dep_0c29fq4a2yjb7kx3smwdgxlc/machines/string"
{  "machineId": "string",  "removed": true}

Events

Previous Page

Commands

Next Page