- Method:
GET
- Path:
/v1/orgs/{org}/compute/public-ips
- Operation ID:
listPublicIps
- Tag: Compute
Send Authorization: Bearer <credential>. The credential is either an API key (vsk_…) created for an organization, or an OIDC access token obtained by signing in to VirtScale.
| Name |
Type |
Required |
Description |
org |
string (uuid) |
Yes |
The organization’s id. |
| Name |
Type |
Required |
Description |
label |
array of string, nullable |
No |
Repeatable key:value. A row is listed only when its labels carry every pair. |
| Field |
Type |
Required |
Enum |
Description |
items |
array of PublicIpOut |
Yes |
|
|
items.address |
string, nullable |
Yes |
|
Null until ip.allocate has actually been applied to the network. |
items.created_at |
string (date-time) |
Yes |
|
|
items.error |
string, nullable |
Yes |
|
|
items.id |
string (uuid) |
Yes |
|
|
items.region_id |
string |
Yes |
|
|
items.state |
string |
Yes |
|
pending | allocated | associating | associated | disassociating | releasing | error. |
items.vm_id |
string (uuid), nullable |
Yes |
|
|
next_cursor |
string, nullable |
No |
|
|
Every error response is application/problem+json (schema Problem).
| Status |
Meaning |
| 400 |
The request is malformed or failed validation. |
| 401 |
The credential is missing or invalid. |
| 404 |
The resource does not exist. |
| default |
Any other status is possible; the code field identifies the error. |
curl "https://api.virtscale.nl/v1/orgs/$ORG_ID/compute/public-ips" \
-H "Authorization: Bearer $VIRTSCALE_API_KEY"