POST

/CreateGroup

http://xray.{region}.amazonaws.com/CreateGroup

Creates a group resource with a name and a filter expression.

Access Token Required: API Key

Body Params

Tagsarray

A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the Amazon Web Services General Reference. The following restrictions apply to tags: <ul> <li> Maximum number of user-applied tags per resource: 50 </li> <li> Maximum tag key length: 128 Unicode characters </li> <li> Maximum tag value length: 256 Unicode characters </li> <li> Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @ </li> <li> Tag keys and values are case sensitive. </li> <li> Don't use <code>aws:</code> as a prefix for keys; it's reserved for Amazon Web Services use. </li> </ul>

GroupNamestringrequired

The case-sensitive name of the new group. Default is a reserved name and names must be unique.

FilterExpressionstring

The filter expression defining criteria by which to group traces.

InsightsConfigurationobject

The structure containing configurations related to insights.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://xray.{region}.amazonaws.com/CreateGroup' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}