Sign in

v1

latestOpenAPI 3.0.22026-07-26207170320.9 KB
Dedicated IPs

List dedicated IPs

List dedicated IP sets for a workspace.

get/dedicated-ips

Query parameters

ownerIdstring required

The ID of the workspace to list dedicated IP sets for.

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.