{
  "id": "ocsp",
  "title": "OCSP requests",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/ocsp/",
  "summary": "OCSP requests",
  "content": "\n| Method | Path | Description |\n|--------|------|-------------|\n| [GET](#get-ocsp) | `/v1/ocsp` | Get OCSP configuration |\n| [PUT](#put-ocsp) | `/v1/ocsp` | Update OCSP configuration |\n\n## Get OCSP configuration {#get-ocsp}\n\n\tGET /v1/ocsp\n\nGets the cluster's OCSP configuration.\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [view_ocsp_config]() |\n\n### Request {#get-request} \n\n#### Example HTTP request\n\n\tGET /v1/ocsp \n\n\n#### Request headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n### Response {#get-response} \n\nReturns an [OCSP configuration object]().\n\n#### Example JSON body\n\n```json\n{\n    \"ocsp_functionality\": true,\n    \"responder_url\": \"http://responder.ocsp.url.com\",\n    \"query_frequency\": 3800,\n    \"response_timeout\": 2,\n    \"recovery_frequency\": 80,\n    \"recovery_max_tries\": 20\n}\n```\n\n### Error codes {#get-error-codes} \n\nWhen 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:\n\n| Code | Description |\n|------|-------------|\n| ocsp_unsupported_by_capability | Not all nodes support OCSP capability | \n\n### Status codes {#get-status-codes} \n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | Success |\n| [406 Not Acceptable](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7) | Feature not supported in all nodes |\n\n## Update OCSP configuration {#put-ocsp}\n\n\tPUT /v1/ocsp\n\nUpdates the cluster's OCSP configuration.\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [config_ocsp]() |\n\n### Request {#put-request} \n\n#### Example HTTP request\n\n\tPUT /v1/ocsp \n\n#### Example JSON body\n\n```json\n{\n    \"ocsp_functionality\": true,\n    \"query_frequency\": 3800,\n    \"response_timeout\": 2,\n    \"recovery_frequency\": 80,\n    \"recovery_max_tries\": 20\n}\n```\n\n#### Request headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n#### Request body\n\nInclude an [OCSP configuration object]() with updated fields in the request body.\n\n### Response {#put-response} \n\nReturns the updated [OCSP configuration object]().\n\n### Error codes {#put-error-codes} \n\nWhen 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:\n\n| Code | Description |\n|------|-------------|\n| invalid_schema | An illegal parameter or a parameter with an illegal value |\n| no_responder_url | Tried to enable OCSP with no responder URL configured |\n| ocsp_unsupported_by_capability | Not all nodes support OCSP capability |\n\n### Status codes {#put-status-codes} \n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | Success, OCSP config has been set |\n| [400 Bad Request](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1) | Bad or missing configuration parameters |\n| [406 Not Acceptable](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7) | Feature not supported in all nodes |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00",
  "children": [{"id":"status","summary":"OCSP status requests","title":"OCSP status requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/ocsp/status/"},{"id":"test","summary":"OCSP test requests","title":"OCSP test requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/ocsp/test/"}]
}

