Rivier/ Reference/ workspace

Workspace org workspace clear plan

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

What clearing some areas of a workspace removes, and which other areas must be cleared with them.

Before you call

Credential
Authorization: Bearer $KEY
Scope
workspace:read
Graphql
Query.workspaceOrgWorkspaceClearPlan
Sdk
workspace.orgWorkspace.clearPlan
Cli
workspace org workspace clear plan

Parameters

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

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