Domains
The domains 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
uuidapp_id*stringThe app UUID
uuidcursor?|Opaque cursor from the previous page's next_cursor.
limit?|Page size, 1 to 100 (default 25).
uint0 <= valueA page of domains
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/apps/00000000-0000-4000-8000-000000000002/domains' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'{ "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"}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).
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
uuidapp_id*stringThe app UUID
uuidA domain to add to an app.
application/json- body
A domain to add to an app.
behind_proxy?booleanServed through a CDN or reverse proxy (HTTP and HTTPS routes only). Ownership is still proven by the TXT verification.
falsedns_target?|domain*stringThe host name; an organization domain must cover it.
external_port?integerThe port the load balancer listens on (default 443).
int32443path_prefix?stringThe path prefix to route (default /).
"/"pending_verification?booleanAccept a host only a domain still being verified covers; it routes once that verifies.
falseport*integerThe container port to route to.
int32protocol?stringhttp, https (default), tcp, udp or tls (TLS passthrough by SNI on 443).
"https"proxy_protocol?booleanPrefix each connection with a PROXY protocol header carrying the client address (TCP only; the app must expect the header).
falseservice_name?|A Kubernetes service to target instead of the app's own.
nullstrip_prefix?booleanStrip the prefix before forwarding (default false).
falsetls_enabled?booleanTerminate TLS (default true).
truewildcard?booleanAlso route every subdomain (HTTP(S) only, needs a whole-domain verification).
falseThe domain was added
application/json- 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*stringThe app it routes to.
uuidbehind_proxy*booleanServed 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*stringWhen the domain was added (RFC 3339, UTC).
date-timedns_records*array<>The records to create at the customer's DNS provider.
dns_target*|domain*stringThe host name.
external_port*integerThe port the load balancer listens on.
int32id*stringThe domain id.
uuidorigin_lock?|While behind a proxy: the origin lock (fingerprints only); null when off.
path_prefix*stringThe path prefix routed.
platform*booleanA hostname the platform issued (temporary URL or generated host).
port*integerThe container port traffic goes to.
int32protocol*stringhttp, https, tcp, udp or tls (TLS passthrough by SNI on 443).
proxy_protocol*booleanA TCP port whose connections start with a PROXY protocol header.
route_error?|Why routing failed.
route_state*stringRouting state: pending, live, waiting_deploy, failed or unknown.
service_name?|The Kubernetes service targeted, when not the app's own.
strip_prefix*booleanWhether the prefix is stripped before forwarding.
tls_enabled*booleanWhether 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.
date-timetls_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*booleanAlso routes every subdomain (*.<domain>).
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}'{ "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}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
uuidapp_id*stringThe app UUID
uuiddomain_id*stringThe domain UUID
uuidThe domain
application/json- 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*stringThe app it routes to.
uuidbehind_proxy*booleanServed 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*stringWhen the domain was added (RFC 3339, UTC).
date-timedns_records*array<>The records to create at the customer's DNS provider.
dns_target*|domain*stringThe host name.
external_port*integerThe port the load balancer listens on.
int32id*stringThe domain id.
uuidorigin_lock?|While behind a proxy: the origin lock (fingerprints only); null when off.
path_prefix*stringThe path prefix routed.
platform*booleanA hostname the platform issued (temporary URL or generated host).
port*integerThe container port traffic goes to.
int32protocol*stringhttp, https, tcp, udp or tls (TLS passthrough by SNI on 443).
proxy_protocol*booleanA TCP port whose connections start with a PROXY protocol header.
route_error?|Why routing failed.
route_state*stringRouting state: pending, live, waiting_deploy, failed or unknown.
service_name?|The Kubernetes service targeted, when not the app's own.
strip_prefix*booleanWhether the prefix is stripped before forwarding.
tls_enabled*booleanWhether 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.
date-timetls_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*booleanAlso routes every subdomain (*.<domain>).
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'{ "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}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
uuidapp_id*stringThe app UUID
uuiddomain_id*stringThe domain UUID
uuidThe fields to change; a field left out keeps its value.
application/json- 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.
nullThe changed domain
application/json- 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*stringThe app it routes to.
uuidbehind_proxy*booleanServed 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*stringWhen the domain was added (RFC 3339, UTC).
date-timedns_records*array<>The records to create at the customer's DNS provider.
dns_target*|domain*stringThe host name.
external_port*integerThe port the load balancer listens on.
int32id*stringThe domain id.
uuidorigin_lock?|While behind a proxy: the origin lock (fingerprints only); null when off.
path_prefix*stringThe path prefix routed.
platform*booleanA hostname the platform issued (temporary URL or generated host).
port*integerThe container port traffic goes to.
int32protocol*stringhttp, https, tcp, udp or tls (TLS passthrough by SNI on 443).
proxy_protocol*booleanA TCP port whose connections start with a PROXY protocol header.
route_error?|Why routing failed.
route_state*stringRouting state: pending, live, waiting_deploy, failed or unknown.
service_name?|The Kubernetes service targeted, when not the app's own.
strip_prefix*booleanWhether the prefix is stripped before forwarding.
tls_enabled*booleanWhether 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.
date-timetls_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*booleanAlso routes every subdomain (*.<domain>).
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}'{ "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}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
uuidapp_id*stringThe app UUID
uuiddomain_id*stringThe domain UUID
uuidThe domain was removed
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'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.
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
uuidapp_id*stringThe app UUID
uuiddomain_id*stringThe domain UUID
uuidThe client-IP header of a domain behind a proxy.
application/json- 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.
nullThe domain with its client IP header
application/json- 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*stringThe app it routes to.
uuidbehind_proxy*booleanServed 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*stringWhen the domain was added (RFC 3339, UTC).
date-timedns_records*array<>The records to create at the customer's DNS provider.
dns_target*|domain*stringThe host name.
external_port*integerThe port the load balancer listens on.
int32id*stringThe domain id.
uuidorigin_lock?|While behind a proxy: the origin lock (fingerprints only); null when off.
path_prefix*stringThe path prefix routed.
platform*booleanA hostname the platform issued (temporary URL or generated host).
port*integerThe container port traffic goes to.
int32protocol*stringhttp, https, tcp, udp or tls (TLS passthrough by SNI on 443).
proxy_protocol*booleanA TCP port whose connections start with a PROXY protocol header.
route_error?|Why routing failed.
route_state*stringRouting state: pending, live, waiting_deploy, failed or unknown.
service_name?|The Kubernetes service targeted, when not the app's own.
strip_prefix*booleanWhether the prefix is stripped before forwarding.
tls_enabled*booleanWhether 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.
date-timetls_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*booleanAlso routes every subdomain (*.<domain>).
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"}'{ "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}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.
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
uuidapp_id*stringThe app UUID
uuiddomain_id*stringThe domain UUID
uuidThe new key, shown once, and the domain
application/json- response
A new origin key, answered this once.
domain*The domain with its lock.
header*stringThe request header to send it in (X-Aline-Origin-Key).
key*stringThe key for the proxy to send.
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'{ "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"}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.
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
uuidapp_id*stringThe app UUID
uuiddomain_id*stringThe domain UUID
uuidThe domain, unlocked
application/json- 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*stringThe app it routes to.
uuidbehind_proxy*booleanServed 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*stringWhen the domain was added (RFC 3339, UTC).
date-timedns_records*array<>The records to create at the customer's DNS provider.
dns_target*|domain*stringThe host name.
external_port*integerThe port the load balancer listens on.
int32id*stringThe domain id.
uuidorigin_lock?|While behind a proxy: the origin lock (fingerprints only); null when off.
path_prefix*stringThe path prefix routed.
platform*booleanA hostname the platform issued (temporary URL or generated host).
port*integerThe container port traffic goes to.
int32protocol*stringhttp, https, tcp, udp or tls (TLS passthrough by SNI on 443).
proxy_protocol*booleanA TCP port whose connections start with a PROXY protocol header.
route_error?|Why routing failed.
route_state*stringRouting state: pending, live, waiting_deploy, failed or unknown.
service_name?|The Kubernetes service targeted, when not the app's own.
strip_prefix*booleanWhether the prefix is stripped before forwarding.
tls_enabled*booleanWhether 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.
date-timetls_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*booleanAlso routes every subdomain (*.<domain>).
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'{ "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}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.
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
uuidapp_id*stringThe app UUID
uuiddomain_id*stringThe domain UUID
uuidThe new key, shown once, and the domain
application/json- response
A new origin key, answered this once.
domain*The domain with its lock.
header*stringThe request header to send it in (X-Aline-Origin-Key).
key*stringThe key for the proxy to send.
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'{ "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"}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.
cursor?|Opaque cursor from the previous page's next_cursor.
limit?|Page size, 1 to 100 (default 25).
uint0 <= valueA page of domains
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/domains' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'{ "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"}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.
domain_id*stringThe domain UUID
uuidThe domain
application/json- response
An organization domain and the TXT record that proves it.
created_at*stringWhen it was added.
date-timeerror?|Why the last check failed.
id*stringThe domain id.
uuidlast_checked_at?|When it was last checked.
date-timename*stringThe domain name.
scope*stringdomain (the name and its subdomains) or host (the name only).
status*stringpending, verified or failed.
txt_name*stringName of the TXT record to publish.
txt_value*stringValue of that TXT record.
verified_at?|When the domain verified (RFC 3339, UTC).
date-timecurl 'https://api.a-line.cloud/v1/domains/00000000-0000-4000-8000-000000000001' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'{ "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"}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.
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 <= valueA page of zones
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/hosted-zones' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'{ "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"}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.
zone_id*stringThe zone UUID
uuidThe zone
application/json- response
A hosted zone (or a claim on one still being verified).
created_at*stringWhen the claim was made (RFC 3339, UTC).
date-timedelegated?|Whether the zone is delegated to them (null before the first check).
id*stringThe zone id.
uuidname*stringThe zone name (example.com).
nameservers*array<string>The nameservers to delegate the zone to.
status*stringpending, verified or failed.
txt_name*stringThe TXT record name proving ownership.
txt_value*stringThe TXT record value.
verified_at?|When the zone verified.
date-timecurl 'https://api.a-line.cloud/v1/hosted-zones/00000000-0000-4000-8000-000000000001' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'{ "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"}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.
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.
zone_id*stringThe zone UUID
uuidcursor?|Opaque cursor from the previous page's next_cursor.
limit?|Page size, 1 to 100 (default 25).
uint0 <= valueA page of record sets
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/hosted-zones/00000000-0000-4000-8000-000000000001/records' \ -H 'Authorization: Bearer alc_test_EXAMPLE_not_a_real_key'{ "data": [ { "name": "string", "records": [ "string" ], "ttl": 0, "type": "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.
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.
zone_id*stringThe zone UUID
uuidA record set: every record of one name and type.
application/json- body
A record set: every record of one name and type.
name*stringThe owner name, fully qualified without the trailing dot (www.example.com).
records*array<string>The record values, in zone-file presentation format.
ttl*integerTime to live in seconds.
uint320 <= valuetype*stringThe record type (A, AAAA, CNAME, TXT, MX, ...).
The record set was written
application/json- response
The zone serial after a write.
serial*integerThe zone's SOA serial including the change.
uint320 <= valuecurl -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"}'{ "serial": 0}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.
zone_id*stringThe zone UUID
uuidname*stringThe owner name.
type*stringThe record type.
The record set was deleted
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'