Configuration Resource

Endpoints under /config provide access to the configuration options that control job and web server behavior.
Individual configuration options are represented by the ConfigProperty object.

GET /v2/config

A GET request to the /config endpoint retrieves the current configuration settings.

Response Body
media type data type description
application/json map of ConfigProperty (JSON)

Example

Request
GET /v2/config
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "..." : {
    "label" : "...",
    "category" : "DISCOVERY",
    "value" : { },
    "defaultValue" : { },
    "type" : "BOOLEAN",
    "description" : "...",
    "visible" : true,
    "readOnly" : true,
    "restartRequired" : true
  }
}
                
              

POST /v2/config/{name}

A POST request to the /config/name endpoint updates the value of the named configuration property.

Request Parameters
name type description
name path
Request Body
media type data type
application/json ConfigProperty (JSON)
Response Body
media type data type description
application/json ConfigProperty (JSON)

Example

Request
POST /v2/config/{name}
Content-Type: application/json
Accept: application/json

                
{
  "label" : "...",
  "category" : "SECURITY",
  "value" : { },
  "defaultValue" : { },
  "type" : "TIMESTAMP",
  "description" : "...",
  "visible" : true,
  "readOnly" : true,
  "restartRequired" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "label" : "...",
  "category" : "API",
  "value" : { },
  "defaultValue" : { },
  "type" : "MAP",
  "description" : "...",
  "visible" : true,
  "readOnly" : true,
  "restartRequired" : true
}