Get tags Technical preview

View as Markdown
POST /_project/tags

All methods and paths for this operation:

GET /_project/tags

POST /_project/tags

Get the tags that are defined for the project.

Required authorization

  • Cluster privileges: monitor

Query parameters

  • project_routing string Technical preview

    A Lucene query using project metadata tags used to filter which projects are returned in the response, such as _alias:_origin or _alias:pr.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • origin object Required
      Hide origin attribute Show origin attribute object
      • * object Additional properties
        Hide * attributes Show * attributes object
        • _id string Required
        • _alias string Required
        • _type string Required
        • _organisation string Required
    • linked_projects object
      Hide linked_projects attribute Show linked_projects attribute object
      • * object Additional properties
        Hide * attributes Show * attributes object
        • _id string Required
        • _alias string Required
        • _type string Required
        • _organisation string Required
POST /_project/tags
GET /_project/tags
resp = client.project.tags()
const response = await client.project.tags();
response = client.project.tags
$resp = $client->project()->tags();
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_project/tags"
client.project().tags();
Response examples (200)
A successful response from `GET /_project/tags`
{
  "origin": {
    "c56c4f8849c64cc6ae59c261f40bd195": {
      "_id": "c56c4f8849c64cc6ae59c261f40bd195"
      "_type": "elasticsearch",
      "_alias": "project-1",
      "_csp": "aws",
      "_region": "us-east-1"
      "mytag1": "foo",
      "mytag2": "bar"
    }
  },
  "linked_projects": {
    "a3b88ea3f195a336ae59c261f40bd195": {
      "_id": "a3b88ea3f195a336ae59c261f40bd195"
      "_type": "security",
      "_alias": "project-2",
      "_csp": "aws",
      "_region": "us-east-1"
      "mytag1": "foo",
      "mytag2": "bar"
    },
    "f40bd195389s3761023ca7aa8a3r0932": {
      "_id": "f40bd195389s3761023ca7aa8a3r0932"
      "_type": "observability",
      "_alias": "project-3",
      "_csp": "aws",
      "_region": "us-east-1"
      "mytag1": "foo",
      "mytag2": "bar"
    }
  }
}