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.

Associate the floating IP with a target resource

POST
/scopes/{scopeId}/network/floating-ips/{floatingIpId}/actions/associate

Associates ("Associate" in the floating IP detail page and the list row menu) the selected floating IP with a target resource — a virtual machine port or a load-balancer VIP chosen from the associate dialog. On success the address transitions to status ACTIVE and its fixedIp, instance, port, and router fields are populated from the target; the resulting state is available to subsequent reads. Supply targetFixedIp to pin the association to one NIC of a multi-NIC target; omitted, the first bindable port is used. Validation: floating IP must exist and be visible in the scope → 404 NOT_FOUND; targetId must reference an instance/port reachable in the scope → 404 NOT_FOUND (settled against the provider); current state must permit association (the address must not already be associated) → 409 CONFLICT; caller needs contributor or higher → 403 FORBIDDEN; malformed body → 422 VALIDATION_FAILED. Async & state: Asynchronous: 202 with an Operation. The port binding is performed against the network fabric and the address settles ACTIVE (or the Operation ends FAILED); a resource.updated SSE frame (kind: network.floating_ip, patch: {status, fixedIp, instance, port, router}) is emitted so open list/detail views refresh without polling. Errors: 401 unauthenticated; 403 missing permission; 404 unknown floating IP or target; 409 CONFLICT when already associated or the address state forbids association; 422 invalid body; 429 rate limited; 500 internal failure. Idempotency/Concurrency: Idempotency-Key is optional (recommended); replaying a key returns the original 202 Operation rather than binding twice. This operation does not check If-Match; a sent one is ignored (an address that is already associated is the 409 above).

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.

Header Parameters

Idempotency-Key?string

Optional; recommended for safe retries. When sent, the same key+body within 24h replays the original result and the same key with a different body is 409 CONFLICT; keys are unique per tenant. When an API token or service-account (bearer) caller omits it, the request is applied once with no replay protection (a retry may apply it again). A console session gets one from the edge.

Formatuuid

Request Body

application/json
  1. body

Associate dialog payload — the target resource to bind the floating IP to.

targetId*string

Identifier of the target: an instance id, or a load balancer of the same project by its id or its VIP port id (the address binds to the VIP port, pinned to the VIP address). A load balancer that is still being built has no VIP port yet and the operation fails PRECONDITION_FAILED.

targetFixedIp?|

On a multi-NIC target, the private fixed IP of the specific NIC the floating IP should bind to (e.g. 10.0.1.14). When omitted the first NIC with a fixed IP is used; supply it to disambiguate an instance with more than one attached network.

Response Body

Association accepted; track progress through the returned operation.

application/json
  1. response

A long-running operation record. GET /operations/{operationId} returns its current state.

id*string

Operation identifier, unique platform-wide.

action*string

Canonical action id that started this operation, e.g. compute.instance.create.

state*OperationState

State machine for long-running operations. PENDING and RUNNING are transitional; the rest are terminal.

Value in"PENDING""RUNNING""SUCCEEDED""FAILED""CANCELLED"
resourceKind?|

Kind of the target resource (matches RealtimeEvent.kind), null for resource-less actions.

resourceId?|

Identifier of the target resource; null until the resource is allocated.

resourceName?|

Human-readable name of the target resource captured when the operation was opened; null when unknown or the resource has been deleted (clients fall back to resourceId).

principalId?|

Subject id (user id/email or service-account id) of the actor that initiated this operation, captured at the create chokepoint; null on internal/worker paths with no request-scoped principal or for historical rows. This is the real actor the Activity feed renders.

sourceIp?|

Source IP address of the request that initiated this operation; null when unavailable (internal/worker paths, historical rows).

progressPercent?|

Best-effort progress; null when the action does not report progress.

Range0 <= value <= 100
error?|null

Populated only when state is FAILED (or CANCELLED with partial rollback notes).

warning?|null

Non-fatal degradation recorded on an operation that still SUCCEEDED - the primary action completed but something explicitly requested could not be delivered (e.g. publicIp was requested at instance create but no floating IP could be assigned). On a CANCELLED create it reports that the provider resource had already been created and was kept (live and billed until deleted; details.disposition = left_in_place). Same code+message shape as error so clients render both uniformly; null when the operation ran without degradation.

startedAt?|

When the worker began executing; null while PENDING.

finishedAt?|

When a terminal state was reached; null while transitional.

createdAt*string
updatedAt*string
curl -X POST "https://example.com/scopes/string/network/floating-ips/string/actions/associate" \  -H "Content-Type: application/json" \  -d '{    "targetId": "string"  }'
{  "id": "string",  "action": "string",  "state": "PENDING",  "resourceKind": "string",  "resourceId": "string",  "resourceName": "string",  "principalId": "string",  "sourceIp": "string",  "progressPercent": 0,  "error": {    "code": "string",    "message": "string",    "field": "string",    "details": {},    "retryable": false  },  "warning": {    "code": "string",    "message": "string",    "field": "string",    "details": {},    "retryable": false  },  "startedAt": "string",  "finishedAt": "string",  "createdAt": "string",  "updatedAt": "string"}