/v1/api/{apiId}/data-model

GET <baseUrl>/v1/api/{apiId}/data-model

GET Get Data Model

Retrieve the data model associated with the specified API.

Responses

200 Data model retrieved successfully.

OPTIONS Options for data model

Responses

200 Options successful. Returns allowed HTTP methods.

POST Create Data Model

Create a new data model for the specified API.

Request Body

Required
application/json
Schema: DataModel
userModel - User data model
{
  "fields": [
    {
      "name": "id",
      "type": "integer"
    },
    {
      "name": "email",
      "type": "string"
    }
  ],
  "name": "User"
}

Responses

201 Data model created successfully.

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