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.
Export a cost report as CSV (legacy compat)
Deprecated
Legacy compat shim for exporting the referenced Cost Report as CSV (originally the "Export CSV"
action in the Cost explorer page header). Deprecated — new integrations should call
GET .../cost-reports/{costReportId}/exports/download instead, which streams the CSV
synchronously in a single request; this POST is retained only so existing callers keep working.
The underlying cost data is read-only; no billing resource is mutated by exporting.
Validation: scopeId must be accessible and costReportId must reference a cost report within
that scope (else 404 NOT_FOUND); groupBy/period/granularity in the body must be valid enum
members and format must be csv — violations map to 422 VALIDATION_FAILED; the caller must hold a
billing-capable role (owner|admin|contributor|reader|billing), else 403.
Async & state: Despite the historical 202 status code, this call completes synchronously —
there is no background worker, no PENDING/RUNNING transition, and no signed download URL in the
result. The returned Operation is created already SUCCEEDED, with its id set to the request's
Idempotency-Key; the CSV bytes are NOT attached to this response — fetch them via
GET .../exports/download (same query dimensions).
Errors: 401 unauthenticated; 403 insufficient role; 404 unknown scope or cost report; 422 invalid
export parameters; 500 internal failure.
Idempotency/Concurrency: Idempotency-Key is optional (recommended); replaying the same
key returns an
Operation with the same id — this shim never produced (and never regenerates) an artifact.
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.
costReportId*stringIdentifier of the cost report within the active scope.
Idempotency-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.
uuidapplication/json- body
Export parameters mirroring the Cost Explorer control bar at the time of export.
format*"csv"Export artifact format.
"csv"groupBy?stringDimension grouping to export (defaults to the report's stored grouping).
"service""project""region""tag"period?stringReporting period to export.
"7d""30d""90d""mtd""custom"granularity?stringBucket granularity to export.
"daily""monthly"Legacy compat response — an already-SUCCEEDED Operation with no artifact attached (download via the GET endpoint).
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 POST "https://example.com/scopes/string/billing/cost-reports/string/exports" \ -H "Content-Type: application/json" \ -d '{ "format": "csv" }'{ "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"}