Project parameters

The request lets you get the names and IDs of all the projects created by the Developer Dashboard user.

Request format

To view the parameters of all projects, use an HTTP request with the GET method:

GET /projects
Host: api-developer.tech.yandex.net
X-Auth-Key: <your API key>
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:

{
    "projects": [
        {
            "id": "68981a83-056f-4a61-9d67-873e4e13fd2f",
            "name": "Project #1"
        },
        ...
    ]
}

Response properties

Key

Value

projects

An array with information about projects.

Properties of the projects array

id

Project ID.

name

Project name.

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.