Update a DNS Zone

patch

https://{region}.api.jamfcloud.com/securitycloud/v1/dns/zones/{id}

Partially updates a DNS Zone using JSON Merge Patch (RFC 7396). Any subset of the writable Zone fields may be supplied. A field set to a new value is overwritten; an omitted field is left unchanged; a field set to null clears it where the field is optional. Setting a required field to null is rejected (400, per ADG-302). No optimistic locking is in place for this release — consider ADG-148 (VersionId + 409 OPTIMISTIC_LOCK_FAILED) in a follow-up if this becomes a concern.

Required Permissions: ztna:update

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

^[A-Za-z0-9_-]{16,64}$

Identifier of the DNS Zone to operate on.

Body Params

JSON Merge Patch (RFC 7396) request body for updating a DNS Zone. Any subset of the writable Zone fields may be supplied; omitted fields are left unchanged. A field set to null clears it where the field is optional; setting a required field to null is rejected (400, per ADG-302).

name

string

length between 1 and 100

Updated name of the DNS Zone. 1 to 100 characters when supplied. Omit to leave unchanged.

domains

array of strings

length between 1 and 100

Updated list of domains served by this DNS Zone. Omit to leave unchanged.

domains

A fully qualified domain served by the Zone.

nameServers

array of objects

length between 1 and 20

Updated list of name servers for this Zone. Omit to leave unchanged.

nameServers

A name server entry that resolves queries for a DNS Zone.

string

required

length ≥ 1

IPv4 address of the name server.

gatewayId

string

required

length ≥ 1

Public identifier for the gateway. This is the public-facing name for the internal route identifier.

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 DNS Zone was updated. 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 merge patch failed validation — a field carries a malformed value, or a required field was explicitly set to null (per ADG-302) (INVALID_FIELD), or an array field exceeds its maximum size such as more than 100 domains or 20 nameServers (LIST_SIZE_EXCEEDED).

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.

404Not Found. No DNS Zone with the supplied identifier exists for the tenant, or the Zone is owned by a different tenant.

409Conflict. The update would collide with an existing DNS Zone on name or an overlapping domain.

422Unprocessable Entity. The request is well formed but cannot be processed: the referenced gateway is unknown or not owned by the tenant (GATEWAY_NOT_FOUND), a name server IP falls outside the permitted range (NAMESERVER_IP_OUT_OF_RANGE) or is otherwise restricted (NAMESERVER_IP_RESTRICTED).

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.

503Service Unavailable. A downstream dependency required to validate route ownership was unavailable. The request may be retried.