IaC
The IaC 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.
List the organization's infra links, oldest first; with path, only the ones reading exactly that repository directory.
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.
cursor?|Opaque cursor from the previous page's next_cursor.
limit?|Page size, 1 to 100 (default 25).
uint0 <= valuepath?|Only the links reading exactly this repository directory (one trailing slash ignored).
The links
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/iac/infra-links' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'{ "data": [ { "branch": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "path": "string", "repository": "string", "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.
Plan an infra link's clusters/*.yaml at a commit: the changes a sync of that commit would make, computed as the sync computes them, without applying or holding anything.
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.
link_id*stringThe infra link UUID
uuidThe commit a plan or sync is for.
application/json- body
The commit a plan or sync is for.
sha*stringThe full commit id (40 lowercase hex characters).
The plan
application/json- response
A dry-run plan of a link's files at one commit.
additions*integerResources a sync would add.
int32diff*unknownThe changes, shaped as the console's plan view and the stored sync diffs show them.
errors*array<string>Declarations a sync would refuse (file: message).
held*integerChanges a sync would hold for confirmation in the console.
int32modifications*integerResources a sync would change.
int32removals*integerResources a sync would remove.
int32sha*stringThe planned commit.
warnings*array<string>What a sync would apply but should be known first (file: key: message).
curl -X POST 'https://api.a-line.cloud/v1/iac/infra-links/00000000-0000-4000-8000-000000000001/plan' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \ -H 'Content-Type: application/json' \ -d '{"sha":"example"}'{ "additions": 0, "diff": null, "errors": [ "string" ], "held": 0, "modifications": 0, "removals": 0, "sha": "string", "warnings": [ "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.
Report an infra link's sync state at a commit (default: the commit synced last), and every change still held for confirmation.
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.
link_id*stringThe infra link UUID
uuidsha?|The commit to report on. Default: the commit synced last.
The link's state
application/json- response
A link's sync state at one commit.
console_url*stringThe link's page in the console.
held_actions*array<>Every change of the link still waiting for confirmation.
last_applied_sha?|The commit the link last applied.
last_checked_sha?|The commit the link last checked.
last_sync_error?|Why the last sync failed.
last_sync_status?|The last sync's outcome (synced or failed).
link_id*stringThe link.
uuidsha?|The commit reported on; null before the first sync.
state*stringpending (not synced yet), applying, applied, failed or held (applied, with changes waiting for confirmation). New values may appear.
curl 'https://api.a-line.cloud/v1/iac/infra-links/00000000-0000-4000-8000-000000000001/status' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'{ "console_url": "string", "held_actions": [ { "console_url": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "string", "reason": "string", "requires": [ "string" ], "sha": "string", "target": null } ], "last_applied_sha": "string", "last_checked_sha": "string", "last_sync_error": "string", "last_sync_status": "string", "link_id": "02a2c2f0-9521-47cc-9615-2e177adeebac", "sha": "string", "state": "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.
Sync an infra link to a commit: applies clusters/*.yaml exactly as of that commit (never the branch tip), holding changes that need confirmation. Poll status_url for the outcome.
The commit must be on the linked branch and descend from the commit the link applied last, or the sync fails.
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.
link_id*stringThe infra link UUID
uuidThe commit a plan or sync is for.
application/json- body
The commit a plan or sync is for.
sha*stringThe full commit id (40 lowercase hex characters).
The sync is queued
application/json- response
A queued sync.
link_id*stringThe link.
uuidsha*stringThe commit the sync applies.
status_url*stringPoll this (GET) for the sync's outcome.
curl -X POST 'https://api.a-line.cloud/v1/iac/infra-links/00000000-0000-4000-8000-000000000001/sync' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \ -H 'Content-Type: application/json' \ -d '{"sha":"example"}'{ "link_id": "02a2c2f0-9521-47cc-9615-2e177adeebac", "sha": "string", "status_url": "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 organization's project links the key may read, oldest first; with path, only the ones reading exactly that repository directory.
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.
cursor?|Opaque cursor from the previous page's next_cursor.
limit?|Page size, 1 to 100 (default 25).
uint0 <= valuepath?|Only the links reading exactly this repository directory (one trailing slash ignored).
The links
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/iac/project-links' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'{ "data": [ { "branch": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "path": "string", "repository": "string", "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.
Plan a project link's project.yaml and apps/ at a commit: the changes a sync of that commit would make, computed as the sync computes them, without applying anything.
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.
link_id*stringThe project link UUID
uuidThe commit a plan or sync is for.
application/json- body
The commit a plan or sync is for.
sha*stringThe full commit id (40 lowercase hex characters).
The plan
application/json- response
A dry-run plan of a link's files at one commit.
additions*integerResources a sync would add.
int32diff*unknownThe changes, shaped as the console's plan view and the stored sync diffs show them.
errors*array<string>Declarations a sync would refuse (file: message).
held*integerChanges a sync would hold for confirmation in the console.
int32modifications*integerResources a sync would change.
int32removals*integerResources a sync would remove.
int32sha*stringThe planned commit.
warnings*array<string>What a sync would apply but should be known first (file: key: message).
curl -X POST 'https://api.a-line.cloud/v1/iac/project-links/00000000-0000-4000-8000-000000000001/plan' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \ -H 'Content-Type: application/json' \ -d '{"sha":"example"}'{ "additions": 0, "diff": null, "errors": [ "string" ], "held": 0, "modifications": 0, "removals": 0, "sha": "string", "warnings": [ "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.
Report a project link's sync state at a commit (default: the commit synced last), and every change still held for confirmation.
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.
link_id*stringThe project link UUID
uuidsha?|The commit to report on. Default: the commit synced last.
The link's state
application/json- response
A link's sync state at one commit.
console_url*stringThe link's page in the console.
held_actions*array<>Every change of the link still waiting for confirmation.
last_applied_sha?|The commit the link last applied.
last_checked_sha?|The commit the link last checked.
last_sync_error?|Why the last sync failed.
last_sync_status?|The last sync's outcome (synced or failed).
link_id*stringThe link.
uuidsha?|The commit reported on; null before the first sync.
state*stringpending (not synced yet), applying, applied, failed or held (applied, with changes waiting for confirmation). New values may appear.
curl 'https://api.a-line.cloud/v1/iac/project-links/00000000-0000-4000-8000-000000000001/status' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'{ "console_url": "string", "held_actions": [ { "console_url": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "string", "reason": "string", "requires": [ "string" ], "sha": "string", "target": null } ], "last_applied_sha": "string", "last_checked_sha": "string", "last_sync_error": "string", "last_sync_status": "string", "link_id": "02a2c2f0-9521-47cc-9615-2e177adeebac", "sha": "string", "state": "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.
Sync a project link to a commit: applies project.yaml and apps/ exactly as of that commit (never the branch tip). Poll status_url for the outcome.
The commit must be on the linked branch and descend from the commit the link applied last, or the sync fails.
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.
link_id*stringThe project link UUID
uuidThe commit a plan or sync is for.
application/json- body
The commit a plan or sync is for.
sha*stringThe full commit id (40 lowercase hex characters).
The sync is queued
application/json- response
A queued sync.
link_id*stringThe link.
uuidsha*stringThe commit the sync applies.
status_url*stringPoll this (GET) for the sync's outcome.
curl -X POST 'https://api.a-line.cloud/v1/iac/project-links/00000000-0000-4000-8000-000000000001/sync' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \ -H 'Content-Type: application/json' \ -d '{"sha":"example"}'{ "link_id": "02a2c2f0-9521-47cc-9615-2e177adeebac", "sha": "string", "status_url": "string"}