Apps
The apps operations of the v1 API.
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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidcursor?|Opaque cursor from the previous page's next_cursor.
limit?|Page size, 1 to 100 (default 25).
uint0 <= valueA page of apps
application/json- response
One page of a v1 list.
data*array<>The items, in the documented order.
has_more*booleanWhether more items follow this page.
next_cursor?|Pass as cursor to get the next page; null on the last page.
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'{ "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"}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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidIdempotency-Key?stringOptional 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.
An app to create from a container image or a catalog template.
application/json- 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.
{}health_path?|HTTP health check path.
nullimage?|The container image to run. A template app without one gets the template's catalog image.
nullname*stringThe 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.
int32nullproject_id*stringThe project to create the app in.
uuidreplicas?|Desired pods, default 1.
int32nulltemplate_slug?|A catalog template to create the app from.
nullThe created app
application/json- response
An app, as the public API shows it.
cluster_id*stringThe cluster the app runs on.
uuidcreated_at*stringWhen the app was created (RFC 3339, UTC).
date-timedeploy_id?|The deploy a change started: set only in the response of an update that needed a redeploy (poll GET .../deploys/{id}), else null.
uuidexpected_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*stringThe app id.
uuidimage?|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.
date-timename*stringThe app's name, unique in its project.
port?|The main container port.
int32project_id*stringThe project the app belongs to.
uuidrelease_pinned*booleanThe 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*integerDesired pods.
int32running_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.
uuidstate*stringLifecycle 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.
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"}'{ "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"}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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuidThe app
application/json- response
An app, as the public API shows it.
cluster_id*stringThe cluster the app runs on.
uuidcreated_at*stringWhen the app was created (RFC 3339, UTC).
date-timedeploy_id?|The deploy a change started: set only in the response of an update that needed a redeploy (poll GET .../deploys/{id}), else null.
uuidexpected_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*stringThe app id.
uuidimage?|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.
date-timename*stringThe app's name, unique in its project.
port?|The main container port.
int32project_id*stringThe project the app belongs to.
uuidrelease_pinned*booleanThe 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*integerDesired pods.
int32running_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.
uuidstate*stringLifecycle 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.
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'{ "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"}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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuidApp settings to change; omitted fields stay as they are.
application/json- 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 . _ - + :.
nullhealth_path?|A new HTTP health check path.
nullimage?|A new container image; redeploys the app.
nullport?|A new main container port.
int32nullThe updated app
application/json- response
An app, as the public API shows it.
cluster_id*stringThe cluster the app runs on.
uuidcreated_at*stringWhen the app was created (RFC 3339, UTC).
date-timedeploy_id?|The deploy a change started: set only in the response of an update that needed a redeploy (poll GET .../deploys/{id}), else null.
uuidexpected_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*stringThe app id.
uuidimage?|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.
date-timename*stringThe app's name, unique in its project.
port?|The main container port.
int32project_id*stringThe project the app belongs to.
uuidrelease_pinned*booleanThe 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*integerDesired pods.
int32running_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.
uuidstate*stringLifecycle 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.
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}'{ "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"}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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuidApp deletion started
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'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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuidIdempotency-Key?stringOptional 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.
A backup to run now.
application/json- body
A backup to run now.
target_ids?array<>|Targets to back up to; the app's primary target when left out.
nullThe run that was queued
application/json- response
A backup run that was queued.
run_id*stringFollow it at GET .../backups/runs/{run_id}.
uuidcurl -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":[]}'{ "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec"}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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuidrun_id*stringThe run UUID
uuidThe run
application/json- response
Where a manual backup run stands.
error?|The first failure, when it failed.
run_id*stringThe run, as returned when it was requested.
uuidruns*array<>One row per object and target the run wrote to.
status*stringpending (nothing recorded yet), running, succeeded or failed.
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'{ "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"}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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuidcursor?|Cursor from the previous page.
limit?|Page size (1 to 100).
uint0 <= valuestatus?|Keep only deploys in this status, e.g. failed.
A page of deploys
application/json- response
One page of a v1 list.
data*array<>The items, in the documented order.
has_more*booleanWhether more items follow this page.
next_cursor?|Pass as cursor to get the next page; null on the last page.
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'{ "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"}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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuidIdempotency-Key?stringOptional 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.
A deploy to start.
application/json- body
A deploy to start.
strategy?|rolling (default), recreate or surge (templates that support it).
nullThe deploy that started
application/json- response
A deploy (or build) of an app.
app_id*stringThe app it deploys.
uuidcreated_at*stringWhen it was created (RFC 3339, UTC).
date-timeerror?|Why it failed.
failure_stage?|Where a failed deploy stopped: build, push or rollout.
finished_at?|When it finished.
date-timeid*stringThe deploy id.
uuidimage?|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.
date-timeserving*booleanTrue while this deploy's image is the one serving traffic.
started_at?|When it started.
date-timestatus*stringe.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.
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"}'{ "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"}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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuidThe cancelled deploy
application/json- response
A deploy (or build) of an app.
app_id*stringThe app it deploys.
uuidcreated_at*stringWhen it was created (RFC 3339, UTC).
date-timeerror?|Why it failed.
failure_stage?|Where a failed deploy stopped: build, push or rollout.
finished_at?|When it finished.
date-timeid*stringThe deploy id.
uuidimage?|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.
date-timeserving*booleanTrue while this deploy's image is the one serving traffic.
started_at?|When it started.
date-timestatus*stringe.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.
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'{ "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"}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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuiddeploy_id*stringThe deploy UUID
uuidThe deploy
application/json- response
A deploy (or build) of an app.
app_id*stringThe app it deploys.
uuidcreated_at*stringWhen it was created (RFC 3339, UTC).
date-timeerror?|Why it failed.
failure_stage?|Where a failed deploy stopped: build, push or rollout.
finished_at?|When it finished.
date-timeid*stringThe deploy id.
uuidimage?|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.
date-timeserving*booleanTrue while this deploy's image is the one serving traffic.
started_at?|When it started.
date-timestatus*stringe.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.
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'{ "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"}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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuiddeploy_id*stringThe past deploy UUID
uuidIdempotency-Key?stringOptional 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.
The rollback deploy that started
application/json- response
A deploy (or build) of an app.
app_id*stringThe app it deploys.
uuidcreated_at*stringWhen it was created (RFC 3339, UTC).
date-timeerror?|Why it failed.
failure_stage?|Where a failed deploy stopped: build, push or rollout.
finished_at?|When it finished.
date-timeid*stringThe deploy id.
uuidimage?|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.
date-timeserving*booleanTrue while this deploy's image is the one serving traffic.
started_at?|When it started.
date-timestatus*stringe.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.
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'{ "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"}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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuidThe app's outbound settings
application/json- response
An app's outbound settings.
effective_mode*stringThe mode in force: mode, or else inherited_mode.
inherited_mode*stringThe 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.
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'{ "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" } ]}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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuidThe whole new setting of a scope.
application/json- body
The whole new setting of a scope.
mode?|public or isolated. An app may send null to follow its project.
nullrules?array<>Replaces the scope's allowlist.
The app's outbound settings now
application/json- response
An app's outbound settings.
effective_mode*stringThe mode in force: mode, or else inherited_mode.
inherited_mode*stringThe 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.
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":[]}'{ "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" } ]}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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuidThe recently blocked destinations
application/json- response
The app's recently blocked destinations, most recent first.
destinations*array<>At most 20, from the last 24 hours.
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'{ "destinations": [ { "count": 0, "fqdn": "string", "ip": "string", "last_seen": "2019-08-24T14:15:22Z", "port": 0, "protocol": "string" } ]}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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuidThe app's environment variables
application/json- response
An app's environment variables.
env*Variable name to value. Replacing sets exactly these variables.
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'{ "env": { "property1": "string", "property2": "string" }}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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuidAn app's environment variables.
application/json- body
An app's environment variables.
env*Variable name to value. Replacing sets exactly these variables.
The app's environment variables now
application/json- response
An app's environment variables.
env*Variable name to value. Replacing sets exactly these variables.
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":{}}'{ "env": { "property1": "string", "property2": "string" }}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).
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuidThe app's HTTP settings
application/json- response
An app's HTTP settings.
compression*booleanCompress 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*booleanX-Frame-Options: SAMEORIGIN.
header_nosniff*booleanX-Content-Type-Options: nosniff.
header_referrer_policy*booleanReferrer-Policy: strict-origin-when-cross-origin.
hsts*booleanSend Strict-Transport-Security on HTTPS responses.
hsts_include_subdomains*booleanAdd includeSubDomains to the HSTS header.
hsts_max_age*integerHSTS max-age in seconds.
int64https_redirect*booleanRedirect plain HTTP to HTTPS once a certificate is issued.
max_body_bytes?|Largest accepted request body in bytes; null for no limit.
int64permissions_policy*|||permissions_policy_custom?|The custom Permissions-Policy (used with mode custom).
www_redirect*stringRedirect between a host and its www. form.
"off""to_www""to_apex"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'{ "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"}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).
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuidThe settings to change; omitted fields keep their value.
application/json- 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.
nullcsp_preset?|||Which CSP is sent: the basic or strict preset, or csp_policy.
csp_report_uri?|null or blank clears it.
nullcsrf_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).
int64https_redirect?|Redirect plain HTTP to HTTPS once a certificate is issued.
max_body_bytes?|null removes the limit.
int64nullpermissions_policy?||||Permissions-Policy: off, a preset or permissions_policy_custom.
permissions_policy_custom?|null or blank clears it.
nullwww_redirect?|Redirect between a host and its www. form.
The app's HTTP settings now
application/json- response
An app's HTTP settings.
compression*booleanCompress 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*booleanX-Frame-Options: SAMEORIGIN.
header_nosniff*booleanX-Content-Type-Options: nosniff.
header_referrer_policy*booleanReferrer-Policy: strict-origin-when-cross-origin.
hsts*booleanSend Strict-Transport-Security on HTTPS responses.
hsts_include_subdomains*booleanAdd includeSubDomains to the HSTS header.
hsts_max_age*integerHSTS max-age in seconds.
int64https_redirect*booleanRedirect plain HTTP to HTTPS once a certificate is issued.
max_body_bytes?|Largest accepted request body in bytes; null for no limit.
int64permissions_policy*|||permissions_policy_custom?|The custom Permissions-Policy (used with mode custom).
www_redirect*stringRedirect between a host and its www. form.
"off""to_www""to_apex"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"}'{ "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"}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.
api_keyAuthorizationBearer <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.
cluster_id*stringThe cluster UUID
uuidapp_id*stringThe app UUID
uuidHow many pods an app runs.
application/json- body
How many pods an app runs.
replicas*integerDesired pods.
int32The scaled app
application/json- response
An app, as the public API shows it.
cluster_id*stringThe cluster the app runs on.
uuidcreated_at*stringWhen the app was created (RFC 3339, UTC).
date-timedeploy_id?|The deploy a change started: set only in the response of an update that needed a redeploy (poll GET .../deploys/{id}), else null.
uuidexpected_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*stringThe app id.
uuidimage?|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.
date-timename*stringThe app's name, unique in its project.
port?|The main container port.
int32project_id*stringThe project the app belongs to.
uuidrelease_pinned*booleanThe 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*integerDesired pods.
int32running_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.
uuidstate*stringLifecycle 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.
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}'{ "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"}