---
metadata:
  - name: generator
    content: Diplodoc Platform v5.48.2
alternate:
  - https://yandex.com/dev/developer-help/doc/en/api/get-keys.md
  - https://yandex.com/dev/developer-help/doc/ru/api/get-keys.md
  - https://yandex.com/dev/developer-help/doc/tr/api/get-keys.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/developer-help/doc/en/llms.txt

# Project keys

The request lets you get a list of project keys.

## Request format {#request-format}

To view a list of project keys, use an HTTP request with the `GET` method:

```text
GET /projects/[<project_id>](*popap_2)/services/[<service_id>](*popap_3)/keys
[Host](*popap): api-developer.tech.yandex.net
[X-Auth-Key](*popap_1): <your API key>
```

{% cut "Resource" %}

**<project_id>**

Project ID.

**<service_id>**

Service ID.

{% endcut %}

{% cut "Request headers" %}

**Host**

The URL of the node providing the API.

**X-Auth-Key**

[Authorization](https://yandex.com/dev/developer-help/doc/en/api/auth.md) key.

{% endcut %}

## Response format {#response-format}

{% list tabs %}

- The request has been completed successfully

  If the request has been completed successfully, the API returns a response with the code 200. The response body contains an object in JSON format:
  
  ```json
  {
      "keys": [
          {
              "id": "5559f750a005af74319bb72d",
              "name": "Key #1"
          },
          ...
      ]
  }
  ```
  
  #### Response properties

  #|
  || **Key** | **Value** ||
  || `keys` | An array with information about keys. ||
  || The properties of the `keys` array ||
  || `id` | ID of the key to be used in other API requests. ||
  || `name` | The name of the key specified by the user. ||
  |#

- The request has been executed with an error

  If the request has failed, the response message contains information about errors:

  #|
  || **HTTP error code** | **Error description** ||
  || `400 Bad Request` | One of the request parameters has an invalid value or data format. ||
  || `403 Forbidden` | The user or app does not have rights to access the resource; the request is rejected. ||
  || `404 Not Found` | The requested resource is not found. ||
  || `500 Internal Server Error` | Internal service error. Try resending your request later. ||
  || `503 Service Unavailable` | The API service is temporarily unavailable. ||
  |#

{% endlist %}

[*popap]:
 
The URL of the node providing the API.

[*popap_1]:
 
Authorization key.

[*popap_2]:
 
Project ID.

[*popap_3]:
 
Service ID.