API Reference

Get a Gateway

get
https://{region}.api.jamfcloud.com/securitycloud/v1/ztna/gateways/

Get a single dedicated Gateway. All fields are flat at the top level. Returns 404 if the gateway does not exist or belongs to a different tenant — never 403, to avoid confirming the existence of gateways owned by other tenants (Gateway IDs are 16-bit enumerable; a 403 would be an existence oracle).

Required Permissions: ztna:read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[0-9a-f]{4}$

ID of the Gateway (obtained from GET /gateways or a create response). Format: 4-character lowercase hexadecimal string (e.g. a1b2).

Headers
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.

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

404

Gateway not found or belongs to a different tenant.

Updated 12 days ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 days ago

Did this page help you?