Response
configuration-status
statusstring
progressarray[object]
Get the configuration status
This endpoint allows you to check the status of the most recent configuration process:
Note that you may need to wait several seconds after you start a process before you can check its status.
The different statuses are:
| Status | Description |
|---|---|
PENDING |
The job has not started yet |
CONFIGURING |
The job is running |
DONE |
The job has finished correctly |
FAILED |
The job has finished unexpectedly |
get
http://HOSTNAME/api/v3/setup/api/configcheck
Response
200 application/json
Response
200 application/json
get/setup/api/configcheck
200 application/json
Start a configuration process
This endpoint allows you to start a configuration process at any time for your updated settings to take effect:
post
http://HOSTNAME/api/v3/setup/api/configure
Response
202
Response
202
Response
post/setup/api/configure
202
Get the maintenance status
Check your installation’s maintenance status:
get
http://HOSTNAME/api/v3/setup/api/maintenance
Response
200 application/json
Response
200 application/json
Response
maintenance-status
statusstring
scheduled_timestring
connection_servicesarray[object]
Show Child Parameters
get/setup/api/maintenance
200 application/json
Enable or disable maintenance mode
Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
post
http://HOSTNAME/api/v3/setup/api/maintenance
Body
application/x-www-form-urlencoded
Body
application/x-www-form-urlencoded
maintenancestringrequired
A JSON string with the attributes enabled and when.
The possible values for enabled are true and false. When it’s false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.
The possible values for when are now or any date parseable by mojombo/chronic.
Response
200 application/json
Response
200 application/json
Response
maintenance-status
statusstring
scheduled_timestring
connection_servicesarray[object]
Show Child Parameters
post/setup/api/maintenance
Body
{
"maintenance": "{\"enabled\":true, \"when\":\"now\"}"
}
200 application/json
Get settings
get
http://HOSTNAME/api/v3/setup/api/settings
Response
200 application/json
Response
200 application/json
Response
enterprise-settings
enterpriseobject
Show Child Parameters
run_listarray[string]
get/setup/api/settings
200 application/json