REST API Reference
Domains & Ingress TLS API
Attach custom hostnames, trigger DNS verification checks, inspect Let's Encrypt TLS certificate status, and configure Anycast routing.
Attach Custom Domain
Attach Custom DomainAuth
Map custom domain to a container workload.
Payload Example
{
"domain_name": "app.example.com.au",
"workload_id": "wld_7f2b1a9c-3e4f",
"target_port": 8080,
"ssl_auto_provision": true
}Status Codes
- Name
201- Type
- HTTP
- Description
- Domain record registered and DNS CNAME assigned.
Request
POST/v1/cloud/domains
Response 201
Verify DNS Records
Verify DNSAuth
Trigger immediate DNS propagation check.
Status Codes
- Name
200- Type
- HTTP
- Description
- DNS record verified and TLS certificate issued.
- Name
422- Type
- HTTP
- Description
- DNS CNAME or A record not yet resolving correctly.
Request
POST/v1/cloud/domains/{id}/verify
Response 200