Get device settings profile by ID
client.zeroTrust.devices.policies.custom.get(stringpolicyId, CustomGetParams { account_id } params, RequestOptionsoptions?): SettingsPolicy { allow_mode_switch, allow_updates, allowed_to_leave, 27 more } | null
GET/accounts/{account_id}/devices/policy/{policy_id}
Fetches a device settings profile by ID.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Get device settings profile by ID
import Cloudflare from 'cloudflare';
const client = new Cloudflare({
apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});
const settingsPolicy = await client.zeroTrust.devices.policies.custom.get(
'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
{ account_id: '699d98642c564d2e855e9661899b7252' },
);
console.log(settingsPolicy.gateway_unique_id);{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": {
"allow_mode_switch": true,
"allow_updates": true,
"allowed_to_leave": true,
"auto_connect": 0,
"captive_portal": 180,
"default": false,
"description": "Policy for test teams.",
"disable_auto_fallback": true,
"dns_search_suffixes": [
{
"suffix": "internal.corp",
"description": "Example internal domains"
}
],
"enabled": true,
"exclude": [
{
"address": "192.0.2.0/24",
"description": "Exclude testing domains from the tunnel"
}
],
"exclude_office_ips": true,
"fallback_domains": [
{
"suffix": "example.com",
"description": "Domain bypass for local development",
"dns_server": [
"1.1.1.1"
]
}
],
"gateway_unique_id": "699d98642c564d2e855e9661899b7252",
"global_acceleration": {
"api_endpoints": [
"198.51.100.1:443"
],
"enabled": true,
"masque_endpoints": [
"198.51.100.1:443"
],
"wireguard_endpoints": [
"198.51.100.1:2408"
]
},
"include": [
{
"address": "192.0.2.0/24",
"description": "Include testing domains in the tunnel"
}
],
"lan_allow_minutes": 30,
"lan_allow_subnet_size": 24,
"match": "identity.email == \"test@cloudflare.com\"",
"name": "Allow Developers",
"policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"precedence": 100,
"register_interface_ip_with_dns": true,
"sccm_vpn_boundary_support": false,
"service_mode_v2": {
"mode": "proxy",
"port": 3000
},
"support_url": "https://1.1.1.1/help",
"switch_locked": true,
"target_tests": [
{
"id": "id",
"name": "name"
}
],
"tunnel_protocol": "wireguard",
"virtual_networks": {
"allowed": [
"f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
],
"default": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
}
},
"success": true
}Returns Examples
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": {
"allow_mode_switch": true,
"allow_updates": true,
"allowed_to_leave": true,
"auto_connect": 0,
"captive_portal": 180,
"default": false,
"description": "Policy for test teams.",
"disable_auto_fallback": true,
"dns_search_suffixes": [
{
"suffix": "internal.corp",
"description": "Example internal domains"
}
],
"enabled": true,
"exclude": [
{
"address": "192.0.2.0/24",
"description": "Exclude testing domains from the tunnel"
}
],
"exclude_office_ips": true,
"fallback_domains": [
{
"suffix": "example.com",
"description": "Domain bypass for local development",
"dns_server": [
"1.1.1.1"
]
}
],
"gateway_unique_id": "699d98642c564d2e855e9661899b7252",
"global_acceleration": {
"api_endpoints": [
"198.51.100.1:443"
],
"enabled": true,
"masque_endpoints": [
"198.51.100.1:443"
],
"wireguard_endpoints": [
"198.51.100.1:2408"
]
},
"include": [
{
"address": "192.0.2.0/24",
"description": "Include testing domains in the tunnel"
}
],
"lan_allow_minutes": 30,
"lan_allow_subnet_size": 24,
"match": "identity.email == \"test@cloudflare.com\"",
"name": "Allow Developers",
"policy_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"precedence": 100,
"register_interface_ip_with_dns": true,
"sccm_vpn_boundary_support": false,
"service_mode_v2": {
"mode": "proxy",
"port": 3000
},
"support_url": "https://1.1.1.1/help",
"switch_locked": true,
"target_tests": [
{
"id": "id",
"name": "name"
}
],
"tunnel_protocol": "wireguard",
"virtual_networks": {
"allowed": [
"f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
],
"default": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
}
},
"success": true
}