Save an Observability query

POST/api/companies/{companyId}/observability/saved-queries
Personal API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Save an Observability query.

Authorization

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.

Request body

application/json · required

namestringRequired1–120 characters
sectionstringRequiredone of: "logs", "errors", "connectors"
querystringRequiredat most 4000 characters
descriptionstring | nullOptionalat most 500 characters
visibilitystringOptionalone of: "shared", "private"
pinnedbooleanOptional
alertEnabledbooleanOptional

Responses

201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Observability