/v1/api/{apiId}/specification

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

GET Get API Specification

Retrieve the OpenAPI specification associated with the specified API.

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"
}
{
  "Specification": {
    "info": {
      "title": "Sample API",
      "version": "1.0.0"
    },
    "openapi": "3.0.0",
    "paths": {}
  },
  "apiId": "api-456",
  "createdAt": "2025-05-01T10:00:00Z",
  "id": "spec-123",
  "updatedAt": "2025-05-14T15:30:00Z",
  "version": "1.0.0"
}
401 Unauthorized
404 API specification not found

OPTIONS Options for API specification

Responses

200 Options successful. Returns allowed HTTP methods.

POST Create API Specification

Create a new OpenAPI specification for the specified API.

Request Body

Required
application/json
{
  "properties": {
    "Specification": {
      "type": "object"
    },
    "version": {
      "type": "string"
    }
  },
  "required": [
    "Specification"
  ],
  "type": "object"
}
{
  "Specification": {
    "info": {
      "title": "Sample API",
      "version": "1.0.0"
    },
    "openapi": "3.0.0",
    "paths": {}
  },
  "version": "1.0.0"
}

Responses

201 API specification created successfully.
application/json
Type: [object] 
{
  "properties": {
    "apiId": {
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "version": {
      "type": "string"
    }
  },
  "type": "object"
}
400 Invalid request
401 Unauthorized

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