/v1/api/{apiId}/specification/{itemId}

Specification
GET <baseUrl>/v1/api/{apiId}/specification/{itemId}

GET Get API Specification by ID

Retrieve a specific OpenAPI specification item by its unique identifier.

Responses

200 API specification retrieved successfully.
application/json
Type: [object] 
{
  "properties": {
    "Specification": {
      "type": "object"
    },
    "apiId": {
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string"
    },
    "version": {
      "type": "string"
    }
  },
  "type": "object"
}
401 Unauthorized
404 API specification not found

OPTIONS Options for API specification by ID

Responses

200 Options successful. Returns allowed HTTP methods.

POST Update API Specification by ID

Update an existing OpenAPI specification item by its unique identifier.

Request Body

Required
application/json
{
  "properties": {
    "Specification": {
      "type": "object"
    },
    "version": {
      "type": "string"
    }
  },
  "type": "object"
}

Responses

200 API specification updated successfully.
application/json
Type: [object] 
{
  "properties": {
    "id": {
      "type": "string"
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string"
    },
    "version": {
      "type": "string"
    }
  },
  "type": "object"
}
400 Invalid request
401 Unauthorized
404 API specification not found

Security

  • apiKeyAuth [apiKey]
    API Key authentication. Use the X-API-KEY header (generated from the Vaktum portal) to authenticate directly to a workspace.
    In: header
    Name: X-API-KEY
  • bearerAuth [http]
    OAuth2 authentication. Use the Authorization header with a Bearer token. Also provide X-WORKSPACE-ID header for workspace context.
    Scheme: bearer
    Bearer Format: JWT