MethodPathDescription
GET/v1/suffix/{name}Get a single DNS suffix

Get suffix

GET /v1/suffix/{string: name}

Get a single DNS suffix.

Request

Example HTTP request

GET /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

Returns a suffix object.

Example JSON body

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

Status codes

CodeDescription
200 OKNo error
404 Not FoundSuffix name does not exist