List projects
Returns the projects the API key covers: the key's own project for a project key, the covered projects of the organization for an organization key. Use their IDs in the `X-Vemetric-Project` header.
This endpoint lists the projects your API key has access to. For a project API key, that’s its own project. For an organization API key, it’s either all projects of the organization or the projects chosen when the key was created.
Use the returned id in the X-Vemetric-Project header to send requests for a project with an organization API key. This endpoint itself doesn’t need the header.
Project or organization API key (starts with vem_), created in the project or organization settings on the API tab. Organization keys name the project of each request in the X-Vemetric-Project header.
Example: Bearer vem_xxxxxxxxxxxx
Responses
200 Success
application/json
projects
Description
Projects the API key covers, sorted by name. id
Example
"1234567890123456"
domain
Description
Project domain
400 Bad request - invalid request payload or parameters, or an organization key without the X-Vemetric-Project header
application/json
error
Description
Error details. code
Description
Machine-readable error code. HTTP_ERROR is returned for a malformed JSON body, PROJECT_REQUIRED for an organization key without the X-Vemetric-Project header. Type
"VALIDATION_ERROR" | "HTTP_ERROR" | "PROJECT_REQUIRED"
message
Description
Human-readable error message.
details
Description
Per-field validation issues. Only present for VALIDATION_ERROR.
Show nested properties (2)
field
Description
Path to the invalid request field.
message
Description
Validation error message for the field.
401 Unauthorized - missing, malformed, invalid or revoked API key
application/json
error
Description
Error details. code
Description
Machine-readable error code.
message
Description
Human-readable error message.
429 Rate limit exceeded - retry after the number of seconds in the Retry-After header
application/json
error
Description
Error details. code
Description
Machine-readable error code. Type
"RATE_LIMIT_EXCEEDED"
message
Description
Human-readable error message.
500 Unexpected internal error
application/json
error
Description
Error details. code
Description
Machine-readable error code.
message
Description
Human-readable error message.