openapi: 3.0.0
info:
version: 2015-07-09
x-release: v4
title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Devices API
description:
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Devices paths: /accounts/{account_id}/devices: get: description: Fetches a list of enrolled devices. operationId: devices-list-devices parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_devices_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: List devices response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_devices_response' description: List devices response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform List devices tags: - Devices x-api-token-group: - Teams Read - Teams Write /accounts/{account_id}/devices/{device_id}: get: description: Fetches details for a single device. operationId: devices-device-details parameters: - in: path name: device_id required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_device_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Get device details response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_device_response' description: Get device details response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get device details tags: - Devices x-api-token-group: - Teams Read - Teams Write /accounts/{account_id}/devices/{device_id}/override_codes: get: description: Fetches a one-time use admin override code for a device. This relies on the **Admin Override** setting being enabled in your device configuration. operationId: devices-list-admin-override-code-for-device parameters: - in: path name: device_id required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_override_codes_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Get an admin override code for a device response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_override_codes_response' description: Get an admin override code for a device response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get an admin override code for a device tags: - Devices x-api-token-group: - Teams Read - Teams Write /accounts/{account_id}/devices/policies: get: description: Fetches a list of the device settings profiles for an account. operationId: devices-list-device-settings-policies parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_device_settings_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: List device settings profiles response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_device_settings_response_collection' description: List device settings profiles response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform List device settings profiles tags: - Devices x-api-token-group: - Teams Read - Teams Write /accounts/{account_id}/devices/policy: get: description: Fetches the default device settings profile for an account. operationId: devices-get-default-device-settings-policy parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_default_device_settings_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Get the default device settings profile response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_default_device_settings_response' description: Get the default device settings profile response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get the default device settings profile tags: - Devices x-api-token-group: - Teams Read - Teams Write patch: description: Updates the default device settings profile for an account. operationId: devices-update-default-device-settings-policy parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: content: application/json: schema: properties: allow_mode_switch: $ref: '#/components/schemas/teams-devices_allow_mode_switch' allow_updates: $ref: '#/components/schemas/teams-devices_allow_updates' allowed_to_leave: $ref: '#/components/schemas/teams-devices_allowed_to_leave' auto_connect: $ref: '#/components/schemas/teams-devices_auto_connect' captive_portal: $ref: '#/components/schemas/teams-devices_captive_portal' disable_auto_fallback: $ref: '#/components/schemas/teams-devices_disable_auto_fallback' exclude_office_ips: $ref: '#/components/schemas/teams-devices_exclude_office_ips' service_mode_v2: $ref: '#/components/schemas/teams-devices_service_mode_v2' support_url: $ref: '#/components/schemas/teams-devices_support_url' switch_locked: $ref: '#/components/schemas/teams-devices_switch_locked' tunnel_protocol: $ref: '#/components/schemas/teams-devices_tunnel_protocol' required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_default_device_settings_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Update the default device settings profile response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_default_device_settings_response' description: Update the default device settings profile response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Update the default device settings profile tags: - Devices x-api-token-group: - Teams Write post: description: Creates a device settings profile to be applied to certain devices matching the criteria. operationId: devices-create-device-settings-policy parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: content: application/json: schema: properties: allow_mode_switch: $ref: '#/components/schemas/teams-devices_allow_mode_switch' allow_updates: $ref: '#/components/schemas/teams-devices_allow_updates' allowed_to_leave: $ref: '#/components/schemas/teams-devices_allowed_to_leave' auto_connect: $ref: '#/components/schemas/teams-devices_auto_connect' captive_portal: $ref: '#/components/schemas/teams-devices_captive_portal' description: $ref: '#/components/schemas/teams-devices_schemas-description' disable_auto_fallback: $ref: '#/components/schemas/teams-devices_disable_auto_fallback' enabled: description: Whether the policy will be applied to matching devices. example: true type: boolean exclude_office_ips: $ref: '#/components/schemas/teams-devices_exclude_office_ips' lan_allow_minutes: $ref: '#/components/schemas/teams-devices_lan_allow_minutes' lan_allow_subnet_size: $ref: '#/components/schemas/teams-devices_lan_allow_subnet_size' match: $ref: '#/components/schemas/teams-devices_schemas-match' name: description: The name of the device settings profile. example: Allow Developers maxLength: 100 type: string precedence: $ref: '#/components/schemas/teams-devices_precedence' service_mode_v2: $ref: '#/components/schemas/teams-devices_service_mode_v2' support_url: $ref: '#/components/schemas/teams-devices_support_url' switch_locked: $ref: '#/components/schemas/teams-devices_switch_locked' tunnel_protocol: $ref: '#/components/schemas/teams-devices_tunnel_protocol' required: - name - precedence - match required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_device_settings_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Create a device settings profile response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_device_settings_response' description: Create a device settings profile response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Create a device settings profile tags: - Devices x-api-token-group: - Teams Write /accounts/{account_id}/devices/policy/{policy_id}: delete: description: Deletes a device settings profile and fetches a list of the remaining profiles for an account. operationId: devices-delete-device-settings-policy parameters: - in: path name: policy_id required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: content: application/json: {} required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_device_settings_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Delete a device settings profile response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_device_settings_response_collection' description: Delete a device settings profile response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Delete a device settings profile tags: - Devices get: description: Fetches a device settings profile by ID. operationId: devices-get-device-settings-policy-by-id parameters: - in: path name: policy_id required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_device_settings_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Get device settings profile by ID response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_device_settings_response' description: Get device settings profile by ID response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get device settings profile by ID tags: - Devices patch: description: Updates a configured device settings profile. operationId: devices-update-device-settings-policy parameters: - in: path name: policy_id required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: content: application/json: schema: properties: allow_mode_switch: $ref: '#/components/schemas/teams-devices_allow_mode_switch' allow_updates: $ref: '#/components/schemas/teams-devices_allow_updates' allowed_to_leave: $ref: '#/components/schemas/teams-devices_allowed_to_leave' auto_connect: $ref: '#/components/schemas/teams-devices_auto_connect' captive_portal: $ref: '#/components/schemas/teams-devices_captive_portal' description: $ref: '#/components/schemas/teams-devices_schemas-description' disable_auto_fallback: $ref: '#/components/schemas/teams-devices_disable_auto_fallback' enabled: description: Whether the policy will be applied to matching devices. example: true type: boolean exclude_office_ips: $ref: '#/components/schemas/teams-devices_exclude_office_ips' match: $ref: '#/components/schemas/teams-devices_schemas-match' name: description: The name of the device settings profile. example: Allow Developers maxLength: 100 type: string precedence: $ref: '#/components/schemas/teams-devices_precedence' service_mode_v2: $ref: '#/components/schemas/teams-devices_service_mode_v2' support_url: $ref: '#/components/schemas/teams-devices_support_url' switch_locked: $ref: '#/components/schemas/teams-devices_switch_locked' tunnel_protocol: $ref: '#/components/schemas/teams-devices_tunnel_protocol' required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_device_settings_response' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Update a device settings profile Policy response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_device_settings_response' description: Update a device settings profile Policy response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Update a device settings profile tags: - Devices /accounts/{account_id}/devices/policy/{policy_id}/exclude: get: description: Fetches the list of routes excluded from the WARP client's tunnel for a specific device settings profile. operationId: devices-get-split-tunnel-exclude-list-for-a-device-settings-policy parameters: - in: path name: policy_id required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Get the Split Tunnel exclude list for a device settings profile response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection' description: Get the Split Tunnel exclude list for a device settings profile response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get the Split Tunnel exclude list for a device settings profile tags: - Devices put: description: Sets the list of routes excluded from the WARP client's tunnel for a specific device settings profile. operationId: devices-set-split-tunnel-exclude-list-for-a-device-settings-policy parameters: - in: path name: policy_id required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: content: application/json: schema: items: $ref: '#/components/schemas/teams-devices_split_tunnel' type: array required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Set the Split Tunnel exclude list for a device settings profile response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection' description: Set the Split Tunnel exclude list for a device settings profile response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Set the Split Tunnel exclude list for a device settings profile tags: - Devices /accounts/{account_id}/devices/policy/{policy_id}/fallback_domains: get: description: Fetches the list of domains to bypass Gateway DNS resolution from a specified device settings profile. These domains will use the specified local DNS resolver instead. operationId: devices-get-local-domain-fallback-list-for-a-device-settings-policy parameters: - in: path name: policy_id required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Get the Local Domain Fallback list for a device settings profile response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection' description: Get the Local Domain Fallback list for a device settings profile response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get the Local Domain Fallback list for a device settings profile tags: - Devices put: description: Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead. This will only apply to the specified device settings profile. operationId: devices-set-local-domain-fallback-list-for-a-device-settings-policy parameters: - in: path name: policy_id required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: content: application/json: schema: items: $ref: '#/components/schemas/teams-devices_fallback_domain' type: array required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Set the Local Domain Fallback list for a device settings profile response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection' description: Set the Local Domain Fallback list for a device settings profile response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Set the Local Domain Fallback list for a device settings profile tags: - Devices /accounts/{account_id}/devices/policy/{policy_id}/include: get: description: Fetches the list of routes included in the WARP client's tunnel for a specific device settings profile. operationId: devices-get-split-tunnel-include-list-for-a-device-settings-policy parameters: - in: path name: policy_id required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Get the Split Tunnel include list for a device settings profile response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection' description: Get the Split Tunnel include list for a device settings profile response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get the Split Tunnel include list for a device settings profile tags: - Devices put: description: Sets the list of routes included in the WARP client's tunnel for a specific device settings profile. operationId: devices-set-split-tunnel-include-list-for-a-device-settings-policy parameters: - in: path name: policy_id required: true schema: $ref: '#/components/schemas/teams-devices_schemas-uuid' - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: content: application/json: schema: items: $ref: '#/components/schemas/teams-devices_split_tunnel_include' type: array required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Set the Split Tunnel include list for a device settings profile response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection' description: Set the Split Tunnel include list for a device settings profile response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Set the Split Tunnel include list for a device settings profile tags: - Devices /accounts/{account_id}/devices/policy/exclude: get: description: Fetches the list of routes excluded from the WARP client's tunnel. operationId: devices-get-split-tunnel-exclude-list parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Get the Split Tunnel exclude list response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection' description: Get the Split Tunnel exclude list response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get the Split Tunnel exclude list tags: - Devices put: description: Sets the list of routes excluded from the WARP client's tunnel. operationId: devices-set-split-tunnel-exclude-list parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: content: application/json: schema: items: $ref: '#/components/schemas/teams-devices_split_tunnel' type: array required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Set the Split Tunnel exclude list response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection' description: Set the Split Tunnel exclude list response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Set the Split Tunnel exclude list tags: - Devices /accounts/{account_id}/devices/policy/fallback_domains: get: description: Fetches a list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead. operationId: devices-get-local-domain-fallback-list parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Get your Local Domain Fallback list response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection' description: Get your Local Domain Fallback list response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get your Local Domain Fallback list tags: - Devices put: description: Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead. operationId: devices-set-local-domain-fallback-list parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: content: application/json: schema: items: $ref: '#/components/schemas/teams-devices_fallback_domain' type: array required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Set your Local Domain Fallback list response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection' description: Set your Local Domain Fallback list response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Set your Local Domain Fallback list tags: - Devices /accounts/{account_id}/devices/policy/include: get: description: Fetches the list of routes included in the WARP client's tunnel. operationId: devices-get-split-tunnel-include-list parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Get the Split Tunnel include list response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection' description: Get the Split Tunnel include list response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get the Split Tunnel include list tags: - Devices put: description: Sets the list of routes included in the WARP client's tunnel. operationId: devices-set-split-tunnel-include-list parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: content: application/json: schema: items: $ref: '#/components/schemas/teams-devices_split_tunnel_include' type: array required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Set the Split Tunnel include list response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection' description: Set the Split Tunnel include list response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Set the Split Tunnel include list tags: - Devices /accounts/{account_id}/devices/revoke: post: description: Revokes a list of devices. operationId: devices-revoke-devices parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/teams-devices_revoke_devices_request' required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_api-response-single' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Revoke devices response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_api-response-single' description: Revoke devices response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Revoke devices tags: - Devices x-api-token-group: - Teams Write /accounts/{account_id}/devices/unrevoke: post: description: Unrevokes a list of devices. operationId: devices-unrevoke-devices parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/teams-devices_identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/teams-devices_unrevoke_devices_request' required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/teams-devices_api-response-single' - $ref: '#/components/schemas/teams-devices_api-response-common-failure' description: Unrevoke devices response failure '200': content: application/json: schema: $ref: '#/components/schemas/teams-devices_api-response-single' description: Unrevoke devices response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Unrevoke devices tags: - Devices x-api-token-group: - Teams Write components: schemas: teams-devices_schemas-match: description: The wirefilter expression to match devices. example: user.identity == "test@cloudflare.com" maxLength: 500 type: string teams-devices_unrevoke_devices_request: description: A list of device ids to unrevoke. items: $ref: '#/components/schemas/teams-devices_schemas-uuid' maxLength: 200 type: array teams-devices_manufacturer: description: The device manufacturer name. example: My phone corp type: string teams-devices_result_info: properties: count: description: Total number of results for the requested service example: 1 type: number page: description: Current page within paginated list of results example: 1 type: number per_page: description: Number of results per page of results example: 20 type: number total_count: description: Total results available without any search parameters example: 2000 type: number type: object teams-devices_mac_address: description: The device mac address. example: 00-00-5E-00-53-00 type: string teams-devices_fallback_domains: items: $ref: '#/components/schemas/teams-devices_fallback_domain' type: array teams-devices_model: description: The device model name. example: MyPhone(pro-X) type: string teams-devices_api-response-common-failure: properties: errors: allOf: - $ref: '#/components/schemas/teams-devices_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/teams-devices_messages' example: [] result: enum: - null nullable: true type: object success: description: Whether the API call was successful enum: - false example: false type: boolean required: - success - errors - messages - result type: object teams-devices_default: description: Whether the policy is the default policy for an account. example: false type: boolean teams-devices_schemas-description: description: A description of the policy. example: Policy for test teams. maxLength: 500 type: string teams-devices_exclude_office_ips: description: Whether to add Microsoft IPs to Split Tunnel exclusions. example: true type: boolean teams-devices_allow_mode_switch: description: Whether to allow the user to switch WARP between modes. example: true type: boolean teams-devices_serial_number: description: The device serial number. example: EXAMPLEHMD6R type: string teams-devices_split_tunnel_include_response_collection: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection' - properties: result: items: $ref: '#/components/schemas/teams-devices_split_tunnel_include' type: array teams-devices_precedence: description: The precedence of the policy. Lower values indicate higher precedence. Policies will be evaluated in ascending order of this field. example: 100 type: number teams-devices_auto_connect: description: The amount of time in minutes to reconnect after having been disabled. example: 0 type: number teams-devices_captive_portal: description: Turn on the captive portal after the specified amount of time. example: 180 type: number teams-devices_override_codes_response: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection' - properties: result: properties: disable_for_time: $ref: '#/components/schemas/teams-devices_disable_for_time' type: object teams-devices_revoked_at: description: When the device was revoked. example: '2017-06-14T00:00:00Z' format: date-time type: string teams-devices_email: description: The contact email address of the user. example: user@example.com maxLength: 90 type: string teams-devices_split_tunnel_response_collection: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection' - properties: result: items: $ref: '#/components/schemas/teams-devices_split_tunnel' type: array teams-devices_disable_for_time: properties: '1': description: Override code that is valid for 1 hour. example: '9106681' '3': description: Override code that is valid for 3 hours. example: '5356247' '6': description: Override code that is valid for 6 hours. example: '9478972' '12': description: Override code that is valid for 12 hour2. example: '3424359' '24': description: Override code that is valid for 24 hour.2. example: '2887634' type: object teams-devices_switch_locked: description: Whether to allow the user to turn off the WARP switch and disconnect the client. example: true type: boolean teams-devices_updated: description: When the device was updated. example: '2017-06-14T00:00:00Z' format: date-time type: string teams-devices_fallback_domain_response_collection: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection' - properties: result: items: $ref: '#/components/schemas/teams-devices_fallback_domain' type: array teams-devices_ip: description: IPv4 or IPv6 address. example: 1.1.1.1 type: string teams-devices_api-response-common: properties: errors: $ref: '#/components/schemas/teams-devices_messages' messages: $ref: '#/components/schemas/teams-devices_messages' result: anyOf: - type: object - items: {} type: array - type: string success: description: Whether the API call was successful. enum: - true example: true type: boolean required: - success - errors - messages - result type: object teams-devices_split_tunnel: properties: address: description: The address in CIDR format to exclude from the tunnel. If `address` is present, `host` must not be present. example: 192.0.2.0/24 type: string description: description: A description of the Split Tunnel item, displayed in the client UI. example: Exclude testing domains from the tunnel maxLength: 100 type: string host: description: The domain name to exclude from the tunnel. If `host` is present, `address` must not be present. example: '*.example.com' type: string required: - address - description type: object teams-devices_api-response-collection: allOf: - $ref: '#/components/schemas/teams-devices_api-response-common' - properties: result: items: {} nullable: true type: array result_info: $ref: '#/components/schemas/teams-devices_result_info' type: object teams-devices_default_device_settings_policy: properties: allow_mode_switch: $ref: '#/components/schemas/teams-devices_allow_mode_switch' allow_updates: $ref: '#/components/schemas/teams-devices_allow_updates' allowed_to_leave: $ref: '#/components/schemas/teams-devices_allowed_to_leave' auto_connect: $ref: '#/components/schemas/teams-devices_auto_connect' captive_portal: $ref: '#/components/schemas/teams-devices_captive_portal' default: description: Whether the policy will be applied to matching devices. example: true type: boolean disable_auto_fallback: $ref: '#/components/schemas/teams-devices_disable_auto_fallback' enabled: description: Whether the policy will be applied to matching devices. example: true type: boolean exclude: $ref: '#/components/schemas/teams-devices_exclude' exclude_office_ips: $ref: '#/components/schemas/teams-devices_exclude_office_ips' fallback_domains: $ref: '#/components/schemas/teams-devices_fallback_domains' gateway_unique_id: $ref: '#/components/schemas/teams-devices_gateway_unique_id' include: $ref: '#/components/schemas/teams-devices_include' service_mode_v2: $ref: '#/components/schemas/teams-devices_service_mode_v2' support_url: $ref: '#/components/schemas/teams-devices_support_url' switch_locked: $ref: '#/components/schemas/teams-devices_switch_locked' tunnel_protocol: $ref: '#/components/schemas/teams-devices_tunnel_protocol' type: object teams-devices_lan_allow_minutes: description: 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 laptop waking from sleep. Note that this field is omitted from the response if null or unset. example: 30 type: number teams-devices_os_distro_revision: description: The Linux distro revision. example: 1.0.0 type: string teams-devices_deleted: description: True if the device was deleted. example: true type: boolean teams-devices_last_seen: description: When the device last connected to Cloudflare services. example: '2017-06-14T00:00:00Z' format: date-time type: string teams-devices_identifier: example: 699d98642c564d2e855e9661899b7252 teams-devices_os_version_extra: description: The operating system version extra parameter. example: (a) type: string teams-devices_created: description: When the device was created. example: '2017-06-14T00:00:00Z' format: date-time type: string teams-devices_device_settings_response: allOf: - $ref: '#/components/schemas/teams-devices_api-response-single' - properties: result: $ref: '#/components/schemas/teams-devices_device_settings_policy' teams-devices_schemas-name: description: The device name. example: My mobile device type: string teams-devices_devices: properties: created: $ref: '#/components/schemas/teams-devices_created' deleted: $ref: '#/components/schemas/teams-devices_deleted' device_type: $ref: '#/components/schemas/teams-devices_platform' id: $ref: '#/components/schemas/teams-devices_schemas-uuid' ip: $ref: '#/components/schemas/teams-devices_ip' key: $ref: '#/components/schemas/teams-devices_key' last_seen: $ref: '#/components/schemas/teams-devices_last_seen' mac_address: $ref: '#/components/schemas/teams-devices_mac_address' manufacturer: $ref: '#/components/schemas/teams-devices_manufacturer' model: $ref: '#/components/schemas/teams-devices_model' name: $ref: '#/components/schemas/teams-devices_schemas-name' os_distro_name: $ref: '#/components/schemas/teams-devices_os_distro_name' os_distro_revision: $ref: '#/components/schemas/teams-devices_os_distro_revision' os_version: $ref: '#/components/schemas/teams-devices_os_version' os_version_extra: $ref: '#/components/schemas/teams-devices_os_version_extra' revoked_at: $ref: '#/components/schemas/teams-devices_revoked_at' serial_number: $ref: '#/components/schemas/teams-devices_serial_number' updated: $ref: '#/components/schemas/teams-devices_updated' user: $ref: '#/components/schemas/teams-devices_user' version: $ref: '#/components/schemas/teams-devices_version' type: object teams-devices_components-schemas-uuid: description: UUID example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 maxLength: 36 readOnly: true type: string teams-devices_version: description: The WARP client version. example: 1.0.0 type: string teams-devices_gateway_unique_id: example: 699d98642c564d2e855e9661899b7252 type: string teams-devices_platform: enum: - windows - mac - linux - android - ios example: windows type: string teams-devices_devices_response: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection' - properties: result: items: $ref: '#/components/schemas/teams-devices_devices' type: array teams-devices_key: description: The device's public key. example: yek0SUYoOQ10vMGsIYAevozXUQpQtNFJFfFGqER/BGc= type: string teams-devices_schemas-uuid: description: Device ID. example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 maxLength: 36 type: string teams-devices_exclude: items: $ref: '#/components/schemas/teams-devices_split_tunnel' type: array teams-devices_fallback_domain: properties: description: description: A description of the fallback domain, displayed in the client UI. example: Domain bypass for local development maxLength: 100 type: string dns_server: description: A list of IP addresses to handle domain resolution. items: $ref: '#/components/schemas/teams-devices_ip' type: array suffix: description: The domain suffix to match when resolving locally. example: example.com type: string required: - suffix type: object teams-devices_revoke_devices_request: description: A list of device ids to revoke. items: $ref: '#/components/schemas/teams-devices_schemas-uuid' maxLength: 200 type: array teams-devices_device_settings_policy: properties: allow_mode_switch: $ref: '#/components/schemas/teams-devices_allow_mode_switch' allow_updates: $ref: '#/components/schemas/teams-devices_allow_updates' allowed_to_leave: $ref: '#/components/schemas/teams-devices_allowed_to_leave' auto_connect: $ref: '#/components/schemas/teams-devices_auto_connect' captive_portal: $ref: '#/components/schemas/teams-devices_captive_portal' default: $ref: '#/components/schemas/teams-devices_default' description: $ref: '#/components/schemas/teams-devices_schemas-description' disable_auto_fallback: $ref: '#/components/schemas/teams-devices_disable_auto_fallback' enabled: description: Whether the policy will be applied to matching devices. example: true type: boolean exclude: $ref: '#/components/schemas/teams-devices_exclude' exclude_office_ips: $ref: '#/components/schemas/teams-devices_exclude_office_ips' fallback_domains: $ref: '#/components/schemas/teams-devices_fallback_domains' gateway_unique_id: $ref: '#/components/schemas/teams-devices_gateway_unique_id' include: $ref: '#/components/schemas/teams-devices_include' lan_allow_minutes: $ref: '#/components/schemas/teams-devices_lan_allow_minutes' lan_allow_subnet_size: $ref: '#/components/schemas/teams-devices_lan_allow_subnet_size' match: $ref: '#/components/schemas/teams-devices_schemas-match' name: description: The name of the device settings profile. example: Allow Developers maxLength: 100 type: string policy_id: $ref: '#/components/schemas/teams-devices_schemas-uuid' precedence: $ref: '#/components/schemas/teams-devices_precedence' service_mode_v2: $ref: '#/components/schemas/teams-devices_service_mode_v2' support_url: $ref: '#/components/schemas/teams-devices_support_url' switch_locked: $ref: '#/components/schemas/teams-devices_switch_locked' target_tests: items: $ref: '#/components/schemas/teams-devices_target_dex_test' type: array tunnel_protocol: $ref: '#/components/schemas/teams-devices_tunnel_protocol' type: object teams-devices_disable_auto_fallback: description: If the `dns_server` 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 option is set to `true`. example: true type: boolean teams-devices_split_tunnel_include: properties: address: description: The address in CIDR format to include in the tunnel. If address is present, host must not be present. example: 192.0.2.0/24 type: string description: description: A description of the split tunnel item, displayed in the client UI. example: Include testing domains from the tunnel maxLength: 100 type: string host: description: The domain name to include in the tunnel. If host is present, address must not be present. example: '*.example.com' type: string required: - address - description type: object teams-devices_api-response-single: allOf: - $ref: '#/components/schemas/teams-devices_api-response-common' - properties: result: anyOf: - type: object - type: string nullable: true type: object type: object teams-devices_tunnel_protocol: description: Determines which tunnel protocol to use. example: wireguard type: string teams-devices_device_response: allOf: - $ref: '#/components/schemas/teams-devices_api-response-single' - properties: result: type: object teams-devices_default_device_settings_response: allOf: - $ref: '#/components/schemas/teams-devices_api-response-single' - properties: result: $ref: '#/components/schemas/teams-devices_default_device_settings_policy' teams-devices_os_distro_name: description: The Linux distro name. example: ubuntu type: string teams-devices_service_mode_v2: properties: mode: description: The mode to run the WARP client under. example: proxy type: string port: description: The port number when used with proxy mode. example: 3000 type: number type: object teams-devices_target_dex_test: properties: id: description: The id of the DEX test targeting this policy type: string name: description: The name of the DEX test targeting this policy type: string type: object teams-devices_support_url: description: The URL to launch when the Send Feedback button is clicked. example: https://1.1.1.1/help type: string teams-devices_allowed_to_leave: description: Whether to allow devices to leave the organization. example: true type: boolean teams-devices_allow_updates: description: Whether to receive update notifications when a new version of the client is available. example: true type: boolean teams-devices_os_version: description: The operating system version. example: 10.0.0 type: string teams-devices_user: properties: email: $ref: '#/components/schemas/teams-devices_email' id: $ref: '#/components/schemas/teams-devices_components-schemas-uuid' name: description: The enrolled device user's name. example: John Appleseed type: string type: object teams-devices_include: items: $ref: '#/components/schemas/teams-devices_split_tunnel_include' type: array teams-devices_messages: example: [] items: properties: code: minimum: 1000 type: integer message: type: string required: - code - message type: object uniqueItems: true type: array teams-devices_lan_allow_subnet_size: description: The size of the subnet for the local access network. Note that this field is omitted from the response if null or unset. example: 24 type: number teams-devices_device_settings_response_collection: allOf: - $ref: '#/components/schemas/teams-devices_api-response-collection' - properties: result: items: $ref: '#/components/schemas/teams-devices_device_settings_policy' type: array securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true