neoserver 0.1.2

Delete workspace

DELETE /api/v1/workspaces/{workspace} · Workspaces

← All operations and schemas

DELETE /api/v1/workspaces/{workspace}

Deletes an empty workspace synchronously. Non-empty workspaces return 409 unless recurse=true, which starts a durable deletion operation. Requires super_admin role.

Operation ID: deleteWorkspace

Authentication

Use one of the following authentication options. Permissions and workspace scope still apply. See authentication and access control.

Authorization: Bearer YOUR_ACCESS_TOKEN
X-API-Key: YOUR_API_KEY

Parameters

workspace path required: Workspace ID

string
recurse query: Recursively remove dependent catalog and operational state using a durable asynchronous operation.

boolean

Responses

202 Recursive deletion accepted

Content type application/json

DeletionOperation ↗

204 No Content

No response body is specified.

401 Unauthorized

Content type application/json

403 Forbidden - requires super_admin role

Content type application/json

404 Workspace not found

Content type application/json

409 Workspace has dependencies

Content type application/json

DeletionConflict ↗

413 Request body exceeds the configured limit

Content type application/json

426 HTTPS required

Content type application/json

429 Request rate exceeded

Content type application/json

503 Service temporarily unavailable

Content type application/json

OpenAPI operation definition

{
  "description": "Deletes an empty workspace synchronously. Non-empty workspaces return 409 unless recurse=true, which starts a durable deletion operation. Requires super_admin role.",
  "operationId": "deleteWorkspace",
  "parameters": [
    {
      "description": "Workspace ID",
      "in": "path",
      "name": "workspace",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Recursively remove dependent catalog and operational state using a durable asynchronous operation.",
      "in": "query",
      "name": "recurse",
      "schema": {
        "type": "boolean"
      }
    }
  ],
  "responses": {
    "202": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/DeletionOperation"
          }
        }
      },
      "description": "Recursive deletion accepted"
    },
    "204": {
      "description": "No Content"
    },
    "401": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Unauthorized"
    },
    "403": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Forbidden - requires super_admin role"
    },
    "404": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Workspace not found"
    },
    "409": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/DeletionConflict"
          }
        }
      },
      "description": "Workspace has dependencies"
    },
    "413": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Request body exceeds the configured limit"
    },
    "426": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "HTTPS required"
    },
    "429": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Request rate exceeded"
    },
    "503": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Service temporarily unavailable"
    }
  },
  "summary": "Delete workspace",
  "tags": [
    "Workspaces"
  ]
}