MethodPathDescription
GET/v1/jsonschemaGet 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

KeyValueDescription
Hostcnm.cluster.fqdnDomain name
Acceptapplication/jsonAccepted media type

Query parameters

FieldTypeDescription
objectstringOptional. 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

CodeDescription
200 OKSuccess.
406 Not AcceptableInvalid object.