Skip to Content

IaC

The IaC operations of the v1 API.

GET
/v1/iac/infra-links

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.

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.

Query Parameters

cursor?|

Opaque cursor from the previous page's next_cursor.

limit?|

Page size, 1 to 100 (default 25).

Formatuint
Range0 <= value
path?|

Only the links reading exactly this repository directory (one trailing slash ignored).

Response Body

The links

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/iac/infra-links' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "data": [    {      "branch": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "path": "string",      "repository": "string",      "status": "string"    }  ],  "has_more": true,  "next_cursor": "string"}
POST
/v1/iac/infra-links/{link_id}/plan

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.

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

Request Body

The commit a plan or sync is for.

application/json
  1. body

The commit a plan or sync is for.

sha*string

The full commit id (40 lowercase hex characters).

Response Body

The plan

application/json
  1. response

A dry-run plan of a link's files at one commit.

additions*integer

Resources a sync would add.

Formatint32
diff*unknown

The 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*integer

Changes a sync would hold for confirmation in the console.

Formatint32
modifications*integer

Resources a sync would change.

Formatint32
removals*integer

Resources a sync would remove.

Formatint32
sha*string

The planned commit.

warnings*array<string>

What a sync would apply but should be known first (file: key: message).

Example Request
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"}'
Example Response
{  "additions": 0,  "diff": null,  "errors": [    "string"  ],  "held": 0,  "modifications": 0,  "removals": 0,  "sha": "string",  "warnings": [    "string"  ]}
GET
/v1/iac/infra-links/{link_id}/status

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.

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

Query Parameters

sha?|

The commit to report on. Default: the commit synced last.

Response Body

The link's state

application/json
  1. response

A link's sync state at one commit.

console_url*string

The 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*string

The link.

Formatuuid
sha?|

The commit reported on; null before the first sync.

state*string

pending (not synced yet), applying, applied, failed or held (applied, with changes waiting for confirmation). New values may appear.

Example Request
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'
Example Response
{  "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"}
POST
/v1/iac/infra-links/{link_id}/sync

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.

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

Request Body

The commit a plan or sync is for.

application/json
  1. body

The commit a plan or sync is for.

sha*string

The full commit id (40 lowercase hex characters).

Response Body

The sync is queued

application/json
  1. response

A queued sync.

link_id*string

The link.

Formatuuid
sha*string

The commit the sync applies.

status_url*string

Poll this (GET) for the sync's outcome.

Example Request
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"}'
Example Response
{  "link_id": "02a2c2f0-9521-47cc-9615-2e177adeebac",  "sha": "string",  "status_url": "string"}
GET
/v1/iac/project-links

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.

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.

Query Parameters

cursor?|

Opaque cursor from the previous page's next_cursor.

limit?|

Page size, 1 to 100 (default 25).

Formatuint
Range0 <= value
path?|

Only the links reading exactly this repository directory (one trailing slash ignored).

Response Body

The links

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/iac/project-links' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "data": [    {      "branch": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "path": "string",      "repository": "string",      "status": "string"    }  ],  "has_more": true,  "next_cursor": "string"}
POST
/v1/iac/project-links/{link_id}/plan

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.

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

Request Body

The commit a plan or sync is for.

application/json
  1. body

The commit a plan or sync is for.

sha*string

The full commit id (40 lowercase hex characters).

Response Body

The plan

application/json
  1. response

A dry-run plan of a link's files at one commit.

additions*integer

Resources a sync would add.

Formatint32
diff*unknown

The 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*integer

Changes a sync would hold for confirmation in the console.

Formatint32
modifications*integer

Resources a sync would change.

Formatint32
removals*integer

Resources a sync would remove.

Formatint32
sha*string

The planned commit.

warnings*array<string>

What a sync would apply but should be known first (file: key: message).

Example Request
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"}'
Example Response
{  "additions": 0,  "diff": null,  "errors": [    "string"  ],  "held": 0,  "modifications": 0,  "removals": 0,  "sha": "string",  "warnings": [    "string"  ]}
GET
/v1/iac/project-links/{link_id}/status

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.

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

Query Parameters

sha?|

The commit to report on. Default: the commit synced last.

Response Body

The link's state

application/json
  1. response

A link's sync state at one commit.

console_url*string

The 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*string

The link.

Formatuuid
sha?|

The commit reported on; null before the first sync.

state*string

pending (not synced yet), applying, applied, failed or held (applied, with changes waiting for confirmation). New values may appear.

Example Request
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'
Example Response
{  "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"}
POST
/v1/iac/project-links/{link_id}/sync

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.

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

Request Body

The commit a plan or sync is for.

application/json
  1. body

The commit a plan or sync is for.

sha*string

The full commit id (40 lowercase hex characters).

Response Body

The sync is queued

application/json
  1. response

A queued sync.

link_id*string

The link.

Formatuuid
sha*string

The commit the sync applies.

status_url*string

Poll this (GET) for the sync's outcome.

Example Request
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"}'
Example Response
{  "link_id": "02a2c2f0-9521-47cc-9615-2e177adeebac",  "sha": "string",  "status_url": "string"}

On this page