Praecise Platform
Menu

Rivier/ Reference/ workspace

Remove an archived workspace for good

post/organizations/{id}/workspaces/{wid}/retire

Remove an archived workspace for good. The name is typed and the loss acknowledged; the domain registration and DNS are never touched.

Before you call

Credential
Authorization: Bearer $KEY
Scope
workspace:admin
Graphql
Mutation.workspaceOrgWorkspaceRetire
Sdk
workspace.orgWorkspace.retire
Cli
workspace org workspace retire

Parameters

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

Request bodyapplication/json, required

  • confirmNamestringrequired
    At most 400 characters.
  • acknowledgeIrreversibletruerequired
  • removeHostedSiteboolean

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