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.
A GET request to the /config
endpoint retrieves the current configuration settings.
media type | data type | description |
---|---|---|
application/json | map of ConfigProperty (JSON) |
GET /v2/config
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"..." : {
"label" : "...",
"category" : "JobManager",
"value" : { },
"defaultValue" : { },
"type" : "OBJECT",
"description" : "...",
"visible" : true,
"readOnly" : true,
"restartRequired" : true,
"uiConfig" : true
}
}
A POST request to the /config/name
endpoint updates the value of the named configuration property.
name | type | description |
---|---|---|
name | path |
media type | data type |
---|---|
application/json | ConfigProperty (JSON) |
media type | data type | description |
---|---|---|
application/json | ConfigProperty (JSON) |
POST /v2/config/{name}
Content-Type: application/json
Accept: application/json
{
"label" : "...",
"category" : "MetadataService",
"value" : { },
"defaultValue" : { },
"type" : "LONG",
"description" : "...",
"visible" : true,
"readOnly" : true,
"restartRequired" : true,
"uiConfig" : true
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"label" : "...",
"category" : "MetadataService",
"value" : { },
"defaultValue" : { },
"type" : "MAP",
"description" : "...",
"visible" : true,
"readOnly" : true,
"restartRequired" : true,
"uiConfig" : true
}