Sign in

v1

latestOpenAPI 3.0.22026-07-26207170320.9 KB
Dedicated IPs

Update dedicated IP set

Update the dedicated IP set with the provided ID. All fields are optional. Omitted fields are left unchanged. To switch from environment-scoped to workspace-scoped, provide environmentIds: [].

patch/dedicated-ips/{dedicatedIpId}

Request body

namestring
descriptionstring
environmentIdsstring[]

Response

OK

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.

status'UNKNOWN' | 'CREATING' | 'PENDING' | 'RUNNING' | 'FAILED' | 'DELETING' | 'DELETED' required

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.