Search + K

Command Palette

Search for a command to run...

Sign In

Get device settings profile by ID

GET /accounts/{account_id}/devices/policy/{policy_id}
Copy endpoint
https://api.cloudflare.com/client/v4

Fetches a device settings profile by ID.

Parameters

path Path Parameters

Name Type
policy_id required
type TeamsDevicesSchemasUuid = string
account_id required
type TeamsDevicesIdentifier = unknown

Responses

200 application/json

Get device settings profile by ID response.

type TeamsDevicesDeviceSettingsResponse = type TeamsDevicesApiResponseSingle = never & { result?: TeamsDevicesDeviceSettingsPolicy
interface TeamsDevicesDeviceSettingsPolicy {
allow_mode_switch?: TeamsDevicesAllowModeSwitch;
allow_updates?: TeamsDevicesAllowUpdates;
allowed_to_leave?: TeamsDevicesAllowedToLeave;
auto_connect?: TeamsDevicesAutoConnect;
captive_portal?: TeamsDevicesCaptivePortal;
default?: TeamsDevicesDefault;
description?: TeamsDevicesSchemasDescription;
disable_auto_fallback?: TeamsDevicesDisableAutoFallback;
enabled?: boolean;
exclude?: TeamsDevicesExclude;
exclude_office_ips?: TeamsDevicesExcludeOfficeIps;
fallback_domains?: TeamsDevicesFallbackDomains;
gateway_unique_id?: TeamsDevicesGatewayUniqueId;
include?: TeamsDevicesInclude;
lan_allow_minutes?: TeamsDevicesLanAllowMinutes;
lan_allow_subnet_size?: TeamsDevicesLanAllowSubnetSize;
match?: TeamsDevicesSchemasMatch;
name?: string;
policy_id?: TeamsDevicesSchemasUuid;
precedence?: TeamsDevicesPrecedence;
register_interface_ip_with_dns?: TeamsDevicesRegisterInterfaceIpWithDns;
sccm_vpn_boundary_support?: TeamsDevicesSccmVpnBoundarySupport;
service_mode_v2?: TeamsDevicesServiceModeV2;
support_url?: TeamsDevicesSupportUrl;
switch_locked?: TeamsDevicesSwitchLocked;
target_tests?: TeamsDevicesTargetDexTest[];
tunnel_protocol?: TeamsDevicesTunnelProtocol;
}
; }

Client Errors

4XX application/json

Get device settings profile by ID response failure.

type TeamsDevicesDeviceSettingsResponse = type TeamsDevicesApiResponseSingle = never & { result?: TeamsDevicesDeviceSettingsPolicy
interface TeamsDevicesDeviceSettingsPolicy {
allow_mode_switch?: TeamsDevicesAllowModeSwitch;
allow_updates?: TeamsDevicesAllowUpdates;
allowed_to_leave?: TeamsDevicesAllowedToLeave;
auto_connect?: TeamsDevicesAutoConnect;
captive_portal?: TeamsDevicesCaptivePortal;
default?: TeamsDevicesDefault;
description?: TeamsDevicesSchemasDescription;
disable_auto_fallback?: TeamsDevicesDisableAutoFallback;
enabled?: boolean;
exclude?: TeamsDevicesExclude;
exclude_office_ips?: TeamsDevicesExcludeOfficeIps;
fallback_domains?: TeamsDevicesFallbackDomains;
gateway_unique_id?: TeamsDevicesGatewayUniqueId;
include?: TeamsDevicesInclude;
lan_allow_minutes?: TeamsDevicesLanAllowMinutes;
lan_allow_subnet_size?: TeamsDevicesLanAllowSubnetSize;
match?: TeamsDevicesSchemasMatch;
name?: string;
policy_id?: TeamsDevicesSchemasUuid;
precedence?: TeamsDevicesPrecedence;
register_interface_ip_with_dns?: TeamsDevicesRegisterInterfaceIpWithDns;
sccm_vpn_boundary_support?: TeamsDevicesSccmVpnBoundarySupport;
service_mode_v2?: TeamsDevicesServiceModeV2;
support_url?: TeamsDevicesSupportUrl;
switch_locked?: TeamsDevicesSwitchLocked;
target_tests?: TeamsDevicesTargetDexTest[];
tunnel_protocol?: TeamsDevicesTunnelProtocol;
}
; }
& interface TeamsDevicesApiResponseCommonFailure {
errors: TeamsDevicesMessages
type TeamsDevicesMessages = { code: number;message: string; }[]
;
messages: TeamsDevicesMessages
type TeamsDevicesMessages = { code: number;message: string; }[]
;
result: null;
success: false;
}