Project keys

The request lets you get a list of project keys.

Request format

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

GET /projects/<project_id>/services/<service_id>/keys
Host: api-developer.tech.yandex.net
X-Auth-Key: <your API key>
Resource

<project_id>

Project ID.

<service_id>

Service ID.

Request headers

Host

The URL of the node providing the API.

X-Auth-Key

Authorization key.

Response format

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:

{
    "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.

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.