{
  "schema_version": 2,
  "id": "operate/rs/references/rest-api/requests/suffix",
  "title": "Suffix requests",
  "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/suffix/",
  "summary": "DNS suffix requests",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2025-03-10T13:08:54-04:00",
  "children": [],
  "page_type": "content",
  "content_hash": "e2a9caedc9175cdb8998ac4aa41c633257f7b6e076c4042b06bf08750ed11542",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "| Method | Path | Description |\n|--------|------|-------------|\n| [GET](#get-suffix) | `/v1/suffix/{name}` | Get a single DNS suffix |"
    },
    {
      "id": "get-suffix",
      "title": "Get suffix",
      "role": "content",
      "text": "GET /v1/suffix/{string: name}\n\nGet a single DNS suffix."
    },
    {
      "id": "get-request",
      "title": "Request",
      "role": "content",
      "text": "#### Example HTTP request\n\n\tGET /v1/suffix/cluster.fqdn \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\n#### URL parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| name | string | The unique name of the suffix requested. |"
    },
    {
      "id": "get-response",
      "title": "Response",
      "role": "returns",
      "text": "Returns a [suffix object](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/suffix).\n\n#### Example JSON body\n\n[code example]"
    },
    {
      "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) | No error |\n| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | Suffix name does not exist |"
    }
  ],
  "examples": [
    {
      "id": "get-response-ex0",
      "language": "json",
      "code": "{\n    \"name\": \"cluster.fqdn\",\n    \"// additional fields...\"\n}",
      "section_id": "get-response"
    }
  ]
}
