API reference
Service
The API’s own description.
Paths are relative to the address of your Nullgap console. Authentication, errors, paging and rate limits are the same for every call and are described in the API overview.
| Operation | Method and path | Who may call it |
|---|---|---|
| Get the API description | GET /api/openapi.json | none |
#Get the API description
GET /api/openapi.json
This document: every public path and method with its parameters, request body, answers and the API key scope it needs, as OpenAPI 3.1. No key is needed. It is generated from the running server, so it describes the version you are talking to.
Who may call it: None. No key is needed.
Example request
curl -s \
"$NULLGAP_URL/api/openapi.json"
Answer (200, application/json)
| Field | Type | Always present | Description |
|---|---|---|---|
openapi | string | yes | The OpenAPI version of the document. |
info | object | yes | Title, version and the conventions every call shares. |
paths | object | yes | One entry per path, then per method. |
components | object | yes | The reusable schemas the paths refer to. |
{
"openapi": "3.1.0",
"info": {},
"paths": {},
"components": {}
}
Nullgap documentation