Create or update project routing expressions

PUT /_project_routing

Required authorization

Authentication

Authorization: <value>

Elasticsearch APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

For more information about where to find API keys for the Elasticsearch endpoint (${ES_URL}) for a project, go to Get started with Elasticsearch Serverless.

Request body

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

PUT /_project_routing/
{
 "aws-us-only": { "expression": "_csp:aws AND _region:us*" },
 "aws-eu-only": { "expression": "_csp:aws AND _region:eu*" }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.project.createManyRouting({
  expressions: {
    "aws-us-only": {
      expression: "_csp:aws AND _region:us*",
    },
    "aws-eu-only": {
      expression: "_csp:aws AND _region:eu*",
    },
  },
});

Python Elasticsearch Python Client

resp = client.perform_request(
    "PUT",
    "/_project_routing",
    headers={"Content-Type": "application/json"},
    body={
        "aws-us-only": {
            "expression": "_csp:aws AND _region:us*"
        },
        "aws-eu-only": {
            "expression": "_csp:aws AND _region:eu*"
        }
    },
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_project_routing/" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "aws-us-only": {
      "expression": "_csp:aws AND _region:us*"
    },
    "aws-eu-only": {
      "expression": "_csp:aws AND _region:eu*"
    }
  }'

Java Elasticsearch Java Client

client.project().createManyRouting(c -> c
    .expressions(Map.of("aws-eu-only", ProjectRoutingExpression.of(p -> p
            .expression("_csp:aws AND _region:eu*")
        ),"aws-us-only", ProjectRoutingExpression.of(p -> p
            .expression("_csp:aws AND _region:us*")
        )))
);

C# Elasticsearch .NET Client

var response = await client.Project
    .CreateManyRoutingAsync(d1 => d1
        .Expressions(d2 => d2
            .Add("aws-us-only", d3 => d3
                .Expression("_csp:aws AND _region:us*")
            )
            .Add("aws-eu-only", d3 => d3
                .Expression("_csp:aws AND _region:eu*")
            )
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->project()->createManyRouting([
    "body" => [
        "aws-us-only" => [
            "expression" => "_csp:aws AND _region:us*",
        ],
        "aws-eu-only" => [
            "expression" => "_csp:aws AND _region:eu*",
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.project.create_many_routing(
  body: {
    "aws-us-only": {
      "expression": "_csp:aws AND _region:us*"
    },
    "aws-eu-only": {
      "expression": "_csp:aws AND _region:eu*"
    }
  }
)

Response

{
  "acknowledged": true
}

Required authorization

Authentication

Request body { }

Response

Request body