APIs.io Engineering Platform Devices API
The Devices API from APIs.io Engineering Platform — 14 operation(s) for devices.
This API exposes 24 operations across 14 paths, and defines 69 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
24 operations
14 paths
69 schemas
1 DELETE12 GET2 PATCH3 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
APIs.io Engineering Platform Devices API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 24
Across 14 paths, the API surfaces 24 operations — 1 DELETE, 12 GET, 2 PATCH, 3 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.
Devices 24
GET
/accounts/{account_id}/devices
APIs.io Engineering Platform List devices
GET
/accounts/{account_id}/devices/{device_id}
APIs.io Engineering Platform Get device details
GET
/accounts/{account_id}/devices/{device_id}/override_codes
APIs.io Engineering Platform Get an admin override code for a device
GET
/accounts/{account_id}/devices/policies
APIs.io Engineering Platform List device settings profiles
GET
/accounts/{account_id}/devices/policy
APIs.io Engineering Platform Get the default device settings profile
PATCH
/accounts/{account_id}/devices/policy
APIs.io Engineering Platform Update the default device settings profile
POST
/accounts/{account_id}/devices/policy
APIs.io Engineering Platform Create a device settings profile
DELETE
/accounts/{account_id}/devices/policy/{policy_id}
APIs.io Engineering Platform Delete a device settings profile
GET
/accounts/{account_id}/devices/policy/{policy_id}
APIs.io Engineering Platform Get device settings profile by ID
PATCH
/accounts/{account_id}/devices/policy/{policy_id}
APIs.io Engineering Platform Update a device settings profile
GET
/accounts/{account_id}/devices/policy/{policy_id}/exclude
APIs.io Engineering Platform Get the Split Tunnel exclude list for a device settings profile
PUT
/accounts/{account_id}/devices/policy/{policy_id}/exclude
APIs.io Engineering Platform Set the Split Tunnel exclude list for a device settings profile
GET
/accounts/{account_id}/devices/policy/{policy_id}/fallback_domains
APIs.io Engineering Platform Get the Local Domain Fallback list for a device settings profile
PUT
/accounts/{account_id}/devices/policy/{policy_id}/fallback_domains
APIs.io Engineering Platform Set the Local Domain Fallback list for a device settings profile
GET
/accounts/{account_id}/devices/policy/{policy_id}/include
APIs.io Engineering Platform Get the Split Tunnel include list for a device settings profile
PUT
/accounts/{account_id}/devices/policy/{policy_id}/include
APIs.io Engineering Platform Set the Split Tunnel include list for a device settings profile
GET
/accounts/{account_id}/devices/policy/exclude
APIs.io Engineering Platform Get the Split Tunnel exclude list
PUT
/accounts/{account_id}/devices/policy/exclude
APIs.io Engineering Platform Set the Split Tunnel exclude list
GET
/accounts/{account_id}/devices/policy/fallback_domains
APIs.io Engineering Platform Get your Local Domain Fallback list
PUT
/accounts/{account_id}/devices/policy/fallback_domains
APIs.io Engineering Platform Set your Local Domain Fallback list
GET
/accounts/{account_id}/devices/policy/include
APIs.io Engineering Platform Get the Split Tunnel include list
PUT
/accounts/{account_id}/devices/policy/include
APIs.io Engineering Platform Set the Split Tunnel include list
POST
/accounts/{account_id}/devices/revoke
APIs.io Engineering Platform Revoke devices
POST
/accounts/{account_id}/devices/unrevoke
APIs.io Engineering Platform Unrevoke devices
Schemas 69
The contract defines 69 schemas that model the data the API accepts and returns. The most detailed are teams-devices_device_settings_policy (25 properties), teams-devices_devices (20 properties), teams-devices_default_device_settings_policy (17 properties), teams-devices_disable_for_time (5 properties). Each schema is shown below with its type and property counts.
teams-devices_schemas-match
string
The wirefilter expression to match devices.
teams-devices_unrevoke_devices_request
array
A list of device ids to unrevoke.
teams-devices_manufacturer
string
The device manufacturer name.
teams-devices_result_info
object
4 properties
teams-devices_mac_address
string
The device mac address.
teams-devices_fallback_domains
array
teams-devices_model
string
The device model name.
teams-devices_api-response-common-failure
object
4 properties
4 required
teams-devices_default
boolean
Whether the policy is the default policy for an account.
teams-devices_schemas-description
string
A description of the policy.
teams-devices_exclude_office_ips
boolean
Whether to add Microsoft IPs to Split Tunnel exclusions.
teams-devices_allow_mode_switch
boolean
Whether to allow the user to switch WARP between modes.
teams-devices_serial_number
string
The device serial number.
teams-devices_split_tunnel_include_response_collection
teams-devices_precedence
number
The precedence of the policy. Lower values indicate higher precedence. Policies will be evaluated in ascending order of this field.
teams-devices_auto_connect
number
The amount of time in minutes to reconnect after having been disabled.
teams-devices_captive_portal
number
Turn on the captive portal after the specified amount of time.
teams-devices_override_codes_response
teams-devices_revoked_at
string
When the device was revoked.
teams-devices_email
string
The contact email address of the user.
teams-devices_split_tunnel_response_collection
teams-devices_disable_for_time
object
5 properties
teams-devices_switch_locked
boolean
Whether to allow the user to turn off the WARP switch and disconnect the client.
teams-devices_updated
string
When the device was updated.
teams-devices_fallback_domain_response_collection
teams-devices_ip
string
IPv4 or IPv6 address.
teams-devices_api-response-common
object
4 properties
4 required
teams-devices_split_tunnel
object
3 properties
2 required
teams-devices_api-response-collection
object
teams-devices_default_device_settings_policy
object
17 properties
teams-devices_lan_allow_minutes
number
The amount of time in minutes a user is allowed access to their LAN. A value of 0 will allow LAN access until the next WARP reconnection, such as a reboot or a…
teams-devices_os_distro_revision
string
The Linux distro revision.
teams-devices_deleted
boolean
True if the device was deleted.
teams-devices_last_seen
string
When the device last connected to Cloudflare services.
teams-devices_identifier
teams-devices_os_version_extra
string
The operating system version extra parameter.
teams-devices_created
string
When the device was created.
teams-devices_device_settings_response
teams-devices_schemas-name
string
The device name.
teams-devices_devices
object
20 properties
teams-devices_components-schemas-uuid
string
UUID
teams-devices_version
string
The WARP client version.
teams-devices_gateway_unique_id
string
teams-devices_platform
string
teams-devices_devices_response
teams-devices_key
string
The device's public key.
teams-devices_schemas-uuid
string
Device ID.
teams-devices_exclude
array
teams-devices_fallback_domain
object
3 properties
1 required
teams-devices_revoke_devices_request
array
A list of device ids to revoke.
teams-devices_device_settings_policy
object
25 properties
teams-devices_disable_auto_fallback
boolean
If the dnsserver field of a fallback domain is not present, the client will fall back to a best guess of the default/system DNS resolvers unless this policy op…
teams-devices_split_tunnel_include
object
3 properties
2 required
teams-devices_api-response-single
object
teams-devices_tunnel_protocol
string
Determines which tunnel protocol to use.
teams-devices_device_response
teams-devices_default_device_settings_response
teams-devices_os_distro_name
string
The Linux distro name.
teams-devices_service_mode_v2
object
2 properties
teams-devices_target_dex_test
object
2 properties
teams-devices_support_url
string
The URL to launch when the Send Feedback button is clicked.
teams-devices_allowed_to_leave
boolean
Whether to allow devices to leave the organization.
teams-devices_allow_updates
boolean
Whether to receive update notifications when a new version of the client is available.
teams-devices_os_version
string
The operating system version.
teams-devices_user
object
3 properties
teams-devices_include
array
teams-devices_messages
array
teams-devices_lan_allow_subnet_size
number
The size of the subnet for the local access network. Note that this field is omitted from the response if null or unset.
teams-devices_device_settings_response_collection
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Devices