Create or update a project routing expression

PUT /_project_routing/{name}

Auth

Required privileges

Cluster privileges manage_project_routing manage

Path parameters

name string required: The name of project routing expression

Request body

expression string required

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

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

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

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

Java Elasticsearch Java Client

client.project().createRouting(c -> c
    .name("aws-us-only")
    .expressions(e -> e
        .expression("_csp:aws AND _region:us*")
    )
);

C# Elasticsearch .NET Client

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

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

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

Response

{
  "acknowledged": true
}

Required privileges

Path parameters

Request body { }

Response

Request body