Get API key information

GET /_security/api_key

Retrieves information for one or more API keys. NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership.

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.

Query parameters

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_security/api_key?username=myuser&realm_name=native1

JavaScript Elasticsearch JavaScript Client

const response = await client.security.getApiKey({
  username: "myuser",
  realm_name: "native1",
});

Python Elasticsearch Python Client

resp = client.security.get_api_key(
    username="myuser",
    realm_name="native1",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_security/api_key?username=myuser&realm_name=native1" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.security().getApiKey(g -> g
    .realmName("native1")
    .username("myuser")
);

C# Elasticsearch .NET Client

var response = await client.Security
    .GetApiKeyAsync(d1 => d1
        .RealmName("native1")
        .Username("myuser")
    );

PHP Elasticsearch PHP Client

$resp = $client->security()->getApiKey([
    "username" => "myuser",
    "realm_name" => "native1",
]);

Ruby Elasticsearch Ruby Client

response = client.security.get_api_key(
  username: "myuser",
  realm_name: "native1"
)

Response

A successful response from GET /_security/api_key?id=VuaCfGcBCdbkQm-e5aOx&with_limited_by=true.

{
  "api_keys": [ 
    {
      "id": "VuaCfGcBCdbkQm-e5aOx", 
      "name": "my-api-key", 
      "creation": 1548550550158, 
      "expiration": 1548551550158, 
      "invalidated": false, 
      "username": "myuser", 
      "realm": "native1", 
      "realm_type": "native",
      "metadata": { 
        "application": "myapp"
      },
      "role_descriptors": { }, 
      "limited_by": [  
        {
          "role-power-user": {
            "cluster": [
              "monitor"
            ],
            "indices": [
              {
                "names": [
                  "*"
                ],
                "privileges": [
                  "read"
                ],
                "allow_restricted_indices": false
              }
            ],
            "applications": [ ],
            "run_as": [ ],
            "metadata": { },
            "transient_metadata": {
              "enabled": true
            }
          }
        }
      ]
    }
  ]
}