Skip to content
HelicarrierDevelopers
API REFERENCE

Domains & networking

Domains & networking operations in the Helicarrier Cloud API.

GETList domains
/api/services/{id}/domains

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

GETList ports
/api/services/{id}/ports

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

GETGet DNS target
/api/services/{id}/dns

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

GETList dedicated IPs
/api/dedicated-ips

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

GETGet project dedicated IP
/api/projects/{slug}/dedicated-ip

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

PUTAttach project dedicated IP
/api/projects/{slug}/dedicated-ip

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

DELETEDetach project dedicated IP
/api/projects/{slug}/dedicated-ip

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

GETGet service dedicated IP
/api/services/{id}/dedicated-ip

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

PUTAttach service dedicated IP
/api/services/{id}/dedicated-ip

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

DELETEDetach service dedicated IP
/api/services/{id}/dedicated-ip

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

POSTAdd domain
/api/services/{id}/domains

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

POSTImport environment variables
/api/services/{id}/env/import

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

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

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

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

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

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

Remove a custom domain from this service..

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

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