Core
API v2.x
2

openapi #

Returns available API routes OpenAPI v3 specifications.

Available since 2.17.0

By default, the action returns Kuzzle standard API specification, to return the custom specification from the plugins and application, the scope parameter should be app.


Query Syntax #

HTTP #

Copied to clipboard!
URL: http://kuzzle:7512/_openapi[?format=<json|yaml>][scope=<app|kuzzle>]
Method: GET

Other protocols #

Copied to clipboard!
{
  "controller": "server",
  "action": "openapi",
  "format": "<json|yaml>",
  "scope": "<kuzzle|app",
}

Response #

Returns the OpenAPI v3 specifications JSON (by default) or YAML formatted.

  • JSON format:
Copied to clipboard!
{
  "openapi": "3.0.1",
  "info": {
    "title":"Kuzzle API",
    "description":"The Kuzzle HTTP API",
    "contact": {
      "name":"Kuzzle team",
      "url":"http://kuzzle.io",
      "email":"hello@kuzzle.io"
    },
    "license": {
      "name":"Apache 2",
      "url":"http://opensource.org/licenses/apache2.0"
    },
    "version":"2.4.5"
  },
  // ...
}
  • YAML format:
Copied to clipboard!
openapi: 3.0.1
info:
  title: Kuzzle API
  description: The Kuzzle HTTP API
  contact:
    name: Kuzzle team
    url: http://kuzzle.io
    email: hello@kuzzle.io
  license:
    name: Apache 2
    url: http://opensource.org/licenses/apache2.0
  version: 2.4.5
# ...