---
title: "Return the OpenAPI 3.1 document describing this REST API."
method: GET
path: "/v1/openapi.json"
---

# Return the OpenAPI 3.1 document describing this REST API.

`GET /v1/openapi.json`

## Request

- Base URL: `http://127.0.0.1:10108`
- URL: `http://127.0.0.1:10108/v1/openapi.json`
- Auth: HTTP bearer

Returns the OpenAPI 3.1 document of this API, built from the same catalog as this list. It describes every route's parameters, request body and each status it answers, with a real example. Nothing on this machine is read or changed.

## Response `200`

The OpenAPI 3.1 document of this API.

- object
  - `components` object, required
  - `info` object, required
  - `openapi` '3.1.0', required
  - `paths` object, required
  - `security` unknown[], required
    - unknown
  - `servers` unknown[], required
    - unknown

## Other responses

- `401`: No bearer token, or not a token this app issued. The body is empty: it never says which.
- `403`: Refused by the plan: it no longer includes the local API (checked on every request), or it does not allow this action (profile or schedule limit, parallel runs). A request whose Host header is not loopback is also 403, with an empty body.
- `500`: Veilus failed: storage could not be read or written, or a task panicked. The message says what failed; retrying rarely helps.

---

[API](https://skmtc.dev/veilus/apis/veilus-local-api.md) · [All operations](https://skmtc.dev/veilus/apis/veilus-local-api/llms.txt) · [OpenAPI document](https://skmtc.dev/veilus/apis/veilus-local-api/revisions/67ac3818f9d2?raw)