Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Device DEX Tests API

The Device DEX Tests API from APIs.io Engineering Platform — 2 operation(s) for device dex tests.

This API exposes 5 operations across 2 paths, and defines 17 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.

5 operations 2 paths 17 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Device DEX Tests 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 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Device DEX Tests 5
GET
/accounts/{account_id}/devices/dex_tests
APIs.io Engineering Platform List Device DEX tests
device-dex-test-details 1 param → 4XX200
POST
/accounts/{account_id}/devices/dex_tests
APIs.io Engineering Platform Create Device DEX test
device-dex-test-create-device-dex-test 1 param body → 4XX200
DELETE
/accounts/{account_id}/devices/dex_tests/{dex_test_id}
APIs.io Engineering Platform Delete Device DEX test
device-dex-test-delete-device-dex-test 2 params → 4XX200
GET
/accounts/{account_id}/devices/dex_tests/{dex_test_id}
APIs.io Engineering Platform Get Device DEX test
device-dex-test-get-device-dex-test 2 params → 4XX200
PUT
/accounts/{account_id}/devices/dex_tests/{dex_test_id}
APIs.io Engineering Platform Update Device DEX test
device-dex-test-update-device-dex-test 2 params body → 4XX200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are teams-devices_device-dex-test-schemas-http (7 properties), teams-devices_api-response-common (4 properties), teams-devices_api-response-common-failure (4 properties), teams-devices_dex_target_policy (3 properties). Each schema is shown below with its type and property counts.

teams-devices_dex_target_policy
object
3 properties
teams-devices_device-dex-test-schemas-interval
string
How often the test will run.
teams-devices_device-dex-test-schemas-description
string
Additional details about the test.
teams-devices_dex-single_response
teams-devices_device-dex-test-target-policies
array
Device settings profiles targeted by this test
teams-devices_api-response-single
object
teams-devices_device-dex-test-schemas-enabled
boolean
Determines whether or not the test is active.
teams-devices_device-dex-test-schemas-data
object
The configuration object which contains the details for the WARP client to conduct the test.
3 properties
teams-devices_identifier
teams-devices_api-response-common-failure
object
4 properties 4 required
teams-devices_uuid
string
API UUID.
teams-devices_device-dex-test-schemas-http
object
7 properties 4 required
teams-devices_device-dex-test-schemas-name
string
The name of the DEX test. Must be unique.
teams-devices_api-response-common
object
4 properties 4 required
teams-devices_api-response-collection-common
object
teams-devices_messages
array
teams-devices_dex-response_collection

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-device-dex-tests-api-openapi.yml Raw ↑