Get this OpenAPI document

Returns this OpenAPI 3.1 document, byte for byte the same file published at https://varsafe.dev/openapi.json. Needs no credential and may be cached for five minutes.

GET/openapi.json

Responses

200This OpenAPI 3.1 document, byte for byte as published at varsafe.dev.

openapistringrequired

infoobjectrequired

Show properties

titlestringrequired

versionstringrequired

pathsobjectrequired

400The request failed validation. `field` names the offending input.

statusCodeintegerrequired

HTTP status code, repeated in the body.

min -9007199254740991 · max 9007199254740991

codestringrequired

Stable machine-readable error code, e.g. `SECRET_NOT_FOUND` or `FORBIDDEN`. Branch on this, never on the message.

messagestringrequired

Human-readable explanation. Wording may change.

fieldstring

The offending request field, present on validation failures.

404The resource does not exist, or is not visible to this credential.

statusCodeintegerrequired

HTTP status code, repeated in the body.

min -9007199254740991 · max 9007199254740991

codestringrequired

Stable machine-readable error code, e.g. `SECRET_NOT_FOUND` or `FORBIDDEN`. Branch on this, never on the message.

messagestringrequired

Human-readable explanation. Wording may change.

fieldstring

The offending request field, present on validation failures.

429Rate limited. Retry after the interval named in the response.

statusCodeintegerrequired

HTTP status code, repeated in the body.

min -9007199254740991 · max 9007199254740991

codestringrequired

Stable machine-readable error code, e.g. `SECRET_NOT_FOUND` or `FORBIDDEN`. Branch on this, never on the message.

messagestringrequired

Human-readable explanation. Wording may change.

fieldstring

The offending request field, present on validation failures.

500Unexpected server error. The body never carries internal detail.

statusCodeintegerrequired

HTTP status code, repeated in the body.

min -9007199254740991 · max 9007199254740991

codestringrequired

Stable machine-readable error code, e.g. `SECRET_NOT_FOUND` or `FORBIDDEN`. Branch on this, never on the message.

messagestringrequired

Human-readable explanation. Wording may change.

fieldstring

The offending request field, present on validation failures.

Request

curl -X GET "https://api.varsafe.dev/openapi.json"

const response = await fetch("https://api.varsafe.dev/openapi.json", {
  method: "GET"
});

import requests

response = requests.get(
    "https://api.varsafe.dev/openapi.json",
)

Response

{
  "openapi": "3.1.0",
  "info": {
    "title": "string",
    "version": "string"
  },
  "paths": {}
}