Networking

Preview — pending review

This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.

Retrieve floating IP detail

GET
/scopes/{scopeId}/network/floating-ips/{floatingIpId}

Returns the full detail read-model for one floating IP as rendered by the floating IP detail page: the core allocation record (address, status, pool, fixed IP, associated instance/port/router, creation time) plus the bandwidth/type panel (address family, tier, bandwidth in Mbps, reverse DNS, QoS policy, and the kind of associated resource). The response supplies the stable identifiers the detail tabs need for associate/refresh/release follow-up actions. Validation: the caller must have at least reader access to the scope → 403 FORBIDDEN otherwise; floatingIpId must reference an address that exists in the scope and is not soft-deleted → 404 NOT_FOUND. Async & state: Synchronous read; no state change. Transitional association states triggered by attach/release are reflected here on subsequent reads and via resource.updated SSE frames on the network.floating_ip kind. Errors: 401 unauthenticated; 403 caller lacks scope access; 404 unknown floatingIpId or scope; 429 rate limited; 500 internal failure. Idempotency/Concurrency: Safe, cacheable; no idempotency key required. The response carries no ETag; associate and disassociate do not check If-Match.

Authorization

bearerToken
headerAuthorizationBearer <token>

An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.

Path Parameters

scopeId*string

Opaque ownership+authorization scope resolving to tenant + subscription + project.

floatingIpId*string

Identifier of the floating IP.

Response Body

Floating IP detail read-model.

application/json
  1. response

Detail read-model — the core floating IP record plus the bandwidth/type panel (FipDetailExtra).

origin?string

Where the resource was made -- portal for a create on the console, api for an object made straight against the OpenStack API (CLI, Terraform, the Kubernetes cloud provider) that discovery adopted. Informational; nothing behaves differently. Absent from a backend that predates it, which means portal.

Value in"portal""api""system""imported"
id*string

Stable identifier of the floating IP (e.g. fip-01).

ip*string

The public IPv4 address (e.g. 203.0.113.42).

status*string

ACTIVE when associated with a port; DOWN when allocated but unassociated.

Value in"ACTIVE""DOWN"
fixedIp*|

Private fixed IP of the associated port; null when unassociated.

pool*string

External network pool the address was allocated from (e.g. public-ext-net).

instance*|

Name of the associated instance or VIP owner; null when unassociated.

port*|

Name of the associated port; null when unassociated.

router*|

Router carrying the association; null when unassociated.

createdAt*string

Allocation timestamp (ISO 8601).

Formatdate-time
type*string

Address family of the public address.

Value in"Public IPv4""Public IPv6"
tier*string

Service tier of the address.

Value in"Standard""Premium"
bandwidthMbps*integer

Provisioned bandwidth ceiling in Mbps.

reverseDns*|

Reverse DNS (PTR) record; null when not configured.

qosPolicy*|

Attached QoS policy name; null when none.

associatedType*|

Kind of the associated resource; null when unassociated.

curl -X GET "https://example.com/scopes/string/network/floating-ips/string"
{  "origin": "portal",  "id": "string",  "ip": "string",  "status": "ACTIVE",  "fixedIp": "string",  "pool": "string",  "instance": "string",  "port": "string",  "router": "string",  "createdAt": "2019-08-24T14:15:22Z",  "type": "Public IPv4",  "tier": "Standard",  "bandwidthMbps": 0,  "reverseDns": "string",  "qosPolicy": "string",  "associatedType": "Load balancer"}