Projects
The projects 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 projects
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/projects' \ -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", "display_name": "string", "egress_mode": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "isolated": true, "name": "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
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 project to create.
application/json- body
A project to create.
display_name*stringThe name shown in the dashboard, 1-255 characters.
isolated?booleanOnly explicit app connections may reach an app. Default false; can be switched later. A hosted organization's projects are always isolated.
falsename*stringThe project's name, its Kubernetes namespace: lowercase letters, digits and hyphens, 3-63 characters. Unique in the cluster and its environment.
The created project
application/json- response
A project, as the public API shows it.
cluster_id*stringThe cluster the project belongs to.
uuidcreated_at*stringWhen the project was created (RFC 3339, UTC).
date-timedisplay_name*stringThe name shown in the dashboard.
egress_mode*stringOutbound traffic of its apps: public (any public address) or isolated (only the allowlist). See the project's egress route.
id*stringThe project id.
uuidisolated*booleanWhether apps in the project cannot reach each other unless connected.
name*stringThe project's name (its Kubernetes namespace).
curl -X POST 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/projects' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \ -H 'Content-Type: application/json' \ -d '{"display_name":"example","name":"example"}'{ "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616", "created_at": "2019-08-24T14:15:22Z", "display_name": "string", "egress_mode": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "isolated": true, "name": "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
uuidproject_id*stringThe project UUID
uuidThe project
application/json- response
A project, as the public API shows it.
cluster_id*stringThe cluster the project belongs to.
uuidcreated_at*stringWhen the project was created (RFC 3339, UTC).
date-timedisplay_name*stringThe name shown in the dashboard.
egress_mode*stringOutbound traffic of its apps: public (any public address) or isolated (only the allowlist). See the project's egress route.
id*stringThe project id.
uuidisolated*booleanWhether apps in the project cannot reach each other unless connected.
name*stringThe project's name (its Kubernetes namespace).
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/projects/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", "display_name": "string", "egress_mode": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "isolated": true, "name": "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
uuidproject_id*stringThe project UUID
uuidChanges to a project; at least one field. The name is fixed at creation; isolated switches the app network.
application/json- body
Changes to a project; at least one field. The name is fixed at creation; isolated switches the app network.
display_name?|The new name shown in the dashboard, 1-255 characters.
nullisolated?|Switch isolation. Turning it on blocks traffic between the project's apps that are not declared as connections; the namespace's network policies follow within a minute. A hosted organization's projects stay isolated.
nullThe updated project
application/json- response
A project, as the public API shows it.
cluster_id*stringThe cluster the project belongs to.
uuidcreated_at*stringWhen the project was created (RFC 3339, UTC).
date-timedisplay_name*stringThe name shown in the dashboard.
egress_mode*stringOutbound traffic of its apps: public (any public address) or isolated (only the allowlist). See the project's egress route.
id*stringThe project id.
uuidisolated*booleanWhether apps in the project cannot reach each other unless connected.
name*stringThe project's name (its Kubernetes namespace).
curl -X PATCH 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/projects/00000000-0000-4000-8000-000000000002' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \ -H 'Content-Type: application/json' \ -d '{"display_name":"example","isolated":false}'{ "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616", "created_at": "2019-08-24T14:15:22Z", "display_name": "string", "egress_mode": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "isolated": true, "name": "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 hard delete: the project cannot be recovered.
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
uuidproject_id*stringThe project UUID
uuidProject deleted
curl -X DELETE 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/projects/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.
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
uuidproject_id*stringThe project UUID
uuidThe project's outbound settings
application/json- response
A project's outbound settings.
mode*stringpublic (any public address except TCP 25, plus the allowlist) or isolated (only the allowlist and the platform endpoints).
rules*array<>The project's allowlist, which also applies to every app in it.
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/projects/00000000-0000-4000-8000-000000000002/egress' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'{ "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.
Re-applies the network policies of the project's deployed apps. API keys need the write scope; no second-factor check applies to them.
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
uuidproject_id*stringThe project 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 project's outbound settings now
application/json- response
A project's outbound settings.
mode*stringpublic (any public address except TCP 25, plus the allowlist) or isolated (only the allowlist and the platform endpoints).
rules*array<>The project's allowlist, which also applies to every app in it.
curl -X PUT 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/projects/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":[]}'{ "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.
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
uuidproject_id*stringThe project UUID
uuidThe limits and usage
application/json- response
A project's quota limits with its current usage.
can_edit*booleanWhether the key's user may change the limits (tenant owners and admins).
limits*The limits as set.
usage*What the project's apps use now.
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/projects/00000000-0000-4000-8000-000000000002/quotas' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'{ "can_edit": true, "limits": { "cpu": "string", "memory": "string", "pods": 0, "pvcs": 0, "storage": "string" }, "usage": { "cpu_millis": 0, "memory_bytes": 0, "pods": 0, "pvcs": 0, "storage_bytes": 0 }}