Skip to Content

Projects

The projects operations of the v1 API.

GET
/v1/clusters/{cluster_id}/projects

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 projects

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/projects' \  -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",      "display_name": "string",      "egress_mode": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "isolated": true,      "name": "string"    }  ],  "has_more": true,  "next_cursor": "string"}
POST
/v1/clusters/{cluster_id}/projects

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

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 project to create.

application/json
  1. body

A project to create.

display_name*string

The name shown in the dashboard, 1-255 characters.

isolated?boolean

Only explicit app connections may reach an app. Default false; can be switched later. A hosted organization's projects are always isolated.

Defaultfalse
name*string

The project's name, its Kubernetes namespace: lowercase letters, digits and hyphens, 3-63 characters. Unique in the cluster and its environment.

Response Body

The created project

application/json
  1. response

A project, as the public API shows it.

cluster_id*string

The cluster the project belongs to.

Formatuuid
created_at*string

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

Formatdate-time
display_name*string

The name shown in the dashboard.

egress_mode*string

Outbound traffic of its apps: public (any public address) or isolated (only the allowlist). See the project's egress route.

id*string

The project id.

Formatuuid
isolated*boolean

Whether apps in the project cannot reach each other unless connected.

name*string

The project's name (its Kubernetes namespace).

Example Request
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"}'
Example Response
{  "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"}
GET
/v1/clusters/{cluster_id}/projects/{project_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
project_id*string

The project UUID

Formatuuid

Response Body

The project

application/json
  1. response

A project, as the public API shows it.

cluster_id*string

The cluster the project belongs to.

Formatuuid
created_at*string

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

Formatdate-time
display_name*string

The name shown in the dashboard.

egress_mode*string

Outbound traffic of its apps: public (any public address) or isolated (only the allowlist). See the project's egress route.

id*string

The project id.

Formatuuid
isolated*boolean

Whether apps in the project cannot reach each other unless connected.

name*string

The project's name (its Kubernetes namespace).

Example Request
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'
Example Response
{  "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"}
PATCH
/v1/clusters/{cluster_id}/projects/{project_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
project_id*string

The project UUID

Formatuuid

Request Body

Changes to a project; at least one field. The name is fixed at creation; isolated switches the app network.

application/json
  1. 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.

Defaultnull
isolated?|

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.

Defaultnull

Response Body

The updated project

application/json
  1. response

A project, as the public API shows it.

cluster_id*string

The cluster the project belongs to.

Formatuuid
created_at*string

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

Formatdate-time
display_name*string

The name shown in the dashboard.

egress_mode*string

Outbound traffic of its apps: public (any public address) or isolated (only the allowlist). See the project's egress route.

id*string

The project id.

Formatuuid
isolated*boolean

Whether apps in the project cannot reach each other unless connected.

name*string

The project's name (its Kubernetes namespace).

Example Request
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}'
Example Response
{  "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"}
DELETE
/v1/clusters/{cluster_id}/projects/{project_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 hard delete: the project cannot be recovered.

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

The project UUID

Formatuuid

Response Body

Project deleted

Example Request
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'
Example Response
Empty
GET
/v1/clusters/{cluster_id}/projects/{project_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.

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

The project UUID

Formatuuid

Response Body

The project's outbound settings

application/json
  1. response

A project's outbound settings.

mode*string

public (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.

Example Request
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'
Example Response
{  "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}/projects/{project_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.

Re-applies the network policies of the project's deployed apps. API keys need the write scope; no second-factor check applies to them.

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

The project 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 project's outbound settings now

application/json
  1. response

A project's outbound settings.

mode*string

public (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.

Example Request
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":[]}'
Example Response
{  "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}/projects/{project_id}/quotas

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

The project UUID

Formatuuid

Response Body

The limits and usage

application/json
  1. response

A project's quota limits with its current usage.

can_edit*boolean

Whether 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.

Example Request
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'
Example Response
{  "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  }}

On this page