JSON schema requests

API object JSON schema requests

Method Path Description
GET /v1/jsonschema Get JSON schema of API objects

Get object JSON schema

GET /v1/jsonschema

Get the JSON schema of various Redis Enterprise REST API objects.

Request

Example HTTP request

GET /jsonschema?object=bdb

Request headers

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type

Query parameters

Field Type Description
object string Optional. The API object name: 'cluster', 'node', 'bdb' etc.

Response

Returns the JSON schema of the specified API object.

Example JSON body

{
     "type": "object",
     "description": "An API object that represents a managed database in the cluster.",
     "properties": {
          "...."
     },
     "...."
}

Status codes

Code Description
200 OK Success.
406 Not Acceptable Invalid object.
RATE THIS PAGE
Back to top ↑