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.
Remove backend member
Removes one backend member (target) from whichever pool of the load balancer contains it — the
"Remove member" / "Remove target" control in the wizard's member table and the detail Targets tab. The
member stops receiving traffic and is dropped from the pool's members array; remaining members continue
to serve, and the pool's health roll-up (healthy/total) is recalculated.
Validation: the load balancer must exist in the scope and backendMemberId must belong to one of its
pools (404 NOT_FOUND otherwise); deletion must not be blocked by an unresolved dependency — e.g. the last
member of a pool referenced by an active listener may be reported as 409 DEPENDENCY_BLOCKED; destructive
permission (owner|admin|contributor) is enforced (403).
Async & state: Asynchronous — returns 202 with an Operation while the data plane drains the member.
Pool state: member removed (terminal); the parent LB briefly reports provisioning=PENDING_UPDATE.
resource.updated SSE frames (kind "network.load_balancer", patch to pools[].members and operating)
refresh the Targets table.
Errors: 401 unauthenticated; 403 missing destructive permission; 404 unknown LB or member id; 409
DEPENDENCY_BLOCKED when removal is blocked; 412 If-Match mismatch; 500 backend failure.
Idempotency/Concurrency: Idempotency-Key recommended; replaying returns the same Operation. If-Match
with the LB's current ETag guards against concurrent pool edits (412 on mismatch); deleting an
already-removed member returns 404.
bearerTokenAuthorizationBearer <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.
scopeId*stringOpaque ownership+authorization scope resolving to tenant + subscription + project.
loadBalancerId*stringbackendMemberId*stringIdempotency-Key?stringOptional; 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.
uuidIf-Match?stringETag for optimistic concurrency on mutations/deletes; mismatch results in 412.
Member removal accepted; Operation handle returned.
application/json- response
A long-running operation record. GET /operations/{operationId} returns its current state.
id*stringOperation identifier, unique platform-wide.
action*stringCanonical action id that started this operation, e.g. compute.instance.create.
state*OperationStateState machine for long-running operations. PENDING and RUNNING are transitional; the rest are terminal.
"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.
0 <= value <= 100error?|nullPopulated only when state is FAILED (or CANCELLED with partial rollback notes).
warning?|nullNon-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*stringupdatedAt*stringcurl -X DELETE "https://example.com/scopes/string/network/load-balancers/string/backend-members/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"}