v1

latestOpenAPI 3.0.22026-07-26207170320.9 KB

Dedicated IPs

Create dedicated IP set

Create a dedicated IP set. Provisioning an IP set is asynchronous. The response returns immediately with status: CREATING and ips: []. When provisioning completes, status changes to RUNNING and ips contains your assigned addresses.

If environmentIds is omitted or empty, this IP set applies to all services in the workspace in the selected region. Otherwise, it applies only to services in the listed environments in that region.

post/dedicated-ips

Request body

namestring required

Name for the dedicated IP set.

descriptionstring

Free-form description for the dedicated IP set.

ownerIdstring required

The ID of the workspace that will own this dedicated IP set.

region'frankfurt' | 'oregon' | 'ohio' | 'singapore' | 'virginia' required

Defaults to "oregon"

environmentIdsstring[]

Environments to scope the dedicated IP set to. If omitted or empty, it applies to all services in the workspace within its region.

Response

Created

idstring required

Unique identifier for this dedicated IP set.

namestring required

Descriptive name for this dedicated IP set.

descriptionstring required

Free-form description for this dedicated IP set.

ownerIdstring required

The ID of the workspace that owns this dedicated IP set.

region'frankfurt' | 'oregon' | 'ohio' | 'singapore' | 'virginia' required

Defaults to "oregon"

environmentIdsstring[] required

Environments this dedicated IP set applies to. If empty, it applies to all services in the workspace within its region.

ipsstring[] required

The IPv4 addresses assigned to this dedicated IP set.

Current status of a dedicated IP set.

createdAtstring date-time required

Time the dedicated IP set was created.

updatedAtstring date-time

Time the dedicated IP set was last updated.