Back to Redis

Index

content/operate/rs/references/rest-api/requests/ocsp/_index.md

latest3.6 KB
Original Source
MethodPathDescription
GET/v1/ocspGet OCSP configuration
PUT/v1/ocspUpdate OCSP configuration

Get OCSP configuration {#get-ocsp}

GET /v1/ocsp

Gets the cluster's OCSP configuration.

Required permissions

Permission name
[view_ocsp_config]({{< relref "/operate/rs/references/rest-api/permissions#view_ocsp_config" >}})

Request {#get-request}

Example HTTP request

GET /v1/ocsp 

Request headers

KeyValueDescription
Hostcnm.cluster.fqdnDomain name
Acceptapplication/jsonAccepted media type

Response {#get-response}

Returns an [OCSP configuration object]({{< relref "/operate/rs/references/rest-api/objects/ocsp" >}}).

Example JSON body

json
{
    "ocsp_functionality": true,
    "responder_url": "http://responder.ocsp.url.com",
    "query_frequency": 3800,
    "response_timeout": 2,
    "recovery_frequency": 80,
    "recovery_max_tries": 20
}

Error codes {#get-error-codes}

When errors occur, the server returns a JSON object with error_code and message fields that provide additional information. The following are possible error_code values:

CodeDescription
ocsp_unsupported_by_capabilityNot all nodes support OCSP capability

Status codes {#get-status-codes}

CodeDescription
200 OKSuccess
406 Not AcceptableFeature not supported in all nodes

Update OCSP configuration {#put-ocsp}

PUT /v1/ocsp

Updates the cluster's OCSP configuration.

Required permissions

Permission name
[config_ocsp]({{< relref "/operate/rs/references/rest-api/permissions#config_ocsp" >}})

Request {#put-request}

Example HTTP request

PUT /v1/ocsp 

Example JSON body

json
{
    "ocsp_functionality": true,
    "query_frequency": 3800,
    "response_timeout": 2,
    "recovery_frequency": 80,
    "recovery_max_tries": 20
}

Request headers

KeyValueDescription
Hostcnm.cluster.fqdnDomain name
Acceptapplication/jsonAccepted media type

Request body

Include an [OCSP configuration object]({{< relref "/operate/rs/references/rest-api/objects/ocsp" >}}) with updated fields in the request body.

Response {#put-response}

Returns the updated [OCSP configuration object]({{< relref "/operate/rs/references/rest-api/objects/ocsp" >}}).

Error codes {#put-error-codes}

When errors occur, the server returns a JSON object with error_code and message fields that provide additional information. The following are possible error_code values:

CodeDescription
invalid_schemaAn illegal parameter or a parameter with an illegal value
no_responder_urlTried to enable OCSP with no responder URL configured
ocsp_unsupported_by_capabilityNot all nodes support OCSP capability

Status codes {#put-status-codes}

CodeDescription
200 OKSuccess, OCSP config has been set
400 Bad RequestBad or missing configuration parameters
406 Not AcceptableFeature not supported in all nodes