Back to Redis

Index

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

latest1.1 KB
Original Source
MethodPathDescription
GET/v1/suffix/{name}Get a single DNS suffix

Get suffix {#get-suffix}

GET /v1/suffix/{string: name}

Get a single DNS suffix.

Request {#get-request}

Example HTTP request

GET /v1/suffix/cluster.fqdn 

Request headers

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

URL parameters

FieldTypeDescription
namestringThe unique name of the suffix requested.

Response {#get-response}

Returns a [suffix object]({{< relref "/operate/rs/references/rest-api/objects/suffix" >}}).

Example JSON body

json
{
    "name": "cluster.fqdn",
    "// additional fields..."
}

Status codes {#get-status-codes}

CodeDescription
200 OKNo error
404 Not FoundSuffix name does not exist