{
  "schema_version": 2,
  "id": "operate/rs/references/rest-api/requests/ocsp",
  "title": "OCSP requests",
  "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/ocsp/",
  "summary": "OCSP requests",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2025-03-10T13:08:54-04:00",
  "children": [
    {
      "id": "operate/rs/references/rest-api/requests/ocsp/status",
      "summary": "OCSP status requests",
      "title": "OCSP status requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/ocsp/status/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/ocsp/test",
      "summary": "OCSP test requests",
      "title": "OCSP test requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/ocsp/test/"
    }
  ],
  "page_type": "content",
  "content_hash": "2e2d82a54337c3ef4a0903ee3f80730c50552f701b14c3e34623fa5b6e15f6d0",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "| Method | Path | Description |\n|--------|------|-------------|\n| [GET](#get-ocsp) | `/v1/ocsp` | Get OCSP configuration |\n| [PUT](#put-ocsp) | `/v1/ocsp` | Update OCSP configuration |"
    },
    {
      "id": "get-ocsp",
      "title": "Get OCSP configuration",
      "role": "content",
      "text": "GET /v1/ocsp\n\nGets the cluster's OCSP configuration.\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [view_ocsp_config](https://redis.io/docs/latest/operate/rs/references/rest-api/permissions#view_ocsp_config) |"
    },
    {
      "id": "get-request",
      "title": "Request",
      "role": "content",
      "text": "#### 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 |"
    },
    {
      "id": "get-response",
      "title": "Response",
      "role": "returns",
      "text": "Returns an [OCSP configuration object](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/ocsp).\n\n#### Example JSON body\n\n[code example]"
    },
    {
      "id": "get-error-codes",
      "title": "Error codes",
      "role": "errors",
      "text": "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:\n\n| Code | Description |\n|------|-------------|\n| ocsp_unsupported_by_capability | Not all nodes support OCSP capability |"
    },
    {
      "id": "get-status-codes",
      "title": "Status codes",
      "role": "content",
      "text": "| 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 |"
    },
    {
      "id": "put-ocsp",
      "title": "Update OCSP configuration",
      "role": "content",
      "text": "PUT /v1/ocsp\n\nUpdates the cluster's OCSP configuration.\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [config_ocsp](https://redis.io/docs/latest/operate/rs/references/rest-api/permissions#config_ocsp) |"
    },
    {
      "id": "put-request",
      "title": "Request",
      "role": "content",
      "text": "#### Example HTTP request\n\n\tPUT /v1/ocsp \n\n#### Example JSON body\n\n[code example]\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](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/ocsp) with updated fields in the request body."
    },
    {
      "id": "put-response",
      "title": "Response",
      "role": "returns",
      "text": "Returns the updated [OCSP configuration object](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/ocsp)."
    },
    {
      "id": "put-error-codes",
      "title": "Error codes",
      "role": "errors",
      "text": "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:\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 |"
    },
    {
      "id": "put-status-codes",
      "title": "Status codes",
      "role": "content",
      "text": "| 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 |"
    }
  ],
  "examples": [
    {
      "id": "get-response-ex0",
      "language": "json",
      "code": "{\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}",
      "section_id": "get-response"
    },
    {
      "id": "put-request-ex0",
      "language": "json",
      "code": "{\n    \"ocsp_functionality\": true,\n    \"query_frequency\": 3800,\n    \"response_timeout\": 2,\n    \"recovery_frequency\": 80,\n    \"recovery_max_tries\": 20\n}",
      "section_id": "put-request"
    }
  ]
}