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 Groups API

Manage trace groups

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

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

5 operations 5 paths 3 schemas 5 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 Groups 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 5

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

Groups 5

Manage trace groups

POST
/Groups
AWS X-Ray Create a Group
CreateGroup body → 200
POST
/GetGroups
AWS X-Ray Get All Active Groups
GetGroups body → 200
POST
/Group
AWS X-Ray Get a Group
GetGroup body → 200
POST
/UpdateGroup
AWS X-Ray Update a Group
UpdateGroup body → 200
POST
/DeleteGroup
AWS X-Ray Delete a Group
DeleteGroup body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Group (4 properties), GroupSummary (4 properties), Tag (2 properties). Each schema is shown below with its type and property counts.

GroupSummary
object
4 properties
Group
object
4 properties
Tag
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs AWS X-Ray publishes across the network.

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