Set the Search Domain

put

https://{region}.api.jamfcloud.com/securitycloud/v1/dns/search-domains

Sets the tenant Search Domain to the supplied suffix. Any previously set search domain is overwritten.

Required Permissions: search-domains:update

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The tenant Search Domain — a singleton resource holding a single optional search-domain suffix.

suffix

string

required

length between 1 and 253

The DNS search suffix appended to unqualified host names. Bounded to the maximum DNS name length of 253 characters (RFC 1035).

Headers

X-Tenant-Id

uuid

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The tenant UUID identifier. Send it to address tenant scope. This API is also published at environment scope — send that scope's header instead. Send exactly one scope header per request.

X-Environment-Id

uuid

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The environment UUID identifier. Send it to address environment scope. This API is also published at tenant scope — send that scope's header instead. Send exactly one scope header per request.

Responses

204

The Search Domain was set. No content is returned.

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad Request. The request body failed validation — for example, a malformed search-domain suffix (INVALID_FIELD).

401Unauthorized. The access token is missing, invalid, or expired, or the token belongs to a different organization than the tenant in the request path.

403Forbidden. The authenticated principal does not hold the privilege required to perform this operation.

429Too Many Requests. The client has exceeded the rate limit for this endpoint. Inspect the RateLimit-* and Retry-After headers to determine when to retry.