Managers

List Managers

Retrieve all managers.

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

search?string

Search managers by name

Lengthlength <= 256

limit?integer

Maximum number of managers to return

Range1 <= value <= 100

Response Body

`application/json`

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

[  {    "id": "mgr_enxscjrqiiu2lrc672hwwuc5",    "name": "string",    "targets": [      "aws"    ],    "cloud": "aws",    "region": "string",    "setupStatus": "pending",    "url": "http://example.com",    "managementConfigs": {      "aws": {        "managingRoleArn": "string",        "platform": "aws"      },      "gcp": {        "serviceAccountEmail": "string",        "platform": "gcp"      },      "azure": {        "managingTenantId": "string",        "oidcIssuer": "string",        "oidcSubject": "string",        "platform": "azure"      },      "kubernetes": {        "platform": "kubernetes"      }    },    "isSystem": true,    "workspaceId": "string",    "status": "healthy",    "version": "string",    "metrics": {      "activeDeployments": 0,      "pendingDeployments": 0,      "memoryUsageMb": 0,      "cpuUsagePercent": 0    },    "lastHeartbeatAt": "2019-08-24T14:15:22Z",    "logsDatabaseId": "string",    "managedDeploymentCount": 0,    "defaultProjectCount": 0,    "createdAt": "2019-08-24T14:15:22Z"  }]

Create Manager

Create a new manager.

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.

name*string

cloud*PrivateManagerCloud

Cloud where the private manager will be deployed.

Value in

"aws"
"gcp"
"azure"

region*string

Cloud region for the manager.

Length1 <= length <= 64

setupMethod?PrivateManagerSetupMethod

Optional setup method. Defaults to cloudformation for AWS, google-oauth for GCP, and terraform for Azure.

Value in

"cloudformation"
"google-oauth"
"terraform"

network?string

Optional network mode for the private-manager setup. Defaults to create for production isolation; default uses the provider default network for faster dev/test setup.

Value in

"create"
"default"

otlpConfig?

Optional external OTLP config for forwarding logs to Axiom, Datadog, etc. Falls back to built-in DeepStore when not set.

Response Body

`application/json`

curl -X POST "https://example.com/v1/managers" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "cloud": "aws",    "region": "string"  }'

{  "managerId": "mgr_enxscjrqiiu2lrc672hwwuc5",  "setupStatus": "pending",  "setupToken": "string",  "setupTokenId": "string",  "deploymentLink": "string",  "setupConfig": {    "metadata": {      "property1": null,      "property2": null    },    "policy": {      "allowedPlatforms": [        "aws"      ],      "allowedKubernetesBasePlatforms": [        "aws"      ],      "allowedKubernetesClusterSources": [        "create"      ],      "allowedSetupMethods": [        "cloudformation"      ],      "allowReleasePinning": true,      "stackSettings": {        "defaults": {          "compute": {            "pools": {              "property1": {                "failure_domains": {                  "selectedFailureDomains": [                    "string"                  ],                  "spread": 0                },                "machine": "string",                "machines": 0,                "mode": "fixed"              },              "property2": {                "failure_domains": {                  "selectedFailureDomains": [                    "string"                  ],                  "spread": 0                },                "machine": "string",                "machines": 0,                "mode": "fixed"              }            }          },          "deploymentModel": "push",          "domains": {            "customDomains": {              "property1": {                "certificate": {                  "aws": {                    "certificateArn": "string"                  },                  "azure": {                    "keyVaultCertificateId": "string",                    "keyVaultResourceId": "string"                  },                  "gcp": {                    "certificateName": "string"                  },                  "kubernetes": {                    "tlsSecretRef": {                      "namespace": "string",                      "secretName": "string"                    }                  }                },                "domain": "string"              },              "property2": {                "certificate": {                  "aws": {                    "certificateArn": "string"                  },                  "azure": {                    "keyVaultCertificateId": "string",                    "keyVaultResourceId": "string"                  },                  "gcp": {                    "certificateName": "string"                  },                  "kubernetes": {                    "tlsSecretRef": {                      "namespace": "string",                      "secretName": "string"                    }                  }                },                "domain": "string"              }            },            "publicEndpointTarget": {              "mode": "machineAddresses"            }          },          "externalBindings": {},          "heartbeats": "off",          "kubernetes": {            "cluster": {              "cloud": {                "accountId": "string",                "clusterId": "string",                "clusterName": "string",                "projectId": "string",                "region": "string",                "resourceGroup": "string",                "subscriptionId": "string"              },              "namespace": "string",              "ownership": "managed"            },            "exposure": {              "mode": "disabled"            }          },          "network": {            "type": "use-default"          },          "telemetry": "off",          "updates": "auto"        },        "allowedDeploymentModels": [          "push"        ],        "allowedNetworkModes": [          "none"        ],        "allowedUpdatesModes": [          "auto"        ],        "allowedTelemetryModes": [          "auto"        ],        "allowedHeartbeatsModes": [          "on"        ],        "allowExternalBindings": true,        "allowCustomRegistry": true      }    },    "inputValues": {},    "items": [      {        "item": "deployment",        "source": {          "type": "project-release",          "releaseChannel": "string",          "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",          "resourceId": "string"        },        "required": true,        "configuration": {          "allowedProviders": [            "aws-bedrock"          ],          "providerAllowlist": [            "aws-bedrock"          ],          "modelRequirements": [            {              "publicModelId": "string",              "clientApis": [                "openai-chat"              ],              "required": true            }          ]        }      }    ],    "publicSubdomain": "string",    "environmentVariables": [      {        "name": "string",        "type": "plain",        "targetResources": [          "string"        ]      }    ]  },  "setup": {    "method": "cloudformation",    "deploymentPortalUrl": "string",    "launchUrl": "string",    "templateUrl": "string",    "stackName": "string",    "region": "string",    "stackSettings": {      "compute": {        "pools": {          "property1": {            "failure_domains": {              "selectedFailureDomains": [                "string"              ],              "spread": 0            },            "machine": "string",            "machines": 0,            "mode": "fixed"          },          "property2": {            "failure_domains": {              "selectedFailureDomains": [                "string"              ],              "spread": 0            },            "machine": "string",            "machines": 0,            "mode": "fixed"          }        }      },      "deploymentModel": "push",      "domains": {        "customDomains": {          "property1": {            "certificate": {              "aws": {                "certificateArn": "string"              },              "azure": {                "keyVaultCertificateId": "string",                "keyVaultResourceId": "string"              },              "gcp": {                "certificateName": "string"              },              "kubernetes": {                "tlsSecretRef": {                  "namespace": "string",                  "secretName": "string"                }              }            },            "domain": "string"          },          "property2": {            "certificate": {              "aws": {                "certificateArn": "string"              },              "azure": {                "keyVaultCertificateId": "string",                "keyVaultResourceId": "string"              },              "gcp": {                "certificateName": "string"              },              "kubernetes": {                "tlsSecretRef": {                  "namespace": "string",                  "secretName": "string"                }              }            },            "domain": "string"          }        },        "publicEndpointTarget": {          "mode": "machineAddresses"        }      },      "externalBindings": {},      "heartbeats": "off",      "kubernetes": {        "cluster": {          "cloud": {            "accountId": "string",            "clusterId": "string",            "clusterName": "string",            "projectId": "string",            "region": "string",            "resourceGroup": "string",            "subscriptionId": "string"          },          "namespace": "string",          "ownership": "managed"        },        "exposure": {          "mode": "disabled"        }      },      "network": {        "type": "use-default"      },      "telemetry": "off",      "updates": "auto"    }  }}

Retry Manager Setup

Revoke previous private-manager setup tokens and issue a fresh setup token/config.

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 a manager.

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

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Response Body

`application/json`

curl -X POST "https://example.com/v1/managers/mgr_enxscjrqiiu2lrc672hwwuc5/setup-token"

{  "managerId": "mgr_enxscjrqiiu2lrc672hwwuc5",  "setupStatus": "pending",  "setupToken": "string",  "setupTokenId": "string",  "deploymentLink": "string",  "setupConfig": {    "metadata": {      "property1": null,      "property2": null    },    "policy": {      "allowedPlatforms": [        "aws"      ],      "allowedKubernetesBasePlatforms": [        "aws"      ],      "allowedKubernetesClusterSources": [        "create"      ],      "allowedSetupMethods": [        "cloudformation"      ],      "allowReleasePinning": true,      "stackSettings": {        "defaults": {          "compute": {            "pools": {              "property1": {                "failure_domains": {                  "selectedFailureDomains": [                    "string"                  ],                  "spread": 0                },                "machine": "string",                "machines": 0,                "mode": "fixed"              },              "property2": {                "failure_domains": {                  "selectedFailureDomains": [                    "string"                  ],                  "spread": 0                },                "machine": "string",                "machines": 0,                "mode": "fixed"              }            }          },          "deploymentModel": "push",          "domains": {            "customDomains": {              "property1": {                "certificate": {                  "aws": {                    "certificateArn": "string"                  },                  "azure": {                    "keyVaultCertificateId": "string",                    "keyVaultResourceId": "string"                  },                  "gcp": {                    "certificateName": "string"                  },                  "kubernetes": {                    "tlsSecretRef": {                      "namespace": "string",                      "secretName": "string"                    }                  }                },                "domain": "string"              },              "property2": {                "certificate": {                  "aws": {                    "certificateArn": "string"                  },                  "azure": {                    "keyVaultCertificateId": "string",                    "keyVaultResourceId": "string"                  },                  "gcp": {                    "certificateName": "string"                  },                  "kubernetes": {                    "tlsSecretRef": {                      "namespace": "string",                      "secretName": "string"                    }                  }                },                "domain": "string"              }            },            "publicEndpointTarget": {              "mode": "machineAddresses"            }          },          "externalBindings": {},          "heartbeats": "off",          "kubernetes": {            "cluster": {              "cloud": {                "accountId": "string",                "clusterId": "string",                "clusterName": "string",                "projectId": "string",                "region": "string",                "resourceGroup": "string",                "subscriptionId": "string"              },              "namespace": "string",              "ownership": "managed"            },            "exposure": {              "mode": "disabled"            }          },          "network": {            "type": "use-default"          },          "telemetry": "off",          "updates": "auto"        },        "allowedDeploymentModels": [          "push"        ],        "allowedNetworkModes": [          "none"        ],        "allowedUpdatesModes": [          "auto"        ],        "allowedTelemetryModes": [          "auto"        ],        "allowedHeartbeatsModes": [          "on"        ],        "allowExternalBindings": true,        "allowCustomRegistry": true      }    },    "inputValues": {},    "items": [      {        "item": "deployment",        "source": {          "type": "project-release",          "releaseChannel": "string",          "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",          "resourceId": "string"        },        "required": true,        "configuration": {          "allowedProviders": [            "aws-bedrock"          ],          "providerAllowlist": [            "aws-bedrock"          ],          "modelRequirements": [            {              "publicModelId": "string",              "clientApis": [                "openai-chat"              ],              "required": true            }          ]        }      }    ],    "publicSubdomain": "string",    "environmentVariables": [      {        "name": "string",        "type": "plain",        "targetResources": [          "string"        ]      }    ]  },  "setup": {    "method": "cloudformation",    "deploymentPortalUrl": "string",    "launchUrl": "string",    "templateUrl": "string",    "stackName": "string",    "region": "string",    "stackSettings": {      "compute": {        "pools": {          "property1": {            "failure_domains": {              "selectedFailureDomains": [                "string"              ],              "spread": 0            },            "machine": "string",            "machines": 0,            "mode": "fixed"          },          "property2": {            "failure_domains": {              "selectedFailureDomains": [                "string"              ],              "spread": 0            },            "machine": "string",            "machines": 0,            "mode": "fixed"          }        }      },      "deploymentModel": "push",      "domains": {        "customDomains": {          "property1": {            "certificate": {              "aws": {                "certificateArn": "string"              },              "azure": {                "keyVaultCertificateId": "string",                "keyVaultResourceId": "string"              },              "gcp": {                "certificateName": "string"              },              "kubernetes": {                "tlsSecretRef": {                  "namespace": "string",                  "secretName": "string"                }              }            },            "domain": "string"          },          "property2": {            "certificate": {              "aws": {                "certificateArn": "string"              },              "azure": {                "keyVaultCertificateId": "string",                "keyVaultResourceId": "string"              },              "gcp": {                "certificateName": "string"              },              "kubernetes": {                "tlsSecretRef": {                  "namespace": "string",                  "secretName": "string"                }              }            },            "domain": "string"          }        },        "publicEndpointTarget": {          "mode": "machineAddresses"        }      },      "externalBindings": {},      "heartbeats": "off",      "kubernetes": {        "cluster": {          "cloud": {            "accountId": "string",            "clusterId": "string",            "clusterName": "string",            "projectId": "string",            "region": "string",            "resourceGroup": "string",            "subscriptionId": "string"          },          "namespace": "string",          "ownership": "managed"        },        "exposure": {          "mode": "disabled"        }      },      "network": {        "type": "use-default"      },      "telemetry": "off",      "updates": "auto"    }  }}

Retry Manager

Retry private-manager setup. Returns a fresh setup action before the internal deployment exists, or requests retry for the internal deployment after it exists.

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 a manager.

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

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Response Body

`application/json`

curl -X POST "https://example.com/v1/managers/mgr_enxscjrqiiu2lrc672hwwuc5/retry"

{  "managerId": "mgr_enxscjrqiiu2lrc672hwwuc5",  "setupStatus": "pending",  "setupToken": "string",  "setupTokenId": "string",  "deploymentLink": "string",  "setupConfig": {    "metadata": {      "property1": null,      "property2": null    },    "policy": {      "allowedPlatforms": [        "aws"      ],      "allowedKubernetesBasePlatforms": [        "aws"      ],      "allowedKubernetesClusterSources": [        "create"      ],      "allowedSetupMethods": [        "cloudformation"      ],      "allowReleasePinning": true,      "stackSettings": {        "defaults": {          "compute": {            "pools": {              "property1": {                "failure_domains": {                  "selectedFailureDomains": [                    "string"                  ],                  "spread": 0                },                "machine": "string",                "machines": 0,                "mode": "fixed"              },              "property2": {                "failure_domains": {                  "selectedFailureDomains": [                    "string"                  ],                  "spread": 0                },                "machine": "string",                "machines": 0,                "mode": "fixed"              }            }          },          "deploymentModel": "push",          "domains": {            "customDomains": {              "property1": {                "certificate": {                  "aws": {                    "certificateArn": "string"                  },                  "azure": {                    "keyVaultCertificateId": "string",                    "keyVaultResourceId": "string"                  },                  "gcp": {                    "certificateName": "string"                  },                  "kubernetes": {                    "tlsSecretRef": {                      "namespace": "string",                      "secretName": "string"                    }                  }                },                "domain": "string"              },              "property2": {                "certificate": {                  "aws": {                    "certificateArn": "string"                  },                  "azure": {                    "keyVaultCertificateId": "string",                    "keyVaultResourceId": "string"                  },                  "gcp": {                    "certificateName": "string"                  },                  "kubernetes": {                    "tlsSecretRef": {                      "namespace": "string",                      "secretName": "string"                    }                  }                },                "domain": "string"              }            },            "publicEndpointTarget": {              "mode": "machineAddresses"            }          },          "externalBindings": {},          "heartbeats": "off",          "kubernetes": {            "cluster": {              "cloud": {                "accountId": "string",                "clusterId": "string",                "clusterName": "string",                "projectId": "string",                "region": "string",                "resourceGroup": "string",                "subscriptionId": "string"              },              "namespace": "string",              "ownership": "managed"            },            "exposure": {              "mode": "disabled"            }          },          "network": {            "type": "use-default"          },          "telemetry": "off",          "updates": "auto"        },        "allowedDeploymentModels": [          "push"        ],        "allowedNetworkModes": [          "none"        ],        "allowedUpdatesModes": [          "auto"        ],        "allowedTelemetryModes": [          "auto"        ],        "allowedHeartbeatsModes": [          "on"        ],        "allowExternalBindings": true,        "allowCustomRegistry": true      }    },    "inputValues": {},    "items": [      {        "item": "deployment",        "source": {          "type": "project-release",          "releaseChannel": "string",          "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",          "resourceId": "string"        },        "required": true,        "configuration": {          "allowedProviders": [            "aws-bedrock"          ],          "providerAllowlist": [            "aws-bedrock"          ],          "modelRequirements": [            {              "publicModelId": "string",              "clientApis": [                "openai-chat"              ],              "required": true            }          ]        }      }    ],    "publicSubdomain": "string",    "environmentVariables": [      {        "name": "string",        "type": "plain",        "targetResources": [          "string"        ]      }    ]  },  "setup": {    "method": "cloudformation",    "deploymentPortalUrl": "string",    "launchUrl": "string",    "templateUrl": "string",    "stackName": "string",    "region": "string",    "stackSettings": {      "compute": {        "pools": {          "property1": {            "failure_domains": {              "selectedFailureDomains": [                "string"              ],              "spread": 0            },            "machine": "string",            "machines": 0,            "mode": "fixed"          },          "property2": {            "failure_domains": {              "selectedFailureDomains": [                "string"              ],              "spread": 0            },            "machine": "string",            "machines": 0,            "mode": "fixed"          }        }      },      "deploymentModel": "push",      "domains": {        "customDomains": {          "property1": {            "certificate": {              "aws": {                "certificateArn": "string"              },              "azure": {                "keyVaultCertificateId": "string",                "keyVaultResourceId": "string"              },              "gcp": {                "certificateName": "string"              },              "kubernetes": {                "tlsSecretRef": {                  "namespace": "string",                  "secretName": "string"                }              }            },            "domain": "string"          },          "property2": {            "certificate": {              "aws": {                "certificateArn": "string"              },              "azure": {                "keyVaultCertificateId": "string",                "keyVaultResourceId": "string"              },              "gcp": {                "certificateName": "string"              },              "kubernetes": {                "tlsSecretRef": {                  "namespace": "string",                  "secretName": "string"                }              }            },            "domain": "string"          }        },        "publicEndpointTarget": {          "mode": "machineAddresses"        }      },      "externalBindings": {},      "heartbeats": "off",      "kubernetes": {        "cluster": {          "cloud": {            "accountId": "string",            "clusterId": "string",            "clusterName": "string",            "projectId": "string",            "region": "string",            "resourceGroup": "string",            "subscriptionId": "string"          },          "namespace": "string",          "ownership": "managed"        },        "exposure": {          "mode": "disabled"        }      },      "network": {        "type": "use-default"      },      "telemetry": "off",      "updates": "auto"    }  },  "mode": "setup"}

Cancel Manager Setup

Cancel pending private-manager setup, revoke setup/runtime tokens, and remove the undeployed manager record.

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 a manager.

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

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Response Body

`application/json`

curl -X POST "https://example.com/v1/managers/mgr_enxscjrqiiu2lrc672hwwuc5/cancel-setup"

{  "message": "string"}

Get Manager

Retrieve a manager by ID.

Authorization

apiKey

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for a manager.

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

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Response Body

`application/json`

curl -X GET "https://example.com/v1/managers/mgr_enxscjrqiiu2lrc672hwwuc5"

{  "id": "mgr_enxscjrqiiu2lrc672hwwuc5",  "name": "string",  "targets": [    "aws"  ],  "cloud": "aws",  "region": "string",  "setupStatus": "pending",  "url": "http://example.com",  "managementConfigs": {    "aws": {      "managingRoleArn": "string",      "platform": "aws"    },    "gcp": {      "serviceAccountEmail": "string",      "platform": "gcp"    },    "azure": {      "managingTenantId": "string",      "oidcIssuer": "string",      "oidcSubject": "string",      "platform": "azure"    },    "kubernetes": {      "platform": "kubernetes"    }  },  "isSystem": true,  "workspaceId": "string",  "status": "healthy",  "version": "string",  "metrics": {    "activeDeployments": 0,    "pendingDeployments": 0,    "memoryUsageMb": 0,    "cpuUsagePercent": 0  },  "lastHeartbeatAt": "2019-08-24T14:15:22Z",  "logsDatabaseId": "string",  "managedDeploymentCount": 0,  "defaultProjectCount": 0,  "createdAt": "2019-08-24T14:15:22Z"}

Delete Manager

Delete a manager by ID.

Authorization

apiKey

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for a manager.

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

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/managers/mgr_enxscjrqiiu2lrc672hwwuc5"

{  "message": "string"}

Get Manager Domain Binding

Get the custom domain binding for a private manager.

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 a manager.

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

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Response Body

`application/json`

curl -X GET "https://example.com/v1/managers/mgr_enxscjrqiiu2lrc672hwwuc5/domain-binding"

{  "managerDomainBinding": {    "id": "dend_1bb6gdvm1bs74acqkjstcgv",    "workspaceId": "ws_It13CUaGEhLLAB87simX0",    "domainId": "dom_469m0agk8luj4s16sakmmpdd",    "kind": "deployment_portal",    "owner": {      "type": "workspace",      "id": "string"    },    "hostname": "string",    "status": "waiting_for_domain",    "provider": "string",    "providerState": {      "property1": null,      "property2": null    },    "managedDnsRecords": [      {        "name": "string",        "type": "string",        "value": "string",        "ttl": 1      }    ],    "error": {      "code": "string",      "context": null,      "hint": "string",      "httpStatusCode": 100,      "internal": true,      "message": "string",      "retryable": false,      "source": null    },    "lockedAt": "2019-08-24T14:15:22Z",    "lockedBy": "string",    "retryAttempts": 0,    "nextStepAfter": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Update Manager Domain Binding

Create, update, or remove the custom domain binding for a private manager.

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 a manager.

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

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

domainId?|

Unique identifier for the domain.

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

Response Body

`application/json`

curl -X PUT "https://example.com/v1/managers/mgr_enxscjrqiiu2lrc672hwwuc5/domain-binding" \  -H "Content-Type: application/json" \  -d '{}'

{  "managerDomainBinding": {    "id": "dend_1bb6gdvm1bs74acqkjstcgv",    "workspaceId": "ws_It13CUaGEhLLAB87simX0",    "domainId": "dom_469m0agk8luj4s16sakmmpdd",    "kind": "deployment_portal",    "owner": {      "type": "workspace",      "id": "string"    },    "hostname": "string",    "status": "waiting_for_domain",    "provider": "string",    "providerState": {      "property1": null,      "property2": null    },    "managedDnsRecords": [      {        "name": "string",        "type": "string",        "value": "string",        "ttl": 1      }    ],    "error": {      "code": "string",      "context": null,      "hint": "string",      "httpStatusCode": 100,      "internal": true,      "message": "string",      "retryable": false,      "source": null    },    "lockedAt": "2019-08-24T14:15:22Z",    "lockedBy": "string",    "retryAttempts": 0,    "nextStepAfter": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Get Manager Management Config

Get the management configuration for a manager.

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 a manager.

Matchmgr_[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

platform*string

Represents the target cloud platform.

Value in

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

Response Body

`application/json`

curl -X GET "https://example.com/v1/managers/mgr_enxscjrqiiu2lrc672hwwuc5/management-config?platform=aws"

{  "managingRoleArn": "string",  "platform": "aws"}

Provision Manager

Enqueue provisioning for a manager by ID.

Authorization

apiKey

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for a manager.

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

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Response Body

`application/json`

curl -X POST "https://example.com/v1/managers/mgr_enxscjrqiiu2lrc672hwwuc5/provision"

{  "message": "string"}

Update Manager

Update a manager to a specific release ID or active release.

Authorization

apiKey

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Unique identifier for a manager.

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

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request schema for updating a manager to a new release

releaseId?|

Optional release ID to update to. If not provided, the active release will be chosen

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

Response Body

`application/json`

curl -X POST "https://example.com/v1/managers/mgr_enxscjrqiiu2lrc672hwwuc5/update" \  -H "Content-Type: application/json" \  -d '{}'

{  "message": "string"}

List Manager Events

Retrieve all events of a manager.

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

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Response Body

`application/json`

curl -X GET "https://example.com/v1/managers/string/events"

{  "items": [    {      "id": "event_MtSA24M3pWuAkQYxgZxuRI",      "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc",      "releaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",      "debugSessionId": "dbg_HOXmkmT9UPYlsnxqSNlEGoXL",      "data": {        "type": "LoadingConfiguration"      },      "state": {        "failed": {          "error": {            "code": "string",            "context": null,            "hint": "string",            "httpStatusCode": 100,            "internal": true,            "message": "string",            "retryable": false,            "source": null          }        }      },      "projectId": "prj_mcytp6z3j91f7tn5ryqsfwtr",      "createdAt": "2019-08-24T14:15:22Z",      "workspaceId": "ws_It13CUaGEhLLAB87simX0"    }  ]}

Generate Manager Token

Generate a short-lived JWT for direct browser → manager communication. Used for fetching command payloads and querying logs without routing sensitive data through the platform API.

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 a manager.

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

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

project*string

Project ID or name to scope token access to.

Lengthlength <= 100

Response Body

`application/json`

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

{  "accessToken": "string",  "expiresIn": 0,  "tokenType": "Bearer",  "managerUrl": "string",  "databaseId": "string",  "controlPlaneUrl": "string"}

Generate Manager Binding Token

Generate a short-lived deployment-scoped token for resolving opted-in remote bindings through the currently assigned manager.

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 a manager.

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

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

deploymentId*string

Unique identifier for the deployment.

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

Response Body

`application/json`

curl -X POST "https://example.com/v1/managers/mgr_enxscjrqiiu2lrc672hwwuc5/binding-token" \  -H "Content-Type: application/json" \  -d '{    "deploymentId": "dep_0c29fq4a2yjb7kx3smwdgxlc"  }'

{  "accessToken": "string",  "expiresIn": 0,  "tokenType": "Bearer",  "managerUrl": "string"}

Resolve Manager GCP OAuth Provider

Resolve decrypted project-level Google Cloud OAuth provider settings for a manager-side deployment bootstrap.

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 a manager.

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

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

deploymentGroupToken*string

Deployment-group bearer token whose project-level OAuth provider should be resolved.

Length1 <= length

returnOrigin?string

Browser origin that will receive the Google OAuth callback result. Must be a first-party dashboard origin or the active portal origin for the deployment group's project.

Formaturi

Response Body

`application/json`

curl -X POST "https://example.com/v1/managers/mgr_enxscjrqiiu2lrc672hwwuc5/gcp-oauth-provider/resolve" \  -H "Content-Type: application/json" \  -d '{    "deploymentGroupToken": "string"  }'

{  "mode": "alien-managed"}

Report Manager Heartbeat

Report Manager health status and metrics.

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 a manager.

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

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

status*string

Current health status

Value in

"healthy"
"degraded"
"unhealthy"

version?string

Manager version

url*string

Manager public URL (for accessing DeepStore endpoints)

Formaturi

managementConfigs*

metrics?

Optional runtime metrics

Response Body

`application/json`

curl -X POST "https://example.com/v1/managers/mgr_enxscjrqiiu2lrc672hwwuc5/heartbeat" \  -H "Content-Type: application/json" \  -d '{    "status": "healthy",    "url": "http://example.com",    "managementConfigs": {}  }'

{  "acknowledged": true,  "timestamp": "string"}

Get Manager Deployment

Get deployment details for a private manager (internal deployment platform, status, resources).

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 a manager.

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

Query Parameters

workspace?string

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

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

Length4 <= length <= 100

Response Body

`application/json`

curl -X GET "https://example.com/v1/managers/mgr_enxscjrqiiu2lrc672hwwuc5/deployment"

{  "platform": "string",  "status": "pending",  "deploymentId": "string",  "currentReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",  "desiredReleaseId": "rel_WbhQgksrawSKIpEN0NAssHX9",  "error": null,  "resources": {    "property1": {      "type": "string",      "status": "string",      "outputs": {        "property1": null,        "property2": null      }    },    "property2": {      "type": "string",      "status": "string",      "outputs": {        "property1": null,        "property2": null      }    }  },  "environmentInfo": null}

200application/json

500application/json

201application/json

400application/json

409application/json

500application/json

201application/json

400application/json

404application/json

500application/json

200application/json

400application/json

404application/json

500application/json

202application/json

400application/json

404application/json

500application/json

200application/json

404application/json

500application/json

202application/json

400application/json

404application/json

409application/json

500application/json

200application/json

404application/json

500application/json

200application/json

400application/json

404application/json

500application/json

200application/json

404application/json

500application/json

202application/json

400application/json

404application/json

500application/json

202application/json

400application/json

404application/json

500application/json

200application/json

400application/json

404application/json

500application/json

200application/json

404application/json

500application/json

200application/json

403application/json

404application/json

503application/json

200application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`