Organization API: Customer Portal: Ips

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled List attach targets

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

List attach targets

GET /api/v1/orgs/{org_slug}/portal/ips/attach-targets

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled Order a floating IP / subnet via the org storefront path

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Order a floating IP / subnet via the org storefront path

POST /api/v1/orgs/{org_slug}/portal/ips/order

Order a floating IP / subnet via the org storefront path.

Reserves inventory in the same transaction as the invoice. Replays of the same idempotency_key return the original invoice instead of a second order. version and prefix_len default to what the product sells, and a value that differs from it answers 422. An IPv6 address cannot name attach_to_org_service_id yet: servers take IPv4 floating IPs for now, so that answers 409.

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required	Description
`org_product_id`	integer	yes
`org_pricing_id`	integer	yes
`pool_id`	integer	yes
`prefix_len`	integer or null	no	Leave it out to order what the product sells: /32 for an IPv4 address, /128 for an IPv6 address, or the subnet size of a subnet product. Any other value answers 422.
`version`	string or null	no	ipv4 or ipv6. Leave it out to take the product's family; a different one answers 422.
`hostname`	string or null	no
`idempotency_key`	string	yes	Client-generated key so double-submit / multi-tab retries replay the same order
`attach_to_org_service_id`	integer or null	no	One of your Minecraft servers (org service id). The address is attached to it as soon as it is provisioned; single IPv4 only.

Responses

Section titled Open IP order intents, so unpaid or in-flight orders resume after login or in a new tab

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Open IP order intents, so unpaid or in-flight orders resume after login or in a new tab

GET /api/v1/orgs/{org_slug}/portal/ips/orders

Open IP order intents, so unpaid or in-flight orders resume after login or in a new tab.

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled Get my IP order

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Get my IP order

GET /api/v1/orgs/{org_slug}/portal/ips/orders/{idempotency_key}

Parameters

Name	In	Type	Required
`idempotency_key`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled Cancel my IP order

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Cancel my IP order

POST /api/v1/orgs/{org_slug}/portal/ips/orders/{idempotency_key}/cancel

Parameters

Name	In	Type	Required
`idempotency_key`	path	string	yes
`org_slug`	path	string	yes

Responses

Section titled The locations you can order a floating IP or a subnet from

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

The locations you can order a floating IP or a subnet from

GET /api/v1/orgs/{org_slug}/portal/ips/pools

The locations you can order a floating IP or a subnet from.

Pass the chosen pool's id as pool_id to POST …/portal/ips/order. available says whether the pool has stock now. IPv6 is sold as single /128 addresses, so version=ipv6 with any other prefix_len answers 422, as does a prefix_len IPv4 does not sell. When subnet rental is off, a subnet size answers an empty list.

Parameters

Name	In	Type	Required	Description
`org_slug`	path	string	yes
`version`	query	string	no	ipv4 (default) or ipv6 Default: `ipv4`.
`prefix_len`	query	integer or null	no	IPv4: 32 (default) lists floating /32 stock and 24–29 lists subnet stock. IPv6: 128 (default) lists the pools that can carve a floating /128.
`region`	query	string or null	no	Airport-code location filter

Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Get my IP

Section titled Get my IP

GET /api/v1/orgs/{org_slug}/portal/ips/{service_id}

Parameters

Name	In	Type	Required
`service_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Attach IP

Section titled Attach IP

POST /api/v1/orgs/{org_slug}/portal/ips/{service_id}/attach

Parameters

Name	In	Type	Required
`service_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required	Description
`target_type`	string	yes	vps \| container
`target_service_id`	integer	yes	Platform service id of the compute target
`host_address`	string or null	no	Host IP within a rented subnet; omit to attach first free host
`host_inventory_id`	integer or null	no	Alternative to host_address: inventory id of the host row
`is_primary`	boolean or null	no	For VPS multi-IP: set as primary (ipconfig0). Default: primary if none yet.

Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Detach IP

Section titled Detach IP

POST /api/v1/orgs/{org_slug}/portal/ips/{service_id}/detach

Parameters

Name	In	Type	Required
`service_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

application/json

Field	Type	Required
`host_address`	string or null	no
`host_inventory_id`	integer or null	no

Responses

Section titled List my IP hosts

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

List my IP hosts

GET /api/v1/orgs/{org_slug}/portal/ips/{service_id}/hosts

Parameters

Name	In	Type	Required	Description
`service_id`	path	integer	yes
`org_slug`	path	string	yes
`include_reserved`	query	boolean	no	Default: `True`.

Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Get PTR

Section titled Get PTR

GET /api/v1/orgs/{org_slug}/portal/ips/{service_id}/ptr

Parameters

Name	In	Type	Required
`service_id`	path	integer	yes
`org_slug`	path	string	yes
`host_address`	query	string or null	no
`host_inventory_id`	query	integer or null	no

Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Set PTR

Section titled Set PTR

PATCH /api/v1/orgs/{org_slug}/portal/ips/{service_id}/ptr

Parameters

Name	In	Type	Required
`service_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`hostname`	string	yes
`host_address`	string or null	no
`host_inventory_id`	integer or null	no

Responses