Skip to Content

Domains

The domains operations of the v1 API.

GET
/v1/clusters/{cluster_id}/apps/{app_id}/domains

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

The app 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 domains

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/apps/00000000-0000-4000-8000-000000000002/domains' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "data": [    {      "acme_delegation": {        "cname_target": "string",        "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",        "error": "string",        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "last_checked_at": "2019-08-24T14:15:22Z",        "record_name": "string",        "status": "string"      },      "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",      "behind_proxy": true,      "client_ip_header": "string",      "created_at": "2019-08-24T14:15:22Z",      "dns_records": [        {          "name": "string",          "type": "string",          "value": "string"        }      ],      "dns_target": "a_records",      "domain": "string",      "external_port": 0,      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "origin_lock": {        "created_at": "2019-08-24T14:15:22Z",        "fingerprint": "string",        "previous_expires_at": "2019-08-24T14:15:22Z",        "previous_fingerprint": "string",        "unlocked_hosts": [          "string"        ]      },      "path_prefix": "string",      "platform": true,      "port": 0,      "protocol": "string",      "proxy_protocol": true,      "route_error": "string",      "route_state": "string",      "service_name": "string",      "strip_prefix": true,      "tls_enabled": true,      "tls_error": "string",      "tls_expires_at": "2019-08-24T14:15:22Z",      "tls_reason": "string",      "tls_state": "string",      "verification": {        "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",        "name": "string",        "scope": "string",        "status": "string"      },      "wildcard": true    }  ],  "has_more": true,  "next_cursor": "string"}
POST
/v1/clusters/{cluster_id}/apps/{app_id}/domains

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.

An organization domain must cover the host (or one being verified, with pending_verification).

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

The app UUID

Formatuuid

Request Body

A domain to add to an app.

application/json
  1. body

A domain to add to an app.

behind_proxy?boolean

Served through a CDN or reverse proxy (HTTP and HTTPS routes only). Ownership is still proven by the TXT verification.

Defaultfalse
dns_target?|
domain*string

The host name; an organization domain must cover it.

external_port?integer

The port the load balancer listens on (default 443).

Formatint32
Default443
path_prefix?string

The path prefix to route (default /).

Default"/"
pending_verification?boolean

Accept a host only a domain still being verified covers; it routes once that verifies.

Defaultfalse
port*integer

The container port to route to.

Formatint32
protocol?string

http, https (default), tcp, udp or tls (TLS passthrough by SNI on 443).

Default"https"
proxy_protocol?boolean

Prefix each connection with a PROXY protocol header carrying the client address (TCP only; the app must expect the header).

Defaultfalse
service_name?|

A Kubernetes service to target instead of the app's own.

Defaultnull
strip_prefix?boolean

Strip the prefix before forwarding (default false).

Defaultfalse
tls_enabled?boolean

Terminate TLS (default true).

Defaulttrue
wildcard?boolean

Also route every subdomain (HTTP(S) only, needs a whole-domain verification).

Defaultfalse

Response Body

The domain was added

application/json
  1. response

A domain routed to an app.

acme_delegation?|

The name's ACME challenge delegation, when it has one: with <record_name> CNAME <cname_target> in place the certificate is issued over DNS-01. The CNAME lets the platform get certificates for the name while it exists: delete it once the delegation is removed.

app_id*string

The app it routes to.

Formatuuid
behind_proxy*boolean

Served through a CDN or reverse proxy: the DNS check fetches the domain end to end instead of matching load balancer addresses.

client_ip_header?|

The proxy header carrying the client IP, passed to the app only while the origin lock is on.

created_at*string

When the domain was added (RFC 3339, UTC).

Formatdate-time
dns_records*array<>

The records to create at the customer's DNS provider.

dns_target*|
domain*string

The host name.

external_port*integer

The port the load balancer listens on.

Formatint32
id*string

The domain id.

Formatuuid
origin_lock?|

While behind a proxy: the origin lock (fingerprints only); null when off.

path_prefix*string

The path prefix routed.

platform*boolean

A hostname the platform issued (temporary URL or generated host).

port*integer

The container port traffic goes to.

Formatint32
protocol*string

http, https, tcp, udp or tls (TLS passthrough by SNI on 443).

proxy_protocol*boolean

A TCP port whose connections start with a PROXY protocol header.

route_error?|

Why routing failed.

route_state*string

Routing state: pending, live, waiting_deploy, failed or unknown.

service_name?|

The Kubernetes service targeted, when not the app's own.

strip_prefix*boolean

Whether the prefix is stripped before forwarding.

tls_enabled*boolean

Whether TLS is terminated for the host.

tls_error?|

Why the certificate failed, or a plain line about a temporary URL's pending wildcard.

tls_expires_at?|

When the certificate expires.

Formatdate-time
tls_reason?|

A temporary URL whose wildcard is pending: cert-manager's reason, one line without URLs.

tls_state?|

Certificate state: pending, issued, failed, not_applicable or null.

verification?|

Set while the host waits on an organization domain to verify.

wildcard*boolean

Also routes every subdomain (*.<domain>).

Example Request
curl -X POST 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/domains' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"domain":"example","port":1}'
Example Response
{  "acme_delegation": {    "cname_target": "string",    "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",    "error": "string",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "last_checked_at": "2019-08-24T14:15:22Z",    "record_name": "string",    "status": "string"  },  "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",  "behind_proxy": true,  "client_ip_header": "string",  "created_at": "2019-08-24T14:15:22Z",  "dns_records": [    {      "name": "string",      "type": "string",      "value": "string"    }  ],  "dns_target": "a_records",  "domain": "string",  "external_port": 0,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "origin_lock": {    "created_at": "2019-08-24T14:15:22Z",    "fingerprint": "string",    "previous_expires_at": "2019-08-24T14:15:22Z",    "previous_fingerprint": "string",    "unlocked_hosts": [      "string"    ]  },  "path_prefix": "string",  "platform": true,  "port": 0,  "protocol": "string",  "proxy_protocol": true,  "route_error": "string",  "route_state": "string",  "service_name": "string",  "strip_prefix": true,  "tls_enabled": true,  "tls_error": "string",  "tls_expires_at": "2019-08-24T14:15:22Z",  "tls_reason": "string",  "tls_state": "string",  "verification": {    "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",    "name": "string",    "scope": "string",    "status": "string"  },  "wildcard": true}
GET
/v1/clusters/{cluster_id}/apps/{app_id}/domains/{domain_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
app_id*string

The app UUID

Formatuuid
domain_id*string

The domain UUID

Formatuuid

Response Body

The domain

application/json
  1. response

A domain routed to an app.

acme_delegation?|

The name's ACME challenge delegation, when it has one: with <record_name> CNAME <cname_target> in place the certificate is issued over DNS-01. The CNAME lets the platform get certificates for the name while it exists: delete it once the delegation is removed.

app_id*string

The app it routes to.

Formatuuid
behind_proxy*boolean

Served through a CDN or reverse proxy: the DNS check fetches the domain end to end instead of matching load balancer addresses.

client_ip_header?|

The proxy header carrying the client IP, passed to the app only while the origin lock is on.

created_at*string

When the domain was added (RFC 3339, UTC).

Formatdate-time
dns_records*array<>

The records to create at the customer's DNS provider.

dns_target*|
domain*string

The host name.

external_port*integer

The port the load balancer listens on.

Formatint32
id*string

The domain id.

Formatuuid
origin_lock?|

While behind a proxy: the origin lock (fingerprints only); null when off.

path_prefix*string

The path prefix routed.

platform*boolean

A hostname the platform issued (temporary URL or generated host).

port*integer

The container port traffic goes to.

Formatint32
protocol*string

http, https, tcp, udp or tls (TLS passthrough by SNI on 443).

proxy_protocol*boolean

A TCP port whose connections start with a PROXY protocol header.

route_error?|

Why routing failed.

route_state*string

Routing state: pending, live, waiting_deploy, failed or unknown.

service_name?|

The Kubernetes service targeted, when not the app's own.

strip_prefix*boolean

Whether the prefix is stripped before forwarding.

tls_enabled*boolean

Whether TLS is terminated for the host.

tls_error?|

Why the certificate failed, or a plain line about a temporary URL's pending wildcard.

tls_expires_at?|

When the certificate expires.

Formatdate-time
tls_reason?|

A temporary URL whose wildcard is pending: cert-manager's reason, one line without URLs.

tls_state?|

Certificate state: pending, issued, failed, not_applicable or null.

verification?|

Set while the host waits on an organization domain to verify.

wildcard*boolean

Also routes every subdomain (*.<domain>).

Example Request
curl 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/domains/00000000-0000-4000-8000-000000000003' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "acme_delegation": {    "cname_target": "string",    "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",    "error": "string",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "last_checked_at": "2019-08-24T14:15:22Z",    "record_name": "string",    "status": "string"  },  "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",  "behind_proxy": true,  "client_ip_header": "string",  "created_at": "2019-08-24T14:15:22Z",  "dns_records": [    {      "name": "string",      "type": "string",      "value": "string"    }  ],  "dns_target": "a_records",  "domain": "string",  "external_port": 0,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "origin_lock": {    "created_at": "2019-08-24T14:15:22Z",    "fingerprint": "string",    "previous_expires_at": "2019-08-24T14:15:22Z",    "previous_fingerprint": "string",    "unlocked_hosts": [      "string"    ]  },  "path_prefix": "string",  "platform": true,  "port": 0,  "protocol": "string",  "proxy_protocol": true,  "route_error": "string",  "route_state": "string",  "service_name": "string",  "strip_prefix": true,  "tls_enabled": true,  "tls_error": "string",  "tls_expires_at": "2019-08-24T14:15:22Z",  "tls_reason": "string",  "tls_state": "string",  "verification": {    "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",    "name": "string",    "scope": "string",    "status": "string"  },  "wildcard": true}
PATCH
/v1/clusters/{cluster_id}/apps/{app_id}/domains/{domain_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
app_id*string

The app UUID

Formatuuid
domain_id*string

The domain UUID

Formatuuid

Request Body

The fields to change; a field left out keeps its value.

application/json
  1. body

The fields to change; a field left out keeps its value.

behind_proxy?|

Served through a CDN or reverse proxy (HTTP and HTTPS routes only). Turning it off also turns the origin lock off and clears the client IP header.

Defaultnull

Response Body

The changed domain

application/json
  1. response

A domain routed to an app.

acme_delegation?|

The name's ACME challenge delegation, when it has one: with <record_name> CNAME <cname_target> in place the certificate is issued over DNS-01. The CNAME lets the platform get certificates for the name while it exists: delete it once the delegation is removed.

app_id*string

The app it routes to.

Formatuuid
behind_proxy*boolean

Served through a CDN or reverse proxy: the DNS check fetches the domain end to end instead of matching load balancer addresses.

client_ip_header?|

The proxy header carrying the client IP, passed to the app only while the origin lock is on.

created_at*string

When the domain was added (RFC 3339, UTC).

Formatdate-time
dns_records*array<>

The records to create at the customer's DNS provider.

dns_target*|
domain*string

The host name.

external_port*integer

The port the load balancer listens on.

Formatint32
id*string

The domain id.

Formatuuid
origin_lock?|

While behind a proxy: the origin lock (fingerprints only); null when off.

path_prefix*string

The path prefix routed.

platform*boolean

A hostname the platform issued (temporary URL or generated host).

port*integer

The container port traffic goes to.

Formatint32
protocol*string

http, https, tcp, udp or tls (TLS passthrough by SNI on 443).

proxy_protocol*boolean

A TCP port whose connections start with a PROXY protocol header.

route_error?|

Why routing failed.

route_state*string

Routing state: pending, live, waiting_deploy, failed or unknown.

service_name?|

The Kubernetes service targeted, when not the app's own.

strip_prefix*boolean

Whether the prefix is stripped before forwarding.

tls_enabled*boolean

Whether TLS is terminated for the host.

tls_error?|

Why the certificate failed, or a plain line about a temporary URL's pending wildcard.

tls_expires_at?|

When the certificate expires.

Formatdate-time
tls_reason?|

A temporary URL whose wildcard is pending: cert-manager's reason, one line without URLs.

tls_state?|

Certificate state: pending, issued, failed, not_applicable or null.

verification?|

Set while the host waits on an organization domain to verify.

wildcard*boolean

Also routes every subdomain (*.<domain>).

Example Request
curl -X PATCH 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/domains/00000000-0000-4000-8000-000000000003' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"behind_proxy":false}'
Example Response
{  "acme_delegation": {    "cname_target": "string",    "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",    "error": "string",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "last_checked_at": "2019-08-24T14:15:22Z",    "record_name": "string",    "status": "string"  },  "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",  "behind_proxy": true,  "client_ip_header": "string",  "created_at": "2019-08-24T14:15:22Z",  "dns_records": [    {      "name": "string",      "type": "string",      "value": "string"    }  ],  "dns_target": "a_records",  "domain": "string",  "external_port": 0,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "origin_lock": {    "created_at": "2019-08-24T14:15:22Z",    "fingerprint": "string",    "previous_expires_at": "2019-08-24T14:15:22Z",    "previous_fingerprint": "string",    "unlocked_hosts": [      "string"    ]  },  "path_prefix": "string",  "platform": true,  "port": 0,  "protocol": "string",  "proxy_protocol": true,  "route_error": "string",  "route_state": "string",  "service_name": "string",  "strip_prefix": true,  "tls_enabled": true,  "tls_error": "string",  "tls_expires_at": "2019-08-24T14:15:22Z",  "tls_reason": "string",  "tls_state": "string",  "verification": {    "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",    "name": "string",    "scope": "string",    "status": "string"  },  "wildcard": true}
DELETE
/v1/clusters/{cluster_id}/apps/{app_id}/domains/{domain_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
app_id*string

The app UUID

Formatuuid
domain_id*string

The domain UUID

Formatuuid

Response Body

The domain was removed

Example Request
curl -X DELETE 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/domains/00000000-0000-4000-8000-000000000003' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
Empty
PUT
/v1/clusters/{cluster_id}/apps/{app_id}/domains/{domain_id}/client-ip-header

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.

Set the header a domain's proxy puts the client IP in; passed to the app only while the origin lock is on.

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

The app UUID

Formatuuid
domain_id*string

The domain UUID

Formatuuid

Request Body

The client-IP header of a domain behind a proxy.

application/json
  1. body

The client-IP header of a domain behind a proxy.

header?|

CF-Connecting-IP, True-Client-IP, Fastly-Client-IP or another header name; null or empty clears it.

Defaultnull

Response Body

The domain with its client IP header

application/json
  1. response

A domain routed to an app.

acme_delegation?|

The name's ACME challenge delegation, when it has one: with <record_name> CNAME <cname_target> in place the certificate is issued over DNS-01. The CNAME lets the platform get certificates for the name while it exists: delete it once the delegation is removed.

app_id*string

The app it routes to.

Formatuuid
behind_proxy*boolean

Served through a CDN or reverse proxy: the DNS check fetches the domain end to end instead of matching load balancer addresses.

client_ip_header?|

The proxy header carrying the client IP, passed to the app only while the origin lock is on.

created_at*string

When the domain was added (RFC 3339, UTC).

Formatdate-time
dns_records*array<>

The records to create at the customer's DNS provider.

dns_target*|
domain*string

The host name.

external_port*integer

The port the load balancer listens on.

Formatint32
id*string

The domain id.

Formatuuid
origin_lock?|

While behind a proxy: the origin lock (fingerprints only); null when off.

path_prefix*string

The path prefix routed.

platform*boolean

A hostname the platform issued (temporary URL or generated host).

port*integer

The container port traffic goes to.

Formatint32
protocol*string

http, https, tcp, udp or tls (TLS passthrough by SNI on 443).

proxy_protocol*boolean

A TCP port whose connections start with a PROXY protocol header.

route_error?|

Why routing failed.

route_state*string

Routing state: pending, live, waiting_deploy, failed or unknown.

service_name?|

The Kubernetes service targeted, when not the app's own.

strip_prefix*boolean

Whether the prefix is stripped before forwarding.

tls_enabled*boolean

Whether TLS is terminated for the host.

tls_error?|

Why the certificate failed, or a plain line about a temporary URL's pending wildcard.

tls_expires_at?|

When the certificate expires.

Formatdate-time
tls_reason?|

A temporary URL whose wildcard is pending: cert-manager's reason, one line without URLs.

tls_state?|

Certificate state: pending, issued, failed, not_applicable or null.

verification?|

Set while the host waits on an organization domain to verify.

wildcard*boolean

Also routes every subdomain (*.<domain>).

Example Request
curl -X PUT 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/domains/00000000-0000-4000-8000-000000000003/client-ip-header' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"header":"example"}'
Example Response
{  "acme_delegation": {    "cname_target": "string",    "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",    "error": "string",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "last_checked_at": "2019-08-24T14:15:22Z",    "record_name": "string",    "status": "string"  },  "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",  "behind_proxy": true,  "client_ip_header": "string",  "created_at": "2019-08-24T14:15:22Z",  "dns_records": [    {      "name": "string",      "type": "string",      "value": "string"    }  ],  "dns_target": "a_records",  "domain": "string",  "external_port": 0,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "origin_lock": {    "created_at": "2019-08-24T14:15:22Z",    "fingerprint": "string",    "previous_expires_at": "2019-08-24T14:15:22Z",    "previous_fingerprint": "string",    "unlocked_hosts": [      "string"    ]  },  "path_prefix": "string",  "platform": true,  "port": 0,  "protocol": "string",  "proxy_protocol": true,  "route_error": "string",  "route_state": "string",  "service_name": "string",  "strip_prefix": true,  "tls_enabled": true,  "tls_error": "string",  "tls_expires_at": "2019-08-24T14:15:22Z",  "tls_reason": "string",  "tls_state": "string",  "verification": {    "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",    "name": "string",    "scope": "string",    "status": "string"  },  "wildcard": true}
POST
/v1/clusters/{cluster_id}/apps/{app_id}/domains/{domain_id}/origin-lock

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.

Requests without the key in X-Aline-Origin-Key are refused with 403, and the proxy's client-IP header reaches the app only while locked. The key is answered this once.

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

The app UUID

Formatuuid
domain_id*string

The domain UUID

Formatuuid

Response Body

The new key, shown once, and the domain

application/json
  1. response

A new origin key, answered this once.

domain*

The domain with its lock.

header*string

The request header to send it in (X-Aline-Origin-Key).

key*string

The key for the proxy to send.

Example Request
curl -X POST 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/domains/00000000-0000-4000-8000-000000000003/origin-lock' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "domain": {    "acme_delegation": {      "cname_target": "string",      "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",      "error": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "last_checked_at": "2019-08-24T14:15:22Z",      "record_name": "string",      "status": "string"    },    "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",    "behind_proxy": true,    "client_ip_header": "string",    "created_at": "2019-08-24T14:15:22Z",    "dns_records": [      {        "name": "string",        "type": "string",        "value": "string"      }    ],    "dns_target": "a_records",    "domain": "string",    "external_port": 0,    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "origin_lock": {      "created_at": "2019-08-24T14:15:22Z",      "fingerprint": "string",      "previous_expires_at": "2019-08-24T14:15:22Z",      "previous_fingerprint": "string",      "unlocked_hosts": [        "string"      ]    },    "path_prefix": "string",    "platform": true,    "port": 0,    "protocol": "string",    "proxy_protocol": true,    "route_error": "string",    "route_state": "string",    "service_name": "string",    "strip_prefix": true,    "tls_enabled": true,    "tls_error": "string",    "tls_expires_at": "2019-08-24T14:15:22Z",    "tls_reason": "string",    "tls_state": "string",    "verification": {      "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",      "name": "string",      "scope": "string",      "status": "string"    },    "wildcard": true  },  "header": "string",  "key": "string"}
DELETE
/v1/clusters/{cluster_id}/apps/{app_id}/domains/{domain_id}/origin-lock

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.

Turn off a domain's origin lock; every key stops working.

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

The app UUID

Formatuuid
domain_id*string

The domain UUID

Formatuuid

Response Body

The domain, unlocked

application/json
  1. response

A domain routed to an app.

acme_delegation?|

The name's ACME challenge delegation, when it has one: with <record_name> CNAME <cname_target> in place the certificate is issued over DNS-01. The CNAME lets the platform get certificates for the name while it exists: delete it once the delegation is removed.

app_id*string

The app it routes to.

Formatuuid
behind_proxy*boolean

Served through a CDN or reverse proxy: the DNS check fetches the domain end to end instead of matching load balancer addresses.

client_ip_header?|

The proxy header carrying the client IP, passed to the app only while the origin lock is on.

created_at*string

When the domain was added (RFC 3339, UTC).

Formatdate-time
dns_records*array<>

The records to create at the customer's DNS provider.

dns_target*|
domain*string

The host name.

external_port*integer

The port the load balancer listens on.

Formatint32
id*string

The domain id.

Formatuuid
origin_lock?|

While behind a proxy: the origin lock (fingerprints only); null when off.

path_prefix*string

The path prefix routed.

platform*boolean

A hostname the platform issued (temporary URL or generated host).

port*integer

The container port traffic goes to.

Formatint32
protocol*string

http, https, tcp, udp or tls (TLS passthrough by SNI on 443).

proxy_protocol*boolean

A TCP port whose connections start with a PROXY protocol header.

route_error?|

Why routing failed.

route_state*string

Routing state: pending, live, waiting_deploy, failed or unknown.

service_name?|

The Kubernetes service targeted, when not the app's own.

strip_prefix*boolean

Whether the prefix is stripped before forwarding.

tls_enabled*boolean

Whether TLS is terminated for the host.

tls_error?|

Why the certificate failed, or a plain line about a temporary URL's pending wildcard.

tls_expires_at?|

When the certificate expires.

Formatdate-time
tls_reason?|

A temporary URL whose wildcard is pending: cert-manager's reason, one line without URLs.

tls_state?|

Certificate state: pending, issued, failed, not_applicable or null.

verification?|

Set while the host waits on an organization domain to verify.

wildcard*boolean

Also routes every subdomain (*.<domain>).

Example Request
curl -X DELETE 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/domains/00000000-0000-4000-8000-000000000003/origin-lock' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "acme_delegation": {    "cname_target": "string",    "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",    "error": "string",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "last_checked_at": "2019-08-24T14:15:22Z",    "record_name": "string",    "status": "string"  },  "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",  "behind_proxy": true,  "client_ip_header": "string",  "created_at": "2019-08-24T14:15:22Z",  "dns_records": [    {      "name": "string",      "type": "string",      "value": "string"    }  ],  "dns_target": "a_records",  "domain": "string",  "external_port": 0,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "origin_lock": {    "created_at": "2019-08-24T14:15:22Z",    "fingerprint": "string",    "previous_expires_at": "2019-08-24T14:15:22Z",    "previous_fingerprint": "string",    "unlocked_hosts": [      "string"    ]  },  "path_prefix": "string",  "platform": true,  "port": 0,  "protocol": "string",  "proxy_protocol": true,  "route_error": "string",  "route_state": "string",  "service_name": "string",  "strip_prefix": true,  "tls_enabled": true,  "tls_error": "string",  "tls_expires_at": "2019-08-24T14:15:22Z",  "tls_reason": "string",  "tls_state": "string",  "verification": {    "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",    "name": "string",    "scope": "string",    "status": "string"  },  "wildcard": true}
POST
/v1/clusters/{cluster_id}/apps/{app_id}/domains/{domain_id}/origin-lock/rotate

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 new key is answered this once; the previous one keeps working for 24 hours.

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

The app UUID

Formatuuid
domain_id*string

The domain UUID

Formatuuid

Response Body

The new key, shown once, and the domain

application/json
  1. response

A new origin key, answered this once.

domain*

The domain with its lock.

header*string

The request header to send it in (X-Aline-Origin-Key).

key*string

The key for the proxy to send.

Example Request
curl -X POST 'https://api.a-line.cloud/v1/clusters/00000000-0000-4000-8000-000000000001/apps/00000000-0000-4000-8000-000000000002/domains/00000000-0000-4000-8000-000000000003/origin-lock/rotate' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "domain": {    "acme_delegation": {      "cname_target": "string",      "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",      "error": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "last_checked_at": "2019-08-24T14:15:22Z",      "record_name": "string",      "status": "string"    },    "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",    "behind_proxy": true,    "client_ip_header": "string",    "created_at": "2019-08-24T14:15:22Z",    "dns_records": [      {        "name": "string",        "type": "string",        "value": "string"      }    ],    "dns_target": "a_records",    "domain": "string",    "external_port": 0,    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "origin_lock": {      "created_at": "2019-08-24T14:15:22Z",      "fingerprint": "string",      "previous_expires_at": "2019-08-24T14:15:22Z",      "previous_fingerprint": "string",      "unlocked_hosts": [        "string"      ]    },    "path_prefix": "string",    "platform": true,    "port": 0,    "protocol": "string",    "proxy_protocol": true,    "route_error": "string",    "route_state": "string",    "service_name": "string",    "strip_prefix": true,    "tls_enabled": true,    "tls_error": "string",    "tls_expires_at": "2019-08-24T14:15:22Z",    "tls_reason": "string",    "tls_state": "string",    "verification": {      "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",      "name": "string",      "scope": "string",      "status": "string"    },    "wildcard": true  },  "header": "string",  "key": "string"}
GET
/v1/domains

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.

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 domains

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/domains' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "error": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "last_checked_at": "2019-08-24T14:15:22Z",      "name": "string",      "scope": "string",      "status": "string",      "txt_name": "string",      "txt_value": "string",      "verified_at": "2019-08-24T14:15:22Z"    }  ],  "has_more": true,  "next_cursor": "string"}
GET
/v1/domains/{domain_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

domain_id*string

The domain UUID

Formatuuid

Response Body

The domain

application/json
  1. response

An organization domain and the TXT record that proves it.

created_at*string

When it was added.

Formatdate-time
error?|

Why the last check failed.

id*string

The domain id.

Formatuuid
last_checked_at?|

When it was last checked.

Formatdate-time
name*string

The domain name.

scope*string

domain (the name and its subdomains) or host (the name only).

status*string

pending, verified or failed.

txt_name*string

Name of the TXT record to publish.

txt_value*string

Value of that TXT record.

verified_at?|

When the domain verified (RFC 3339, UTC).

Formatdate-time
Example Request
curl 'https://api.a-line.cloud/v1/domains/00000000-0000-4000-8000-000000000001' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "error": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "last_checked_at": "2019-08-24T14:15:22Z",  "name": "string",  "scope": "string",  "status": "string",  "txt_name": "string",  "txt_value": "string",  "verified_at": "2019-08-24T14:15:22Z"}
GET
/v1/hosted-zones

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. Empty on an installation without hosted DNS.

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

Response Body

A page of zones

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/hosted-zones' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "delegated": true,      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "nameservers": [        "string"      ],      "status": "string",      "txt_name": "string",      "txt_value": "string",      "verified_at": "2019-08-24T14:15:22Z"    }  ],  "has_more": true,  "next_cursor": "string"}
GET
/v1/hosted-zones/{zone_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

zone_id*string

The zone UUID

Formatuuid

Response Body

The zone

application/json
  1. response

A hosted zone (or a claim on one still being verified).

created_at*string

When the claim was made (RFC 3339, UTC).

Formatdate-time
delegated?|

Whether the zone is delegated to them (null before the first check).

id*string

The zone id.

Formatuuid
name*string

The zone name (example.com).

nameservers*array<string>

The nameservers to delegate the zone to.

status*string

pending, verified or failed.

txt_name*string

The TXT record name proving ownership.

txt_value*string

The TXT record value.

verified_at?|

When the zone verified.

Formatdate-time
Example Request
curl 'https://api.a-line.cloud/v1/hosted-zones/00000000-0000-4000-8000-000000000001' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "created_at": "2019-08-24T14:15:22Z",  "delegated": true,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "nameservers": [    "string"  ],  "status": "string",  "txt_name": "string",  "txt_value": "string",  "verified_at": "2019-08-24T14:15:22Z"}
GET
/v1/hosted-zones/{zone_id}/records

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 name, then type. 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

zone_id*string

The zone 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 record sets

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/hosted-zones/00000000-0000-4000-8000-000000000001/records' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
{  "data": [    {      "name": "string",      "records": [        "string"      ],      "ttl": 0,      "type": "string"    }  ],  "has_more": true,  "next_cursor": "string"}
PUT
/v1/hosted-zones/{zone_id}/records

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

zone_id*string

The zone UUID

Formatuuid

Request Body

A record set: every record of one name and type.

application/json
  1. body

A record set: every record of one name and type.

name*string

The owner name, fully qualified without the trailing dot (www.example.com).

records*array<string>

The record values, in zone-file presentation format.

ttl*integer

Time to live in seconds.

Formatuint32
Range0 <= value
type*string

The record type (A, AAAA, CNAME, TXT, MX, ...).

Response Body

The record set was written

application/json
  1. response

The zone serial after a write.

serial*integer

The zone's SOA serial including the change.

Formatuint32
Range0 <= value
Example Request
curl -X PUT 'https://api.a-line.cloud/v1/hosted-zones/00000000-0000-4000-8000-000000000001/records' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key' \  -H 'Content-Type: application/json' \  -d '{"name":"example","records":[],"ttl":1,"type":"example"}'
Example Response
{  "serial": 0}
DELETE
/v1/hosted-zones/{zone_id}/records

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

zone_id*string

The zone UUID

Formatuuid

Query Parameters

name*string

The owner name.

type*string

The record type.

Response Body

The record set was deleted

Example Request
curl -X DELETE 'https://api.a-line.cloud/v1/hosted-zones/00000000-0000-4000-8000-000000000001/records?name=example&type=example' \  -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'
Example Response
Empty

On this page