Settings

Edit online

The method reference for using the Ceph RESTful API settings endpoint to manage the various Ceph settings.

GET /api/settings

Description

Display the list of available options

Parameters

  • Queries:

  • names - A comma-separated list of option names.

Example 

GET /api/settings HTTP/1.1
Host: example.com
Status Codes

  • 200 OK – Okay.

  • 400 Bad Request – Operation exception. Please check the response body for details.

  • 401 Unauthorized – Unauthenticated access. Please login first.

  • 403 Forbidden – Unauthorized access. Please check your permissions.

  • 500 Internal Server Error – Unexpected error. Please check the response body for the stack trace.

PUT /api/settings

Status Codes

  • 200 OK – Okay.

  • 202 Accepted – Operation is still executing. Please check the task queue.

  • 400 Bad Request – Operation exception. Please check the response body for details.

  • 401 Unauthorized – Unauthenticated access. Please login first.

  • 403 Forbidden – Unauthorized access. Please check your permissions.

  • 500 Internal Server Error – Unexpected error. Please check the response body for the stack trace.

DELETE /api/settings/_NAME

Parameters

  • Replace NAME with the option name as a string.

Status Codes

  • 202 Accepted – Operation is still executing. Please check the task queue.

  • 204 No Content – Resource deleted.

  • 400 Bad Request – Operation exception. Please check the response body for details.

  • 401 Unauthorized – Unauthenticated access. Please login first.

  • 403 Forbidden – Unauthorized access. Please check your permissions.

  • 500 Internal Server Error – Unexpected error. Please check the response body for the stack trace.

GET /api/settings/_NAME

Description

Display the given option.

Parameters

  • Replace NAME with the option name as a string.

Example

GET /api/settings/NAME HTTP/1.1
Host: example.com
Status Codes

  • 200 OK – Okay.

  • 400 Bad Request – Operation exception. Please check the response body for details.

  • 401 Unauthorized – Unauthenticated access. Please login first.

  • 403 Forbidden – Unauthorized access. Please check your permissions.

  • 500 Internal Server Error – Unexpected error. Please check the response body for the stack trace.

PUT /api/settings/_NAME

Parameters

  • Replace NAME with the option name as a string.

Example 

PUT /api/settings/NAME HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "value": "STRING"
}
Status Codes

  • 200 OK – Okay.

  • 202 Accepted – Operation is still executing. Please check the task queue.

  • 400 Bad Request – Operation exception. Please check the response body for details.

  • 401 Unauthorized – Unauthenticated access. Please login first.

  • 403 Forbidden – Unauthorized access. Please check your permissions.

  • 500 Internal Server Error – Unexpected error. Please check the response body for the stack trace.