Storage

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.

Read one open transfer offer

GET
/scopes/{scopeId}/storage/volume-transfers/{transferId}

One open offer, without its authKey — the provider cannot return the key after creation and neither can this route. An unknown, accepted or withdrawn offer is 404 NOT_FOUND. Validation: unknown scopeId/transferId → 404. RBAC: any scope role may read. Async & state: Synchronous read. Errors: 401; 403; 404; 500. Idempotency/Concurrency: Safe; no idempotency key.

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.

transferId*string

Identifier of the transfer offer.

Response Body

The offer.

application/json
  1. response

An open offer to hand a volume to another project. Carries no authorization key - the provider returns that only when the offer is created.

id*string

Identifier of the offer; half of what the recipient needs.

volumeId*string

The volume being offered.

volumeName?|

Display name of the offered volume, so the list is readable without a second call.

name?|

Optional label the donor gave the offer.

createdAt*string

When the offer was opened.

Formatdate-time
curl -X GET "https://example.com/scopes/string/storage/volume-transfers/string"
{  "id": "string",  "volumeId": "string",  "volumeName": "string",  "name": "string",  "createdAt": "2019-08-24T14:15:22Z"}