How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Devices API

The Devices API from APIs.io Engineering Platform — 14 operation(s) for devices.

APIs.io Engineering Platform Devices API is one of 471 APIs that APIs.io Engineering Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Devices. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 24 operations across 14 paths, and defines 69 schemas. It is described by OpenAPI 3.2.0, at version 4.0.0.

Requests are made against the base URL https://{bucketname}.s3.amazonaws.com.

24 operations 14 paths 69 schemas 1 DELETE12 GET2 PATCH3 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key, API Key, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 4

APIs.io Engineering Platform Devices API declares 4 security schemes for authenticating requests. An API key is passed in the header as X-Auth-Email (api_email). An API key is passed in the header as X-Auth-Key (api_key). It accepts HTTP bearer tokens (api_token). An API key is passed in the header as X-Auth-User-Service-Key (user_service_key).

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
devices-list-devices 1 param → 4XX200
GET
/accounts/{account_id}/devices/{device_id}
APIs.io Engineering Platform Get device details
devices-device-details 2 params → 4XX200
GET
/accounts/{account_id}/devices/{device_id}/override_codes
APIs.io Engineering Platform Get an admin override code for a device
devices-list-admin-override-code-for-device 2 params → 4XX200
GET
/accounts/{account_id}/devices/policies
APIs.io Engineering Platform List device settings profiles
devices-list-device-settings-policies 1 param → 4XX200
GET
/accounts/{account_id}/devices/policy
APIs.io Engineering Platform Get the default device settings profile
devices-get-default-device-settings-policy 1 param → 4XX200
PATCH
/accounts/{account_id}/devices/policy
APIs.io Engineering Platform Update the default device settings profile
devices-update-default-device-settings-policy 1 param body → 4XX200
POST
/accounts/{account_id}/devices/policy
APIs.io Engineering Platform Create a device settings profile
devices-create-device-settings-policy 1 param body → 4XX200
DELETE
/accounts/{account_id}/devices/policy/{policy_id}
APIs.io Engineering Platform Delete a device settings profile
devices-delete-device-settings-policy 2 params body → 4XX200
GET
/accounts/{account_id}/devices/policy/{policy_id}
APIs.io Engineering Platform Get device settings profile by ID
devices-get-device-settings-policy-by-id 2 params → 4XX200
PATCH
/accounts/{account_id}/devices/policy/{policy_id}
APIs.io Engineering Platform Update a device settings profile
devices-update-device-settings-policy 2 params body → 4XX200
GET
/accounts/{account_id}/devices/policy/{policy_id}/exclude
APIs.io Engineering Platform Get the Split Tunnel exclude list for a device settings profile
devices-get-split-tunnel-exclude-list-for-a-device-settings-policy 2 params → 4XX200
PUT
/accounts/{account_id}/devices/policy/{policy_id}/exclude
APIs.io Engineering Platform Set the Split Tunnel exclude list for a device settings profile
devices-set-split-tunnel-exclude-list-for-a-device-settings-policy 2 params body → 4XX200
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
devices-get-local-domain-fallback-list-for-a-device-settings-policy 2 params → 4XX200
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
devices-set-local-domain-fallback-list-for-a-device-settings-policy 2 params body → 4XX200
GET
/accounts/{account_id}/devices/policy/{policy_id}/include
APIs.io Engineering Platform Get the Split Tunnel include list for a device settings profile
devices-get-split-tunnel-include-list-for-a-device-settings-policy 2 params → 4XX200
PUT
/accounts/{account_id}/devices/policy/{policy_id}/include
APIs.io Engineering Platform Set the Split Tunnel include list for a device settings profile
devices-set-split-tunnel-include-list-for-a-device-settings-policy 2 params body → 4XX200
GET
/accounts/{account_id}/devices/policy/exclude
APIs.io Engineering Platform Get the Split Tunnel exclude list
devices-get-split-tunnel-exclude-list 1 param → 4XX200
PUT
/accounts/{account_id}/devices/policy/exclude
APIs.io Engineering Platform Set the Split Tunnel exclude list
devices-set-split-tunnel-exclude-list 1 param body → 4XX200
GET
/accounts/{account_id}/devices/policy/fallback_domains
APIs.io Engineering Platform Get your Local Domain Fallback list
devices-get-local-domain-fallback-list 1 param → 4XX200
PUT
/accounts/{account_id}/devices/policy/fallback_domains
APIs.io Engineering Platform Set your Local Domain Fallback list
devices-set-local-domain-fallback-list 1 param body → 4XX200
GET
/accounts/{account_id}/devices/policy/include
APIs.io Engineering Platform Get the Split Tunnel include list
devices-get-split-tunnel-include-list 1 param → 4XX200
PUT
/accounts/{account_id}/devices/policy/include
APIs.io Engineering Platform Set the Split Tunnel include list
devices-set-split-tunnel-include-list 1 param body → 4XX200
POST
/accounts/{account_id}/devices/revoke
APIs.io Engineering Platform Revoke devices
devices-revoke-devices 1 param body → 4XX200
POST
/accounts/{account_id}/devices/unrevoke
APIs.io Engineering Platform Unrevoke devices
devices-unrevoke-devices 1 param body → 4XX200

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_identifier
teams-devices_schemas-uuid
string
Device ID.
teams-devices_messages
array
teams-devices_updated
string
When the device was updated.
teams-devices_allowed_to_leave
boolean
Whether to allow devices to leave the organization.
teams-devices_support_url
string
The URL to launch when the Send Feedback button is clicked.
teams-devices_schemas-match
string
The wirefilter expression to match devices.
teams-devices_api-response-common
object
4 properties 4 required
teams-devices_components-schemas-uuid
string
UUID
teams-devices_version
string
The WARP client version.
teams-devices_override_codes_response
teams-devices_revoke_devices_request
array
A list of device ids to revoke.
teams-devices_captive_portal
number
Turn on the captive portal after the specified amount of time.
teams-devices_disable_for_time
object
5 properties
teams-devices_target_dex_test
object
2 properties
teams-devices_device_settings_response_collection
teams-devices_allow_updates
boolean
Whether to receive update notifications when a new version of the client is available.
teams-devices_split_tunnel_include_response_collection
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_model
string
The device model name.
teams-devices_platform
string
teams-devices_exclude_office_ips
boolean
Whether to add Microsoft IPs to Split Tunnel exclusions.
teams-devices_switch_locked
boolean
Whether to allow the user to turn off the WARP switch and disconnect the client.
teams-devices_fallback_domain_response_collection
teams-devices_manufacturer
string
The device manufacturer name.
teams-devices_include
array
teams-devices_serial_number
string
The device serial number.
teams-devices_fallback_domains
array
teams-devices_fallback_domain
object
3 properties 1 required
teams-devices_key
string
The device's public key.
teams-devices_exclude
array
teams-devices_device_settings_policy
object
25 properties
teams-devices_last_seen
string
When the device last connected to Cloudflare services.
teams-devices_mac_address
string
The device mac address.
teams-devices_split_tunnel_include
object
3 properties 2 required
teams-devices_device_settings_response
teams-devices_tunnel_protocol
string
Determines which tunnel protocol to use.
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_deleted
boolean
True if the device was deleted.
teams-devices_unrevoke_devices_request
array
A list of device ids to unrevoke.
teams-devices_device_response
teams-devices_result_info
object
4 properties
teams-devices_revoked_at
string
When the device was revoked.
teams-devices_default_device_settings_response
teams-devices_devices
object
20 properties
teams-devices_user
object
3 properties
teams-devices_api-response-single
object
teams-devices_devices_response
teams-devices_schemas-description
string
A description of the policy.
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_os_distro_revision
string
The Linux distro revision.
teams-devices_default_device_settings_policy
object
17 properties
teams-devices_api-response-collection
object
teams-devices_gateway_unique_id
string
teams-devices_schemas-name
string
The device name.
teams-devices_os_version_extra
string
The operating system version extra parameter.
teams-devices_split_tunnel_response_collection
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_service_mode_v2
object
2 properties
teams-devices_api-response-common-failure
object
4 properties 4 required
teams-devices_ip
string
IPv4 or IPv6 address.
teams-devices_default
boolean
Whether the policy is the default policy for an account.
teams-devices_email
string
The contact email address of the user.
teams-devices_created
string
When the device was created.
teams-devices_allow_mode_switch
boolean
Whether to allow the user to switch WARP between modes.
teams-devices_auto_connect
number
The amount of time in minutes to reconnect after having been disabled.
teams-devices_os_distro_name
string
The Linux distro name.
teams-devices_os_version
string
The operating system version.
teams-devices_split_tunnel
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-devices-api-openapi.yml Raw ↑

Other APIs APIs.io Engineering Platform publishes across the network.

EasyCron
APIs.io Engineering Platform 2014 11 13 API
APIs.io Engineering Platform 2015 03 31 API
APIs.io Engineering Platform 2016 08 19 API
APIs.io Engineering Platform 2017 03 31 API
APIs.io Engineering Platform 2017 10 31 API
APIs.io Engineering Platform 2018 10 31 API
APIs.io Engineering Platform 2019 09 25 API
APIs.io Engineering Platform 2019 09 30 API
APIs.io Engineering Platform 2020 04 22 API
APIs.io Engineering Platform 2020 06 30 API
Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform Devices API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.