For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Home Guides API Reference

Home Guides API Reference

API Reference

API Reference errors.v1 ErrorQueryService

GetError

||View as Markdown|

Example request

1 {
2   "error_id": "example"
3 }

Example response

1 {
2   "error": {
3     "_component_id": {
4       "component_id": "example"
5     },
6     "error_id": "example",
7     "canonical_error": 0,
8     "summary": "example",
9     "cause_summary": "example",
10     "recommended_action": "example",
11     "severity": 0,
12     "first_seen_at": {
13       "seconds": 42,
14       "nanos": 42
15     },
16     "last_seen_at": {
17       "seconds": 42,
18       "nanos": 42
19     },
20     "closed_at": {
21       "seconds": 42,
22       "nanos": 42
23     },
24     "vendor_attributes": [
25       null
26     ],
27     "device_identifier": "example",
28     "impact": "example",
29     "component_type": 0
30   }
31 }

Get a single error by ID

GetErrorRequest

Request

This endpoint expects an object.

error_idstring

GetErrorResponse

Response

This endpoint returns an object.

errorobject

A single error instance