Internal DocumentHub admin Api very long name and description

Get settings

get
http://HOSTNAME/api/v3/setup/api/settings

Response

200 application/json

Response

enterprise-settings

enterpriseobject
Show Child Parameters
run_listarray[string]
 
200 application/json

Set settings

For a list of the available settings, see the Get settings endpoint.

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.

put
http://HOSTNAME/api/v3/setup/api/settings

Body

application/x-www-form-urlencoded
settingsstringrequired

A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.

Response

204

Response

 
204

Get all authorized SSH keys

get
http://HOSTNAME/api/v3/setup/api/settings/authorized-keys

Response

200 application/json

Response

keystring
pretty-printstring
 
200 application/json

Add an authorized SSH key

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/settings/authorized-keys

Body

application/x-www-form-urlencoded
authorized_keystringrequired

The public SSH key.

Response

201 application/json

Response

keystring
pretty-printstring
 
201 application/json

Remove an authorized SSH key

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.

delete
http://HOSTNAME/api/v3/setup/api/settings/authorized-keys

Body

application/x-www-form-urlencoded
authorized_keystringrequired

The public SSH key.

Response

200 application/json

Response

keystring
pretty-printstring
 
200 application/json