Skip to content

Attach static addresses

Attach account-owned static IPv4 addresses to Computers, pools or the account. A Computer's own address directly receives TCP and UDP at the service's port and supplies the Computer's outbound IPv4 address. A pool or account address supplies outbound IPv4 and carries published TCP ports for Computers that inherit it. Heaven applies every attachment together.

Parameters

#
addressstring
Static IPv4 address in your account to attach.
computerstring
Destination Computer name or ID. The Computer can hold one static address.
poolstring
Destination pool name or ID. The pool can hold one static address.
accountboolean
Use the address as the default for the account's pools on one server. Each server can have one such address for the account.
serverstring
Server identifier for account: true, from capacity view. Required when the account has pools or capacity on more than one server.
attachmentsobject[]
Address attachments, each with exactly one destination: computer, pool or account: true.
Show 5 attributesHide attributes
accountboolean
Whether to use the address as the organization's default on one server.
addressstringRequired
Static IPv4 address to attach.
computerstring
Destination Computer name or ID.
poolstring
Destination pool name or ID.
serverstring
Server for an account attachment; required when the organization has pools on several servers.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
Static IPv4 addresses with their new attachments.
Show 1 attributeHide attributes
attachedobject[] | nullAlways present
Addresses in request order, showing what each is now attached to.
Show 1 attributeHide attributes
itemsobject
A static IPv4 address and its attachment.
Show 10 attributesHide attributes
accountboolean
Whether this is the account's default address for pools in this placement. May be omitted.
addressstringAlways present
Static IPv4 address.
available_fromstring (date-time)
When a released address becomes available to another account. May be omitted.
bought_atstring (date-time)Always present
When the account acquired the address.
computerstring
Attached Computer's name. May be omitted.
computer_idstring
Attached Computer's ID. May be omitted.
poolstring
Attached pool's name. May be omitted.
pool_idstring
Attached pool's ID. May be omitted.
regionstringAlways present
Address's region.
released_atstring (date-time)
When the address was released. May be omitted.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
payment_required402Payment or credit is required.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • CLI: heaven login with HEAVEN_API_KEY unset. MCP: Heaven sign-in. cURL: HEAVEN_SIGN_IN_KEY from approved device sign-in (POST /v1/auth/create).
  • A key limited to a command list cannot run this command.
  • Heaven returns unavailable if static IPv4 addresses aren't offered.
  • Computer: Attach the address to a Computer for incoming TCP and UDP ports and outgoing traffic. Required: address, computer. Optional: organization.
  • Pool: Attach the address to a pool for outgoing traffic and public ports of Computers without their own address. Required: address, pool. Optional: organization.
  • Account: Attach the address to the account on one server for pools without their own address. Required: address, account. Optional: server, organization.
  • Several: Attach all selected addresses or none. Required: attachments. Optional: organization.