Remote Operator install

Prepare the white-labeled Operator image for an Operate install

Authorization

AuthorizationBearer <token>

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

In: header

Query Parameters

workspace?string

Workspace name 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.

project*ProjectIDOrNameQueryParam

Filter by project ID or name.

Lengthlength <= 100

`application/json`

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

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

Render a Kubernetes Operator manifest

Authorization

AuthorizationBearer <token>

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

In: header

Query Parameters

workspace?string

Workspace name 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.

project*ProjectIDOrNameQueryParam

Filter by project ID or name.

Lengthlength <= 100

format?string

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

Default"raw"

Value in

"raw"
"helm"

environmentName?string

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

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

Length4 <= length <= 100

namespace?string

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

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

Length1 <= length <= 63

scope?string

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

Default"namespace"

Value in

"namespace"
"cluster"

labelSelector?string

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

Length1 <= length <= 256

permission?string

Operator permission tier

Default"diagnostics"

Value in

"diagnostics"
"remediation"

operatorImagePackageId?string

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

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

deploymentGroupToken*string

Deployment-group token embedded in the operator Secret

Length1 <= length

logCollector?

Enable the node log collector DaemonSet for raw pod logs.

stackSettings?

User-customizable deployment settings specified at deploy time.

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

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

`application/json`

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

{  "manifest": "string",  "applyCommand": "string",  "filename": "string",  "managerUrl": "http://example.com",  "imagePending": true,  "operatorImage": {    "source": "package",    "packageId": "string",    "packageVersion": "string",    "image": "string",    "digest": "string",    "renderedAt": "2019-08-24T14:15:22Z"  }}

Render a Remote Operator ECS Fargate CloudFormation installer

Renders a credential-free CloudFormation artifact that reuses a customer-owned ECS cluster and network; creates retained EFS identity storage unless an existing filesystem and access point are supplied; owns a task role compiled from every built-in operation plugin; and uses a generated local command to hand one-time setup material directly to same-account, same-Region Secrets Manager. Sensitive S3 and SQS wildcard declarations fail closed unless the request supplies exact resource ceilings.

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.

project*ProjectIDOrNameQueryParam

Filter by project ID or name.

Lengthlength <= 100

environmentName*string

Stable per-environment Remote Operator installation name

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

Length2 <= length <= 100

permission?string

Operator permission tier

Default"diagnostics"

Value in

"diagnostics"
"remediation"

accountId*string

Exact AWS account that owns the Remote Operator stack

Match^[0-9]{12}$

region*string

Exact AWS Region for the Remote Operator stack

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

clusterArn*string

Exact ARN of the customer-owned ECS cluster

Match^arn:(aws|aws-cn|aws-us-gov):ecs:[a-z]{2}(?:-gov)?-[a-z]+-[0-9]:[0-9]{12}:cluster\/[A-Za-z0-9_-]{1,255}$

subnetIds*array<>

Items1 <= items <= 16

securityGroupIds*array<>

Items1 <= items <= 16

assignPublicIp?string

Default"DISABLED"

Value in

"DISABLED"
"ENABLED"

efsFileSystemId?string

Existing EFS filesystem ID for the Operator identity. Omit it, with efsAccessPointId, to have the stack create retained EFS storage.

Match^fs-(?:[0-9a-f]{8}|[0-9a-f]{17})$

efsAccessPointId?string

Existing EFS access point ID (POSIX UID and GID 1000) on efsFileSystemId. Supply it together with efsFileSystemId.

Match^fsap-(?:[0-9a-f]{8}|[0-9a-f]{17})$

operatorImagePackageId?string

Ready operator-image package to pin in the task definition. If omitted, the current project package is prepared or reused.

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

s3BucketArns?array<>

Installer-owned S3 ceiling. Required when S3 operations need ListBucket or GetObject; the generated role contains only these bucket and object ARNs.

Itemsitems <= 50

Default[]

sqsQueueArns?array<>

Installer-owned SQS ceiling. Required when SQS operations read queue attributes; the generated role contains only these queue ARNs.

Itemsitems <= 50

Default[]

Response Body

`application/json`

curl -X POST "https://example.com/v1/operator-manifests/ecs-cloudformation/render" \  -H "Content-Type: application/json" \  -d '{    "project": "string",    "environmentName": "string",    "accountId": "string",    "region": "string",    "clusterArn": "string",    "subnetIds": [      "string"    ],    "securityGroupIds": [      "string"    ]  }'

{  "template": "string",  "filename": "string",  "stackName": "string",  "deployCommand": "string",  "managerUrl": "http://example.com",  "image": "string",  "imagePending": true,  "operatorImage": {    "source": "package",    "packageId": "string",    "packageVersion": "string",    "image": "string",    "digest": "string",    "renderedAt": "2019-08-24T14:15:22Z"  }}

Prepare the white-labeled Operator image for an Operate installCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

404application/json

500application/json

Render a Kubernetes Operator manifestCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

404application/json

409application/json

500application/json

Render a Remote Operator ECS Fargate CloudFormation installerCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

403application/json

404application/json

409application/json

422application/json

500application/json

Prepare the white-labeled Operator image for an Operate install

Authorization

Query Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

Render a Kubernetes Operator manifest

Authorization

Query Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Render a Remote Operator ECS Fargate CloudFormation installer

Authorization

Query Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`