Skip to Content

Apps

The apps operations of the v1 API.

GET
/v1/clusters/{cluster_id}/apps

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Ordered by creation time, oldest first. Cursor paginated.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid

Query Parameters

cursor?|

Opaque cursor from the previous page's next_cursor.

limit?|

Page size, 1 to 100 (default 25).

Formatuint
Range0 <= value

Response Body

A page of apps

application/json
  1. response

One page of a v1 list.

data*array<>

The items, in the documented order.

has_more*boolean

Whether more items follow this page.

next_cursor?|

Pass as cursor to get the next page; null on the last page.

Example Request
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "data": [    {      "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",      "created_at": "2019-08-24T14:15:22Z",      "deploy_id": "f75200cd-87fa-454b-a461-0f6fd66de5a1",      "expected_image": "string",      "health_path": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "image": "string",      "image_digest": "string",      "last_deploy": {        "at": "2019-08-24T14:15:22Z",        "build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",        "failure_stage": "string",        "reason": "string",        "status": "string"      },      "last_deployed_at": "2019-08-24T14:15:22Z",      "name": "string",      "port": 0,      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",      "release_pinned": true,      "replicas": 0,      "running_digest": "string",      "serving_build_id": "99f45214-31fd-4a36-9417-710d9af243b0",      "state": "string",      "status": {        "desired": 0,        "detail": "string",        "kind": "pending",        "ready": 0,        "reason": "string"      },      "template_slug": "string"    }  ],  "has_more": true,  "next_cursor": "string"}
POST
/v1/clusters/{cluster_id}/apps

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

The app is deployed right away. Send an Idempotency-Key to make a retry safe.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid

Header Parameters

Idempotency-Key?string

Optional client-chosen key (1-255 visible ASCII characters). A retry with the same key and body within 24 hours replays the first response instead of creating again; the same key with a different body is a 422, and a retry while the first request still runs is a 409.

Request Body

An app to create from a container image or a catalog template.

application/json
  1. body

An app to create from a container image or a catalog template.

dependencies?array<>

How each dependency of the template is met (a new service app, an existing one of the project, or none for an optional one).

env?

Environment variables.

Default{}
health_path?|

HTTP health check path.

Defaultnull
image?|

The container image to run. A template app without one gets the template's catalog image.

Defaultnull
name*string

The app's name: 1-63 lowercase letters, digits or hyphens, starting and ending with a letter or digit. Unique in the project.

port?|

The main container port.

Formatint32
Defaultnull
project_id*string

The project to create the app in.

Formatuuid
replicas?|

Desired pods, default 1.

Formatint32
Defaultnull
template_slug?|

A catalog template to create the app from.

Defaultnull

Response Body

The created app

application/json
  1. response

An app, as the public API shows it.

cluster_id*string

The cluster the app runs on.

Formatuuid
created_at*string

When the app was created (RFC 3339, UTC).

Formatdate-time
deploy_id?|

The deploy a change started: set only in the response of an update that needed a redeploy (poll GET .../deploys/{id}), else null.

Formatuuid
expected_image?|

For a release-pinned app, the image its file names (the repo the release roll fills in); null otherwise.

health_path?|

HTTP health check path.

id*string

The app id.

Formatuuid
image?|

The container image it runs; null until a git app's first build.

image_digest?|

The content digest (sha256:...) the app's image is pinned to; null for an image given by tag. A deploy of a pinned image is verified by this digest once the deploy succeeded.

last_deploy?|

The latest deploy attempt. A failed rollout while the previous version serves keeps state at running and shows here.

last_deployed_at?|

When the app was last deployed.

Formatdate-time
name*string

The app's name, unique in its project.

port?|

The main container port.

Formatint32
project_id*string

The project the app belongs to.

Formatuuid
release_pinned*boolean

The app's linked IaC file pins its image to the release deploy (source: {image, pin: release}): a release roll sets the image, so the app is not deployed by hand.

replicas*integer

Desired pods.

Formatint32
running_digest?|

The content digest (sha256:...) the app's pods were last seen running, read from the ready pods' image IDs once a rollout is ready (also for an image given by tag). It can differ from image_digest: a multi-arch pin is the index, the pods run a platform manifest. Null before the first ready rollout or when no pod reported a digest.

serving_build_id?|

The deploy whose image serves traffic; null when none does.

Formatuuid
state*string

Lifecycle state, e.g. pending, deploying, running, stopped, failed. New states may be added.

status*

Whether it actually runs: state checked against the live pods (ready vs desired) and the last deploy, e.g. failed with reason FailedScheduling when a rollout left nothing ready. New kinds may be added.

template_slug?|

The catalog template the app was created from, if any.

Example Request
curl -X POST 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"name":"example","project_id":"00000000-0000-4000-8000-000000000001"}'
Example Response
{  "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",  "created_at": "2019-08-24T14:15:22Z",  "deploy_id": "f75200cd-87fa-454b-a461-0f6fd66de5a1",  "expected_image": "string",  "health_path": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "image": "string",  "image_digest": "string",  "last_deploy": {    "at": "2019-08-24T14:15:22Z",    "build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",    "failure_stage": "string",    "reason": "string",    "status": "string"  },  "last_deployed_at": "2019-08-24T14:15:22Z",  "name": "string",  "port": 0,  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",  "release_pinned": true,  "replicas": 0,  "running_digest": "string",  "serving_build_id": "99f45214-31fd-4a36-9417-710d9af243b0",  "state": "string",  "status": {    "desired": 0,    "detail": "string",    "kind": "pending",    "ready": 0,    "reason": "string"  },  "template_slug": "string"}
GET
/v1/clusters/{cluster_id}/apps/{app_id}

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid

Response Body

The app

application/json
  1. response

An app, as the public API shows it.

cluster_id*string

The cluster the app runs on.

Formatuuid
created_at*string

When the app was created (RFC 3339, UTC).

Formatdate-time
deploy_id?|

The deploy a change started: set only in the response of an update that needed a redeploy (poll GET .../deploys/{id}), else null.

Formatuuid
expected_image?|

For a release-pinned app, the image its file names (the repo the release roll fills in); null otherwise.

health_path?|

HTTP health check path.

id*string

The app id.

Formatuuid
image?|

The container image it runs; null until a git app's first build.

image_digest?|

The content digest (sha256:...) the app's image is pinned to; null for an image given by tag. A deploy of a pinned image is verified by this digest once the deploy succeeded.

last_deploy?|

The latest deploy attempt. A failed rollout while the previous version serves keeps state at running and shows here.

last_deployed_at?|

When the app was last deployed.

Formatdate-time
name*string

The app's name, unique in its project.

port?|

The main container port.

Formatint32
project_id*string

The project the app belongs to.

Formatuuid
release_pinned*boolean

The app's linked IaC file pins its image to the release deploy (source: {image, pin: release}): a release roll sets the image, so the app is not deployed by hand.

replicas*integer

Desired pods.

Formatint32
running_digest?|

The content digest (sha256:...) the app's pods were last seen running, read from the ready pods' image IDs once a rollout is ready (also for an image given by tag). It can differ from image_digest: a multi-arch pin is the index, the pods run a platform manifest. Null before the first ready rollout or when no pod reported a digest.

serving_build_id?|

The deploy whose image serves traffic; null when none does.

Formatuuid
state*string

Lifecycle state, e.g. pending, deploying, running, stopped, failed. New states may be added.

status*

Whether it actually runs: state checked against the live pods (ready vs desired) and the last deploy, e.g. failed with reason FailedScheduling when a rollout left nothing ready. New kinds may be added.

template_slug?|

The catalog template the app was created from, if any.

Example Request
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",  "created_at": "2019-08-24T14:15:22Z",  "deploy_id": "f75200cd-87fa-454b-a461-0f6fd66de5a1",  "expected_image": "string",  "health_path": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "image": "string",  "image_digest": "string",  "last_deploy": {    "at": "2019-08-24T14:15:22Z",    "build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",    "failure_stage": "string",    "reason": "string",    "status": "string"  },  "last_deployed_at": "2019-08-24T14:15:22Z",  "name": "string",  "port": 0,  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",  "release_pinned": true,  "replicas": 0,  "running_digest": "string",  "serving_build_id": "99f45214-31fd-4a36-9417-710d9af243b0",  "state": "string",  "status": {    "desired": 0,    "detail": "string",    "kind": "pending",    "ready": 0,    "reason": "string"  },  "template_slug": "string"}
PATCH
/v1/clusters/{cluster_id}/apps/{app_id}

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

A new image redeploys the app.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid

Request Body

App settings to change; omitted fields stay as they are.

application/json
  1. body

App settings to change; omitted fields stay as they are.

batch?|

Groups the redeploy with others sent under the same name (for example a release version), so their notices arrive together. 1-64 letters, digits or . _ - + :.

Defaultnull
health_path?|

A new HTTP health check path.

Defaultnull
image?|

A new container image; redeploys the app.

Defaultnull
port?|

A new main container port.

Formatint32
Defaultnull

Response Body

The updated app

application/json
  1. response

An app, as the public API shows it.

cluster_id*string

The cluster the app runs on.

Formatuuid
created_at*string

When the app was created (RFC 3339, UTC).

Formatdate-time
deploy_id?|

The deploy a change started: set only in the response of an update that needed a redeploy (poll GET .../deploys/{id}), else null.

Formatuuid
expected_image?|

For a release-pinned app, the image its file names (the repo the release roll fills in); null otherwise.

health_path?|

HTTP health check path.

id*string

The app id.

Formatuuid
image?|

The container image it runs; null until a git app's first build.

image_digest?|

The content digest (sha256:...) the app's image is pinned to; null for an image given by tag. A deploy of a pinned image is verified by this digest once the deploy succeeded.

last_deploy?|

The latest deploy attempt. A failed rollout while the previous version serves keeps state at running and shows here.

last_deployed_at?|

When the app was last deployed.

Formatdate-time
name*string

The app's name, unique in its project.

port?|

The main container port.

Formatint32
project_id*string

The project the app belongs to.

Formatuuid
release_pinned*boolean

The app's linked IaC file pins its image to the release deploy (source: {image, pin: release}): a release roll sets the image, so the app is not deployed by hand.

replicas*integer

Desired pods.

Formatint32
running_digest?|

The content digest (sha256:...) the app's pods were last seen running, read from the ready pods' image IDs once a rollout is ready (also for an image given by tag). It can differ from image_digest: a multi-arch pin is the index, the pods run a platform manifest. Null before the first ready rollout or when no pod reported a digest.

serving_build_id?|

The deploy whose image serves traffic; null when none does.

Formatuuid
state*string

Lifecycle state, e.g. pending, deploying, running, stopped, failed. New states may be added.

status*

Whether it actually runs: state checked against the live pods (ready vs desired) and the last deploy, e.g. failed with reason FailedScheduling when a rollout left nothing ready. New kinds may be added.

template_slug?|

The catalog template the app was created from, if any.

Example Request
curl -X PATCH 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"batch":"example","health_path":"example","image":"example","port":1}'
Example Response
{  "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",  "created_at": "2019-08-24T14:15:22Z",  "deploy_id": "f75200cd-87fa-454b-a461-0f6fd66de5a1",  "expected_image": "string",  "health_path": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "image": "string",  "image_digest": "string",  "last_deploy": {    "at": "2019-08-24T14:15:22Z",    "build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",    "failure_stage": "string",    "reason": "string",    "status": "string"  },  "last_deployed_at": "2019-08-24T14:15:22Z",  "name": "string",  "port": 0,  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",  "release_pinned": true,  "replicas": 0,  "running_digest": "string",  "serving_build_id": "99f45214-31fd-4a36-9417-710d9af243b0",  "state": "string",  "status": {    "desired": 0,    "detail": "string",    "kind": "pending",    "ready": 0,    "reason": "string"  },  "template_slug": "string"}
DELETE
/v1/clusters/{cluster_id}/apps/{app_id}

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Undeploys the app. Its backups are kept until their retention runs out and its buckets are kept.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid

Response Body

App deletion started

Example Request
curl -X DELETE 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
Empty
POST
/v1/clusters/{cluster_id}/apps/{app_id}/backups

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Backs up with the app's enabled backup policies. Send an Idempotency-Key to make a retry safe.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid

Header Parameters

Idempotency-Key?string

Optional client-chosen key (1-255 visible ASCII characters). A retry with the same key and body within 24 hours replays the first response instead of creating again; the same key with a different body is a 422, and a retry while the first request still runs is a 409.

Request Body

A backup to run now.

application/json
  1. body

A backup to run now.

target_ids?array<>|

Targets to back up to; the app's primary target when left out.

Defaultnull

Response Body

The run that was queued

application/json
  1. response

A backup run that was queued.

run_id*string

Follow it at GET .../backups/runs/{run_id}.

Formatuuid
Example Request
curl -X POST 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/backups' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"target_ids":[]}'
Example Response
{  "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec"}
GET
/v1/clusters/{cluster_id}/apps/{app_id}/backups/runs/{run_id}

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

pending until the worker records the run, then running, succeeded or failed (any target failing fails the run). A run that stays pending never started.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid
run_id*string

The run UUID

Formatuuid

Response Body

The run

application/json
  1. response

Where a manual backup run stands.

error?|

The first failure, when it failed.

run_id*string

The run, as returned when it was requested.

Formatuuid
runs*array<>

One row per object and target the run wrote to.

status*string

pending (nothing recorded yet), running, succeeded or failed.

Example Request
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/backups/runs/00000000-0000-4000-8000-000000000003' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "error": "string",  "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",  "runs": [    {      "error": "string",      "finished_at": "2019-08-24T14:15:22Z",      "kind": "string",      "started_at": "2019-08-24T14:15:22Z",      "status": "string",      "storage_id": "b393bdc8-beeb-473d-b930-952d1433f9f9",      "trigger": "string"    }  ],  "status": "string"}
GET
/v1/clusters/{cluster_id}/apps/{app_id}/deploys

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Newest first. Cursor paginated. status keeps only deploys in that stored status.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid

Query Parameters

cursor?|

Cursor from the previous page.

limit?|

Page size (1 to 100).

Formatuint
Range0 <= value
status?|

Keep only deploys in this status, e.g. failed.

Response Body

A page of deploys

application/json
  1. response

One page of a v1 list.

data*array<>

The items, in the documented order.

has_more*boolean

Whether more items follow this page.

next_cursor?|

Pass as cursor to get the next page; null on the last page.

Example Request
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/deploys' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "data": [    {      "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",      "created_at": "2019-08-24T14:15:22Z",      "error": "string",      "failure_stage": "string",      "finished_at": "2019-08-24T14:15:22Z",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "image": "string",      "image_digest": "string",      "refusal_code": "string",      "rollback_reason": "string",      "rolled_back_at": "2019-08-24T14:15:22Z",      "serving": true,      "started_at": "2019-08-24T14:15:22Z",      "status": "string"    }  ],  "has_more": true,  "next_cursor": "string"}
POST
/v1/clusters/{cluster_id}/apps/{app_id}/deploys

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Send an Idempotency-Key to make a retry safe.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid

Header Parameters

Idempotency-Key?string

Optional client-chosen key (1-255 visible ASCII characters). A retry with the same key and body within 24 hours replays the first response instead of creating again; the same key with a different body is a 422, and a retry while the first request still runs is a 409.

Request Body

A deploy to start.

application/json
  1. body

A deploy to start.

strategy?|

rolling (default), recreate or surge (templates that support it).

Defaultnull

Response Body

The deploy that started

application/json
  1. response

A deploy (or build) of an app.

app_id*string

The app it deploys.

Formatuuid
created_at*string

When it was created (RFC 3339, UTC).

Formatdate-time
error?|

Why it failed.

failure_stage?|

Where a failed deploy stopped: build, push or rollout.

finished_at?|

When it finished.

Formatdate-time
id*string

The deploy id.

Formatuuid
image?|

The image it deploys; null while a build has not produced one.

image_digest?|

Digest of the pushed image.

refusal_code?|

For a refused build: BILLING_ACCOUNT_BLOCKED (top up the billing account) or SPEND_CAP_REACHED (raise the spend cap).

rollback_reason?|

Why it was rolled back.

rolled_back_at?|

When it was rolled back.

Formatdate-time
serving*boolean

True while this deploy's image is the one serving traffic.

started_at?|

When it started.

Formatdate-time
status*string

e.g. pending, waiting_for_capacity (no build VM free yet), waiting_for_image (the platform's build image is not published yet), booting (its build VM is starting), building, pushed (image pushed, the deploy not started yet), waiting_for_pool (a deploy held until its pinned node pool has a ready node; nothing is applied meanwhile), deploying, succeeded, failed, cancelled, refused (an automatic build the org could not pay for; see refusal_code). New statuses may be added.

Example Request
curl -X POST 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/deploys' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"strategy":"example"}'
Example Response
{  "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",  "created_at": "2019-08-24T14:15:22Z",  "error": "string",  "failure_stage": "string",  "finished_at": "2019-08-24T14:15:22Z",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "image": "string",  "image_digest": "string",  "refusal_code": "string",  "rollback_reason": "string",  "rolled_back_at": "2019-08-24T14:15:22Z",  "serving": true,  "started_at": "2019-08-24T14:15:22Z",  "status": "string"}
POST
/v1/clusters/{cluster_id}/apps/{app_id}/deploys/cancel

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

The worker stops it and rolls the app back to what ran before.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid

Response Body

The cancelled deploy

application/json
  1. response

A deploy (or build) of an app.

app_id*string

The app it deploys.

Formatuuid
created_at*string

When it was created (RFC 3339, UTC).

Formatdate-time
error?|

Why it failed.

failure_stage?|

Where a failed deploy stopped: build, push or rollout.

finished_at?|

When it finished.

Formatdate-time
id*string

The deploy id.

Formatuuid
image?|

The image it deploys; null while a build has not produced one.

image_digest?|

Digest of the pushed image.

refusal_code?|

For a refused build: BILLING_ACCOUNT_BLOCKED (top up the billing account) or SPEND_CAP_REACHED (raise the spend cap).

rollback_reason?|

Why it was rolled back.

rolled_back_at?|

When it was rolled back.

Formatdate-time
serving*boolean

True while this deploy's image is the one serving traffic.

started_at?|

When it started.

Formatdate-time
status*string

e.g. pending, waiting_for_capacity (no build VM free yet), waiting_for_image (the platform's build image is not published yet), booting (its build VM is starting), building, pushed (image pushed, the deploy not started yet), waiting_for_pool (a deploy held until its pinned node pool has a ready node; nothing is applied meanwhile), deploying, succeeded, failed, cancelled, refused (an automatic build the org could not pay for; see refusal_code). New statuses may be added.

Example Request
curl -X POST 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/deploys/cancel' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",  "created_at": "2019-08-24T14:15:22Z",  "error": "string",  "failure_stage": "string",  "finished_at": "2019-08-24T14:15:22Z",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "image": "string",  "image_digest": "string",  "refusal_code": "string",  "rollback_reason": "string",  "rolled_back_at": "2019-08-24T14:15:22Z",  "serving": true,  "started_at": "2019-08-24T14:15:22Z",  "status": "string"}
GET
/v1/clusters/{cluster_id}/apps/{app_id}/deploys/{deploy_id}

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid
deploy_id*string

The deploy UUID

Formatuuid

Response Body

The deploy

application/json
  1. response

A deploy (or build) of an app.

app_id*string

The app it deploys.

Formatuuid
created_at*string

When it was created (RFC 3339, UTC).

Formatdate-time
error?|

Why it failed.

failure_stage?|

Where a failed deploy stopped: build, push or rollout.

finished_at?|

When it finished.

Formatdate-time
id*string

The deploy id.

Formatuuid
image?|

The image it deploys; null while a build has not produced one.

image_digest?|

Digest of the pushed image.

refusal_code?|

For a refused build: BILLING_ACCOUNT_BLOCKED (top up the billing account) or SPEND_CAP_REACHED (raise the spend cap).

rollback_reason?|

Why it was rolled back.

rolled_back_at?|

When it was rolled back.

Formatdate-time
serving*boolean

True while this deploy's image is the one serving traffic.

started_at?|

When it started.

Formatdate-time
status*string

e.g. pending, waiting_for_capacity (no build VM free yet), waiting_for_image (the platform's build image is not published yet), booting (its build VM is starting), building, pushed (image pushed, the deploy not started yet), waiting_for_pool (a deploy held until its pinned node pool has a ready node; nothing is applied meanwhile), deploying, succeeded, failed, cancelled, refused (an automatic build the org could not pay for; see refusal_code). New statuses may be added.

Example Request
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/deploys/00000000-0000-4000-8000-000000000003' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",  "created_at": "2019-08-24T14:15:22Z",  "error": "string",  "failure_stage": "string",  "finished_at": "2019-08-24T14:15:22Z",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "image": "string",  "image_digest": "string",  "refusal_code": "string",  "rollback_reason": "string",  "rolled_back_at": "2019-08-24T14:15:22Z",  "serving": true,  "started_at": "2019-08-24T14:15:22Z",  "status": "string"}
POST
/v1/clusters/{cluster_id}/apps/{app_id}/deploys/{deploy_id}/rollback

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Redeploys that deploy's image by digest. Send an Idempotency-Key to make a retry safe.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid
deploy_id*string

The past deploy UUID

Formatuuid

Header Parameters

Idempotency-Key?string

Optional client-chosen key (1-255 visible ASCII characters). A retry with the same key and body within 24 hours replays the first response instead of creating again; the same key with a different body is a 422, and a retry while the first request still runs is a 409.

Response Body

The rollback deploy that started

application/json
  1. response

A deploy (or build) of an app.

app_id*string

The app it deploys.

Formatuuid
created_at*string

When it was created (RFC 3339, UTC).

Formatdate-time
error?|

Why it failed.

failure_stage?|

Where a failed deploy stopped: build, push or rollout.

finished_at?|

When it finished.

Formatdate-time
id*string

The deploy id.

Formatuuid
image?|

The image it deploys; null while a build has not produced one.

image_digest?|

Digest of the pushed image.

refusal_code?|

For a refused build: BILLING_ACCOUNT_BLOCKED (top up the billing account) or SPEND_CAP_REACHED (raise the spend cap).

rollback_reason?|

Why it was rolled back.

rolled_back_at?|

When it was rolled back.

Formatdate-time
serving*boolean

True while this deploy's image is the one serving traffic.

started_at?|

When it started.

Formatdate-time
status*string

e.g. pending, waiting_for_capacity (no build VM free yet), waiting_for_image (the platform's build image is not published yet), booting (its build VM is starting), building, pushed (image pushed, the deploy not started yet), waiting_for_pool (a deploy held until its pinned node pool has a ready node; nothing is applied meanwhile), deploying, succeeded, failed, cancelled, refused (an automatic build the org could not pay for; see refusal_code). New statuses may be added.

Example Request
curl -X POST 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/deploys/00000000-0000-4000-8000-000000000003/rollback' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",  "created_at": "2019-08-24T14:15:22Z",  "error": "string",  "failure_stage": "string",  "finished_at": "2019-08-24T14:15:22Z",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "image": "string",  "image_digest": "string",  "refusal_code": "string",  "rollback_reason": "string",  "rolled_back_at": "2019-08-24T14:15:22Z",  "serving": true,  "started_at": "2019-08-24T14:15:22Z",  "status": "string"}
GET
/v1/clusters/{cluster_id}/apps/{app_id}/egress

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Get an app's outbound settings: its own mode and rules plus what it inherits from its project.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid

Response Body

The app's outbound settings

application/json
  1. response

An app's outbound settings.

effective_mode*string

The mode in force: mode, or else inherited_mode.

inherited_mode*string

The project's mode, used while mode is null.

inherited_rules*array<>

The project's rules, which also apply to the app.

mode?|

null follows the project.

rules*array<>

The app's own allowlist rules.

Example Request
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/egress' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "effective_mode": "string",  "inherited_mode": "string",  "inherited_rules": [    {      "description": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "kind": "string",      "port": 0,      "private": true,      "protocol": "string",      "value": "string"    }  ],  "mode": "string",  "rules": [    {      "description": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "kind": "string",      "port": 0,      "private": true,      "protocol": "string",      "value": "string"    }  ]}
PUT
/v1/clusters/{cluster_id}/apps/{app_id}/egress

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Replace an app's own outbound mode (null follows the project) and rules.

Re-applies the app's network policies.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid

Request Body

The whole new setting of a scope.

application/json
  1. body

The whole new setting of a scope.

mode?|

public or isolated. An app may send null to follow its project.

Defaultnull
rules?array<>

Replaces the scope's allowlist.

Response Body

The app's outbound settings now

application/json
  1. response

An app's outbound settings.

effective_mode*string

The mode in force: mode, or else inherited_mode.

inherited_mode*string

The project's mode, used while mode is null.

inherited_rules*array<>

The project's rules, which also apply to the app.

mode?|

null follows the project.

rules*array<>

The app's own allowlist rules.

Example Request
curl -X PUT 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/egress' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"mode":"example","rules":[]}'
Example Response
{  "effective_mode": "string",  "inherited_mode": "string",  "inherited_rules": [    {      "description": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "kind": "string",      "port": 0,      "private": true,      "protocol": "string",      "value": "string"    }  ],  "mode": "string",  "rules": [    {      "description": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "kind": "string",      "port": 0,      "private": true,      "protocol": "string",      "value": "string"    }  ]}
GET
/v1/clusters/{cluster_id}/apps/{app_id}/egress/blocked

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

List the destinations an app's egress policy blocked in the last 24 hours, most recent first (at most 20).

Built from the app's blocked-connection log lines, so it follows the cluster's log retention and the app's log access.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid

Response Body

The recently blocked destinations

application/json
  1. response

The app's recently blocked destinations, most recent first.

destinations*array<>

At most 20, from the last 24 hours.

Example Request
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/egress/blocked' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "destinations": [    {      "count": 0,      "fqdn": "string",      "ip": "string",      "last_seen": "2019-08-24T14:15:22Z",      "port": 0,      "protocol": "string"    }  ]}
GET
/v1/clusters/{cluster_id}/apps/{app_id}/env

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid

Response Body

The app's environment variables

application/json
  1. response

An app's environment variables.

env*

Variable name to value. Replacing sets exactly these variables.

Example Request
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/env' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "env": {    "property1": "string",    "property2": "string"  }}
PUT
/v1/clusters/{cluster_id}/apps/{app_id}/env

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Sets exactly the given variables (others are removed) and redeploys the app.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid

Request Body

An app's environment variables.

application/json
  1. body

An app's environment variables.

env*

Variable name to value. Replacing sets exactly these variables.

Response Body

The app's environment variables now

application/json
  1. response

An app's environment variables.

env*

Variable name to value. Replacing sets exactly these variables.

Example Request
curl -X PUT 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/env' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"env":{}}'
Example Response
{  "env": {    "property1": "string",    "property2": "string"  }}
GET
/v1/clusters/{cluster_id}/apps/{app_id}/http-settings

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Get an app's HTTP settings (defaults until changed).

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid

Response Body

The app's HTTP settings

application/json
  1. response

An app's HTTP settings.

compression*boolean

Compress responses (zstd, br or gzip, as the client accepts).

content_negotiation*

Static sites: answer extensionless pages with their Markdown, JSON, YAML or text twin when Accept prefers it over HTML.

coop*||
csp_mode*||
csp_policy?|

The custom CSP (used with preset custom).

csp_preset*||
csp_report_uri?|

HTTPS URL appended to the CSP as report-uri.

csrf_exempt_paths*array<string>

Path prefixes that skip the check (webhooks, SAML ACS).

csrf_mode*||
csrf_trusted_origins*array<string>

Exact origins whose browser writes are always let through.

custom_headers*array<>

Extra response headers, at most 32.

header_frame_options*boolean

X-Frame-Options: SAMEORIGIN.

header_nosniff*boolean

X-Content-Type-Options: nosniff.

header_referrer_policy*boolean

Referrer-Policy: strict-origin-when-cross-origin.

hsts*boolean

Send Strict-Transport-Security on HTTPS responses.

hsts_include_subdomains*boolean

Add includeSubDomains to the HSTS header.

hsts_max_age*integer

HSTS max-age in seconds.

Formatint64
https_redirect*boolean

Redirect plain HTTP to HTTPS once a certificate is issued.

max_body_bytes?|

Largest accepted request body in bytes; null for no limit.

Formatint64
permissions_policy*|||
permissions_policy_custom?|

The custom Permissions-Policy (used with mode custom).

www_redirect*string

Redirect between a host and its www. form.

Value in"off""to_www""to_apex"
Example Request
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/http-settings' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "compression": true,  "content_negotiation": {    "enabled": false,    "markdown_tokens": true,    "types": [      "markdown",      "json",      "yaml",      "text"    ]  },  "coop": "off",  "csp_mode": "off",  "csp_policy": "string",  "csp_preset": "basic",  "csp_report_uri": "string",  "csrf_exempt_paths": [    "string"  ],  "csrf_mode": "off",  "csrf_trusted_origins": [    "string"  ],  "custom_headers": [    {      "name": "string",      "value": "string"    }  ],  "header_frame_options": true,  "header_nosniff": true,  "header_referrer_policy": true,  "hsts": true,  "hsts_include_subdomains": true,  "hsts_max_age": 0,  "https_redirect": true,  "max_body_bytes": 0,  "permissions_policy": "off",  "permissions_policy_custom": "string",  "www_redirect": "off"}
PATCH
/v1/clusters/{cluster_id}/apps/{app_id}/http-settings

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Change some of an app's HTTP settings; omitted fields keep their value.

A deployed app's HTTP routes are re-applied right away (no redeploy).

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid

Request Body

The settings to change; omitted fields keep their value.

application/json
  1. body

The settings to change; omitted fields keep their value.

compression?|

Compress responses.

content_negotiation?|

Replaces the content negotiation choice (static sites); omitted keys inside take their defaults.

coop?|||

Cross-Origin-Opener-Policy.

csp_mode?|||

Content-Security-Policy: off, report only or enforced.

csp_policy?|

null or blank clears it.

Defaultnull
csp_preset?|||

Which CSP is sent: the basic or strict preset, or csp_policy.

csp_report_uri?|

null or blank clears it.

Defaultnull
csrf_exempt_paths?array<string>|

Replaces the list: at most 20 path prefixes like /hooks, each up to 256 characters; / is refused.

csrf_mode?|||

Cross-site request protection: off, report only or enforced.

csrf_trusted_origins?array<string>|

Replaces the list: at most 20 exact origins like https://www.example.com (http:// only when the app serves plain HTTP).

custom_headers?array<>|

Replaces the whole list (at most 32 headers).

header_frame_options?|

X-Frame-Options: SAMEORIGIN.

header_nosniff?|

X-Content-Type-Options: nosniff.

header_referrer_policy?|

Referrer-Policy: strict-origin-when-cross-origin.

hsts?|

Send Strict-Transport-Security on HTTPS responses.

hsts_include_subdomains?|

Add includeSubDomains to the HSTS header.

hsts_max_age?|

HSTS max-age in seconds, 0 to 63072000 (two years).

Formatint64
https_redirect?|

Redirect plain HTTP to HTTPS once a certificate is issued.

max_body_bytes?|

null removes the limit.

Formatint64
Defaultnull
permissions_policy?||||

Permissions-Policy: off, a preset or permissions_policy_custom.

permissions_policy_custom?|

null or blank clears it.

Defaultnull
www_redirect?|

Redirect between a host and its www. form.

Response Body

The app's HTTP settings now

application/json
  1. response

An app's HTTP settings.

compression*boolean

Compress responses (zstd, br or gzip, as the client accepts).

content_negotiation*

Static sites: answer extensionless pages with their Markdown, JSON, YAML or text twin when Accept prefers it over HTML.

coop*||
csp_mode*||
csp_policy?|

The custom CSP (used with preset custom).

csp_preset*||
csp_report_uri?|

HTTPS URL appended to the CSP as report-uri.

csrf_exempt_paths*array<string>

Path prefixes that skip the check (webhooks, SAML ACS).

csrf_mode*||
csrf_trusted_origins*array<string>

Exact origins whose browser writes are always let through.

custom_headers*array<>

Extra response headers, at most 32.

header_frame_options*boolean

X-Frame-Options: SAMEORIGIN.

header_nosniff*boolean

X-Content-Type-Options: nosniff.

header_referrer_policy*boolean

Referrer-Policy: strict-origin-when-cross-origin.

hsts*boolean

Send Strict-Transport-Security on HTTPS responses.

hsts_include_subdomains*boolean

Add includeSubDomains to the HSTS header.

hsts_max_age*integer

HSTS max-age in seconds.

Formatint64
https_redirect*boolean

Redirect plain HTTP to HTTPS once a certificate is issued.

max_body_bytes?|

Largest accepted request body in bytes; null for no limit.

Formatint64
permissions_policy*|||
permissions_policy_custom?|

The custom Permissions-Policy (used with mode custom).

www_redirect*string

Redirect between a host and its www. form.

Value in"off""to_www""to_apex"
Example Request
curl -X PATCH 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/http-settings' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"compression":false,"content_negotiation":{"enabled":false,"markdown_tokens":true,"types":["markdown","json","yaml","text"]},"coop":"off","csp_mode":"off","csp_policy":"example","csp_preset":"basic","csp_report_uri":"example","csrf_exempt_paths":[],"csrf_mode":"off","csrf_trusted_origins":[],"custom_headers":[],"header_frame_options":false,"header_nosniff":false,"header_referrer_policy":false,"hsts":false,"hsts_include_subdomains":false,"hsts_max_age":1,"https_redirect":false,"max_body_bytes":1,"permissions_policy":"off","permissions_policy_custom":"example","www_redirect":"off"}'
Example Response
{  "compression": true,  "content_negotiation": {    "enabled": false,    "markdown_tokens": true,    "types": [      "markdown",      "json",      "yaml",      "text"    ]  },  "coop": "off",  "csp_mode": "off",  "csp_policy": "string",  "csp_preset": "basic",  "csp_report_uri": "string",  "csrf_exempt_paths": [    "string"  ],  "csrf_mode": "off",  "csrf_trusted_origins": [    "string"  ],  "custom_headers": [    {      "name": "string",      "value": "string"    }  ],  "header_frame_options": true,  "header_nosniff": true,  "header_referrer_policy": true,  "hsts": true,  "hsts_include_subdomains": true,  "hsts_max_age": 0,  "https_redirect": true,  "max_body_bytes": 0,  "permissions_policy": "off",  "permissions_policy_custom": "string",  "www_redirect": "off"}
PUT
/v1/clusters/{cluster_id}/apps/{app_id}/scale

Try it: use a key with the least scope; requests go straight from your browser to the API. The key stays in this tab's memory and is gone on reload.

Authorization

api_key
headerAuthorizationBearer <alc_ API key>

An A-Line.cloud API key, sent as Authorization: Bearer alc_.... Create keys in the dashboard; sessions are not accepted on /v1.

Path Parameters

cluster_id*string

The cluster UUID

Formatuuid
app_id*string

The app UUID

Formatuuid

Request Body

How many pods an app runs.

application/json
  1. body

How many pods an app runs.

replicas*integer

Desired pods.

Formatint32

Response Body

The scaled app

application/json
  1. response

An app, as the public API shows it.

cluster_id*string

The cluster the app runs on.

Formatuuid
created_at*string

When the app was created (RFC 3339, UTC).

Formatdate-time
deploy_id?|

The deploy a change started: set only in the response of an update that needed a redeploy (poll GET .../deploys/{id}), else null.

Formatuuid
expected_image?|

For a release-pinned app, the image its file names (the repo the release roll fills in); null otherwise.

health_path?|

HTTP health check path.

id*string

The app id.

Formatuuid
image?|

The container image it runs; null until a git app's first build.

image_digest?|

The content digest (sha256:...) the app's image is pinned to; null for an image given by tag. A deploy of a pinned image is verified by this digest once the deploy succeeded.

last_deploy?|

The latest deploy attempt. A failed rollout while the previous version serves keeps state at running and shows here.

last_deployed_at?|

When the app was last deployed.

Formatdate-time
name*string

The app's name, unique in its project.

port?|

The main container port.

Formatint32
project_id*string

The project the app belongs to.

Formatuuid
release_pinned*boolean

The app's linked IaC file pins its image to the release deploy (source: {image, pin: release}): a release roll sets the image, so the app is not deployed by hand.

replicas*integer

Desired pods.

Formatint32
running_digest?|

The content digest (sha256:...) the app's pods were last seen running, read from the ready pods' image IDs once a rollout is ready (also for an image given by tag). It can differ from image_digest: a multi-arch pin is the index, the pods run a platform manifest. Null before the first ready rollout or when no pod reported a digest.

serving_build_id?|

The deploy whose image serves traffic; null when none does.

Formatuuid
state*string

Lifecycle state, e.g. pending, deploying, running, stopped, failed. New states may be added.

status*

Whether it actually runs: state checked against the live pods (ready vs desired) and the last deploy, e.g. failed with reason FailedScheduling when a rollout left nothing ready. New kinds may be added.

template_slug?|

The catalog template the app was created from, if any.

Example Request
curl -X PUT 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/scale' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"replicas":1}'
Example Response
{  "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",  "created_at": "2019-08-24T14:15:22Z",  "deploy_id": "f75200cd-87fa-454b-a461-0f6fd66de5a1",  "expected_image": "string",  "health_path": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "image": "string",  "image_digest": "string",  "last_deploy": {    "at": "2019-08-24T14:15:22Z",    "build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",    "failure_stage": "string",    "reason": "string",    "status": "string"  },  "last_deployed_at": "2019-08-24T14:15:22Z",  "name": "string",  "port": 0,  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",  "release_pinned": true,  "replicas": 0,  "running_digest": "string",  "serving_build_id": "99f45214-31fd-4a36-9417-710d9af243b0",  "state": "string",  "status": {    "desired": 0,    "detail": "string",    "kind": "pending",    "ready": 0,    "reason": "string"  },  "template_slug": "string"}

On this page