Console API

Console API provides API functionality against console settings.

/console/v1/option

Returns values corresponding to the given console option name.

Request paramerters

Name

Type

Description

name

String

Option name

Response Status

Status

Description

200

Success

400

Bad request

Response body

Option value (string)

/console/v1/auth

Authenticates against the console authentication settings.

Request payload

Name

Type

Description

username

String

Username (required only for authentication type LDAP)

password

String

Password

Response Status

Status

Description

200

Authentication successful

400

Bad request

401

Invalid authentication credentials

Response body

no content