Vaktum - /v1/api Documentation

/v1/api

Specification

GET <baseUrl>/v1/api

GET Get APIs

Retrieve a list of all APIs managed by the current user or organization.

Responses

200 APIs retrieved successfully.

OPTIONS Options for API

Responses

200 Options successful. Returns allowed HTTP methods.

POST Create API

Create a new API in Vaktum for testing, validation, and artifact generation. The API specification can be provided either as a URL to a publicly accessible OpenAPI specification or as a base64-encoded string containing the specification content.

Request Body

Required

API specification submission details

application/json

Schema: SpecificationSubmission

basicBase64Submission - Basic base64-encoded submission

{
  "data": "ewogICJvcGVuYXBpIjogIjMuMC4wIiwKICAiaW5mbyI6IHsKICAgICJ0aXRsZSI6ICJTYWlsIEFQSSIsCiAgICAidmVyc2lvbiI6ICIxLjAuMCIsCiAgICAiZGVzY3JpcHRpb24iOiAiQSBzaW1wbGUgQVBJIGZvciBkZW1vbnN0cmF0aW9uIgogIH0KfQ==",
  "type": "Base64"
}

basicUrlSubmission - Basic URL submission

{
  "type": "URL",
  "url": "https://petstore.swagger.io/v2/swagger.json"
}

completeBase64Submission - Complete base64-encoded submission with metadata

{
  "data": "ewogICJvcGVuYXBpIjogIjMuMC4wIiwKICAiaW5mbyI6IHsKICAgICJ0aXRsZSI6ICJQYXltZW50IFByb2Nlc3NpbmcgQVBJIiwKICAgICJ2ZXJzaW9uIjogIjIuMS4wIiwKICAgICJkZXNjcmlwdGlvbiI6ICJBIGNvbXByZWhlbnNpdmUgcGF5bWVudCBwcm9jZXNzaW5nIEFQSSB0aGF0IHN1cHBvcnRzIGNyZWRpdCBjYXJkcywgQUNILCBhbmQgY3J5cHRvY3VycmVuY3kgcGF5bWVudHMuIgogIH0KfQ==",
  "description": "Enterprise-grade payment processing API with multi-currency support and comprehensive transaction lifecycle management",
  "name": "Payment Processing API",
  "type": "Base64"
}

urlSubmissionWithMetadata - URL submission with custom metadata

{
  "description": "A complete pet store API with enhanced documentation and examples",
  "name": "Enhanced Petstore API",
  "type": "URL",
  "url": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json"
}

Responses

201 API created successfully.

application/json

Type: [object]

{
  "properties": {
    "id": {
      "description": "The unique identifier of the created API",
      "type": "string"
    },
    "name": {
      "description": "The name of the created API",
      "type": "string"
    }
  },
  "type": "object"
}

400 Invalid input - the provided specification is not valid or could not be processed

application/json

Schema: ErrorResponse

401 Unauthorized - authentication required

403 Forbidden - insufficient permissions to create an API

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