Skip to content

List your collectors

What you can call today

Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.

GET
/v1/collectors
curl --request GET \  --url https://api.xovris.ai/v1/collectors \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
latestRelease
required
One of:
string
collectors
required
Array<object>
object
instanceUid
required
string
name
required
One of:
string
host
required
One of:
string
version
required
object
outdated
required
One of:
boolean
behind
required
One of:
number
words
required
string
connected
required
boolean
stale
required
One of:
object
since
required
string
seconds
required
number
lastSeenAt
required
string
health
required
string
config
required
object
hash
required
One of:
string
valid
required
One of:
boolean
problems
required
Array<string>
pipelines
required
Array<string>
remote
required
object
status
required
One of:
string
hash
required
One of:
string
error
required
One of:
string
owed
required
Array<object>
object
hash
required
string
assignedAt
required
string
sentAt
required
One of:
string
refused
required
One of:
string
throughputPerSecond
required
One of:
object
logs
required
One of:
number
spans
required
One of:
number
metricPoints
required
One of:
number
knownGood
required
One of:
object
hash
required
string
at
required
One of:
string
breaks
required
Array<object>
object
openedAt
required
string
kind
required
string
signals
required
Array<string>
lines
required
lost
required
number
status
required
string
repairedAt
required
One of:
string
outdated
required
number
protocol
required
string

Example

{  "latestRelease": "string",  "collectors": [    {      "instanceUid": "string",      "name": "string",      "host": "string",      "version": {        "outdated": true,        "behind": 1,        "words": "string"      },      "connected": true,      "stale": {        "since": "string",        "seconds": 1      },      "lastSeenAt": "string",      "health": "string",      "config": {        "hash": "string",        "valid": true,        "problems": [          "string"        ],        "pipelines": [          "string"        ]      },      "remote": {        "status": "string",        "hash": "string",        "error": "string",        "owed": [          {            "hash": "string",            "assignedAt": "string",            "sentAt": "string",            "refused": "string"          }        ]      },      "throughputPerSecond": {        "logs": 1,        "spans": 1,        "metricPoints": 1      },      "knownGood": {        "hash": "string",        "at": "string"      },      "breaks": [        {          "openedAt": "string",          "kind": "string",          "signals": [            "string"          ],          "lines": null,          "lost": 1,          "status": "string",          "repairedAt": "string"        }      ]    }  ],  "outdated": 1,  "protocol": "string"}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Signed in, but this token or role may not do this. The answer names the permission it needs.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Nothing with that id here, or it belongs to another workspace. Nothing was changed.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

Your data is never used to train our AI. How your data is kept

A problem is called fixed only once it works again. How each fix is checked

XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.