Docs API reference

neoserver 0.1.2

List visible deletion operations

GET /api/v1/deletions · Catalog Lifecycle

← All operations and schemas
GET /api/v1/deletions

Operation ID: listDeletionOperations

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 query

Workspace UUID (not name); applies to deleted workspaces too. Requires administrator access.

string
status query

Optional status; actionable includes pending, running and failed

string
Allowed values
["pending","running","failed","completed","actionable"]
limit query

Page size, default 200; authorization is applied before pagination

integer
Minimum
1
Maximum
1000
cursor query

Opaque next_cursor; restart pagination when scope or filters change

string

Responses

200 Deletion operations

Content type application/json

400 Invalid filter or cursor

Content type application/json

401 Authentication required or credential rejected

Content type application/json

403 Workspace administrator required

Content type application/json

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
{
  "operationId": "listDeletionOperations",
  "parameters": [
    {
      "description": "Workspace UUID (not name); applies to deleted workspaces too. Requires administrator access.",
      "in": "query",
      "name": "workspace",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Optional status; actionable includes pending, running and failed",
      "in": "query",
      "name": "status",
      "schema": {
        "enum": [
          "pending",
          "running",
          "failed",
          "completed",
          "actionable"
        ],
        "type": "string"
      }
    },
    {
      "description": "Page size, default 200; authorization is applied before pagination",
      "in": "query",
      "name": "limit",
      "schema": {
        "maximum": 1000,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "description": "Opaque next_cursor; restart pagination when scope or filters change",
      "in": "query",
      "name": "cursor",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/DeletionList"
          }
        }
      },
      "description": "Deletion operations"
    },
    "400": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Invalid filter or cursor"
    },
    "401": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Authentication required or credential rejected"
    },
    "403": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Workspace administrator required"
    },
    "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": "List visible deletion operations",
  "tags": [
    "Catalog Lifecycle"
  ]
}

Search documentation

Type to search guides and reference pages.