AWS X-Ray Traces API
Upload and retrieve trace data
AWS X-Ray Traces API is one of 9 APIs that AWS X-Ray publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Traces. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 1 JSON Schema.
This API exposes 3 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 2016-04-12.
Requests are made against a single base URL, https://xray.{region}.amazonaws.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
AWS X-Ray Traces API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (aws_sig_v4).
By default, every request must be authenticated.
aws_sig_v4— AWS Signature Version 4
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.
Upload and retrieve trace data
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are TraceSummary (13 properties), ServiceId (4 properties), Trace (4 properties), GetTraceSummariesResult (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from AWS X-Ray 8
Other APIs AWS X-Ray publishes across the network.