Rivier/ Reference/ workspace

Workspace org workspace retire plan

get/organizations/{id}/workspaces/{wid}/retire-plan

What retiring an archived workspace removes, by area with counts and sizes, what stops it, and when the schedule would retire it.

Before you call

Credential
Authorization: Bearer $KEY
Scope
workspace:read
Graphql
Query.workspaceOrgWorkspaceRetirePlan
Sdk
workspace.orgWorkspace.retirePlan
Cli
workspace org workspace retire plan

Parameters

  • idstring (uuid)required
    In the path
  • widstringrequired
    In the path

Responses

  • 200application/json
    Success

    object

  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown