Docs API reference

neoserver 0.1.2

Repair orphaned state from older releases

POST /api/v1/catalog/integrity/repair · Catalog Lifecycle

← All operations and schemas
POST /api/v1/catalog/integrity/repair

Operation ID: repairCatalogIntegrity

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

confirm query required

Must be true to authorize removal of confirmed orphan state.

boolean

Responses

200 Post-repair integrity report

Content type application/json

400 Explicit confirmation required

Content type application/json

401 Authentication required or credential rejected

Content type application/json

403 Super 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": "repairCatalogIntegrity",
  "parameters": [
    {
      "description": "Must be true to authorize removal of confirmed orphan state.",
      "in": "query",
      "name": "confirm",
      "required": true,
      "schema": {
        "type": "boolean"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/IntegrityReport"
          }
        }
      },
      "description": "Post-repair integrity report"
    },
    "400": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Explicit confirmation required"
    },
    "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": "Super 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": "Repair orphaned state from older releases",
  "tags": [
    "Catalog Lifecycle"
  ]
}

Search documentation

Type to search guides and reference pages.