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

AWS X-Ray Encryption API

Manage encryption configuration

AWS X-Ray Encryption 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 Encryption. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 1 JSON Schema.

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

2 operations 2 paths 1 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2016-04-12
Base URL
https://xray.{region}.amazonaws.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

AWS X-Ray Encryption 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 2

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

Encryption 2

Manage encryption configuration

POST
/EncryptionConfig
AWS X-Ray Get Encryption Configuration
GetEncryptionConfig → 200
POST
/PutEncryptionConfig
AWS X-Ray Update Encryption Configuration
PutEncryptionConfig body → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is EncryptionConfig (3 properties). Each schema is shown below with its type and property counts.

EncryptionConfig
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-x-ray-encryption-api-openapi.yml Raw ↑

Other APIs AWS X-Ray publishes across the network.

AWS X-Ray Groups API
AWS X-Ray Insights API
AWS X-Ray Sampling API
AWS X-Ray Service Graph API
AWS X-Ray TagResource API
AWS X-Ray Tags API
AWS X-Ray Traces API
AWS X-Ray UntagResource API