OCSP requests
OCSP requests
| Redis Enterprise Software |
|---|
| Method | Path | Description |
|---|---|---|
| GET | /v1/ocsp |
Get OCSP configuration |
| PUT | /v1/ocsp |
Update OCSP configuration |
Get OCSP configuration
GET /v1/ocsp
Gets the cluster's OCSP configuration.
Required permissions
| Permission name |
|---|
| view_ocsp_config |
Request
Example HTTP request
GET /v1/ocsp
Request headers
| Key | Value | Description |
|---|---|---|
| Host | cnm.cluster.fqdn | Domain name |
| Accept | application/json | Accepted media type |
Response
Returns an OCSP configuration object.
Example JSON body
{
"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
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:
| Code | Description |
|---|---|
| ocsp_unsupported_by_capability | Not all nodes support OCSP capability |
Status codes
| Code | Description |
|---|---|
| 200 OK | Success |
| 406 Not Acceptable | Feature not supported in all nodes |
Update OCSP configuration
PUT /v1/ocsp
Updates the cluster's OCSP configuration.
Required permissions
| Permission name |
|---|
| config_ocsp |
Request
Example HTTP request
PUT /v1/ocsp
Example JSON body
{
"ocsp_functionality": true,
"query_frequency": 3800,
"response_timeout": 2,
"recovery_frequency": 80,
"recovery_max_tries": 20
}
Request headers
| Key | Value | Description |
|---|---|---|
| Host | cnm.cluster.fqdn | Domain name |
| Accept | application/json | Accepted media type |
Request body
Include an OCSP configuration object with updated fields in the request body.
Response
Returns the updated OCSP configuration object.
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:
| Code | Description |
|---|---|
| invalid_schema | An illegal parameter or a parameter with an illegal value |
| no_responder_url | Tried to enable OCSP with no responder URL configured |
| ocsp_unsupported_by_capability | Not all nodes support OCSP capability |
Status codes
| Code | Description |
|---|---|
| 200 OK | Success, OCSP config has been set |
| 400 Bad Request | Bad or missing configuration parameters |
| 406 Not Acceptable | Feature not supported in all nodes |