Returns the description of variables

GET 
/api/v2/templates/vars/:path

Returns the description of variables

Request

Path Parameters

path stringrequired

The path (in '.' notation) to the variable to describe

Query Parameters

recurse string

will return all the nested objects

Responses

200

The variables available to a template

application/json

Schema

Schema

• Array [

description string
examples string[]
includes undefined[]
name string
onlyFor string
path stringrequired
pathInContainer string
pathToContainer string
source string
type stringrequired

• ]

Example (from schema)

[
  {
    "description": "string",
    "examples": [
      "string"
    ],
    "includes": [
      null
    ],
    "name": "string",
    "onlyFor": "string",
    "path": "string",
    "pathInContainer": "string",
    "pathToContainer": "string",
    "source": "string",
    "type": "string"
  }
]

400

Validation error of supplied parameters/body

application/json

Schema

Schema

code int32required

fieldErrors

undefined[]

required

Array [

errCode stringrequired

field stringrequired

message stringrequired

]

message stringrequired

Example (from schema)

{
  "code": 0,
  "fieldErrors": [
    {
      "errCode": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "message": "string"
}

401

If not authenticated

403

If authenticated but not authorized

500

A generic API error containing the cause of the error

application/json

Schema

Schema

code int32required
detail stringrequired
message stringrequired
uri stringrequired
verb stringrequired

Example (from schema)

{
  "code": 0,
  "detail": "string",
  "message": "string",
  "uri": "string",
  "verb": "string"
}

Loading...