API REFERENCE

Domains & networking

Domains & networking operations in the Helicarrier Cloud API.

GET List domains

/api/services/{id}/domains

List the custom domains attached to a service and their current verification state..

GET List ports

/api/services/{id}/ports

Inspect a service’s primary HTTP port, additional exposed ports, and detected port suggestions..

GET Get DNS target

/api/services/{id}/dns

Get the DNS target to use when connecting a custom domain to this service..

GET List dedicated IPs

/api/dedicated-ips

List dedicated outbound addresses held by your account and their attachments..

GET Get project dedicated IP

/api/projects/{slug}/dedicated-ip

Read the outbound IP attachment inherited by eligible services in this project..

PUT Attach project dedicated IP

/api/projects/{slug}/dedicated-ip

Attach an existing account-owned outbound IP to a project..

DELETE Detach project dedicated IP

/api/projects/{slug}/dedicated-ip

Detach an outbound IP from a project without releasing the purchased address..

GET Get service dedicated IP

/api/services/{id}/dedicated-ip

Read a service’s explicit outbound IP and its project-level fallback..

PUT Attach service dedicated IP

/api/services/{id}/dedicated-ip

Attach an existing account-owned outbound IP to a service.

DELETE Detach service dedicated IP

/api/services/{id}/dedicated-ip

Remove a service’s outbound IP override without releasing the address..

POST Add domain

/api/services/{id}/domains

Attach a custom domain to a service, then configure DNS to complete verification..

POST Import environment variables

/api/services/{id}/env/import

Import several environment variables into a service in one request..

POST Expose port

/api/services/{id}/ports

Expose an additional HTTP port and create a generated hostname for it..

DELETE Remove port

/api/services/{id}/ports/{port}

Remove an additional exposed HTTP port and its generated route..

DELETE Remove domain

/api/services/{id}/domains/{domainId}

Remove a custom domain from this service..

PATCH Set search indexing

/api/services/{id}/search-indexing

Control search-indexing headers on a service’s generated hostname..