For the complete documentation index, see llms.txt. This page is also available as Markdown.

Telemetry Sources

List the telemetry sources of the account.

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Query parameters
start-indexintegerOptional

index of the first item to return

Default: 0
max-resultsintegerOptional

maximum number of items to return

Default: 100
querystringOptional

Free-text search on the name of the telemetry source.

labelsstringOptional

Filter by labels using a condition expression. Supports the operators ==, !=, in and not_in, combined with and (up to 20 conditions). Values must be url-encoded. An invalid expression returns 400. Examples: environment == 'production', region in ["us-east", "us-west"], environment == 'production' and severity != 'low'.

Responses
200

the list of telemetry sources

application/json
idinteger · int64Read-onlyOptional
namestringRequired
descriptionstringOptional
typestring · enumRequired

The telemetry protocol of this source. Required on create and immutable afterwards.

Possible values:
statusstring · enumRead-onlyOptional

Whether ilert is currently receiving telemetry from this source.

Possible values:
integrationKeystringRead-onlyOptional

The credential used to send telemetry to ilert. Server-managed and read-only: it is omitted from list responses, and from the detail response for users without update permission on the telemetry source.

serviceNamePrefixstring · max: 64Optional

Prepended to the name of every service that ilert creates from the telemetry of this source, for example to keep the services of a staging environment apart from production. Leading and trailing whitespace is removed, no separator is inserted. Services that already exist are not renamed.

serviceNameSuffixstring · max: 64Optional

Appended to the name of every service that ilert creates from the telemetry of this source. Leading and trailing whitespace is removed, no separator is inserted. If prefix, service name and suffix together exceed the 255 character service name limit, the service name is shortened so that both affixes are kept in full.

createdAtstring · date-timeRead-onlyOptional
updatedAtstring · date-timeRead-onlyOptional
get/telemetry-sources
GET /api/telemetry-sources HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

the list of telemetry sources

[
  {
    "id": 1,
    "name": "text",
    "description": "text",
    "type": "OTEL",
    "status": "PENDING",
    "integrationKey": "text",
    "serviceNamePrefix": "text",
    "serviceNameSuffix": "text",
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "teams": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "managedBy": {
      "type": "API",
      "source": "text"
    },
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  }
]

Create a new telemetry source.

post
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Query parameters
Body
idinteger · int64Read-onlyOptional
namestringRequired
descriptionstringOptional
typestring · enumRequired

The telemetry protocol of this source. Required on create and immutable afterwards.

Possible values:
statusstring · enumRead-onlyOptional

Whether ilert is currently receiving telemetry from this source.

Possible values:
integrationKeystringRead-onlyOptional

The credential used to send telemetry to ilert. Server-managed and read-only: it is omitted from list responses, and from the detail response for users without update permission on the telemetry source.

serviceNamePrefixstring · max: 64Optional

Prepended to the name of every service that ilert creates from the telemetry of this source, for example to keep the services of a staging environment apart from production. Leading and trailing whitespace is removed, no separator is inserted. Services that already exist are not renamed.

serviceNameSuffixstring · max: 64Optional

Appended to the name of every service that ilert creates from the telemetry of this source. Leading and trailing whitespace is removed, no separator is inserted. If prefix, service name and suffix together exceed the 255 character service name limit, the service name is shortened so that both affixes are kept in full.

createdAtstring · date-timeRead-onlyOptional
updatedAtstring · date-timeRead-onlyOptional
Responses
201

the created telemetry source

application/json
idinteger · int64Read-onlyOptional
namestringRequired
descriptionstringOptional
typestring · enumRequired

The telemetry protocol of this source. Required on create and immutable afterwards.

Possible values:
statusstring · enumRead-onlyOptional

Whether ilert is currently receiving telemetry from this source.

Possible values:
integrationKeystringRead-onlyOptional

The credential used to send telemetry to ilert. Server-managed and read-only: it is omitted from list responses, and from the detail response for users without update permission on the telemetry source.

serviceNamePrefixstring · max: 64Optional

Prepended to the name of every service that ilert creates from the telemetry of this source, for example to keep the services of a staging environment apart from production. Leading and trailing whitespace is removed, no separator is inserted. Services that already exist are not renamed.

serviceNameSuffixstring · max: 64Optional

Appended to the name of every service that ilert creates from the telemetry of this source. Leading and trailing whitespace is removed, no separator is inserted. If prefix, service name and suffix together exceed the 255 character service name limit, the service name is shortened so that both affixes are kept in full.

createdAtstring · date-timeRead-onlyOptional
updatedAtstring · date-timeRead-onlyOptional
post/telemetry-sources
POST /api/telemetry-sources HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "name": "text",
  "description": "text",
  "type": "OTEL",
  "serviceNamePrefix": "text",
  "serviceNameSuffix": "text",
  "labels": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ]
}
201

the created telemetry source

{
  "id": 1,
  "name": "text",
  "description": "text",
  "type": "OTEL",
  "status": "PENDING",
  "integrationKey": "text",
  "serviceNamePrefix": "text",
  "serviceNameSuffix": "text",
  "labels": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "managedBy": {
    "type": "API",
    "source": "text"
  },
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Get the telemetry source with the specified name.

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
namestringRequired

unique name of the telemetry source

Query parameters
Responses
200

the telemetry source object

application/json
idinteger · int64Read-onlyOptional
namestringRequired
descriptionstringOptional
typestring · enumRequired

The telemetry protocol of this source. Required on create and immutable afterwards.

Possible values:
statusstring · enumRead-onlyOptional

Whether ilert is currently receiving telemetry from this source.

Possible values:
integrationKeystringRead-onlyOptional

The credential used to send telemetry to ilert. Server-managed and read-only: it is omitted from list responses, and from the detail response for users without update permission on the telemetry source.

serviceNamePrefixstring · max: 64Optional

Prepended to the name of every service that ilert creates from the telemetry of this source, for example to keep the services of a staging environment apart from production. Leading and trailing whitespace is removed, no separator is inserted. Services that already exist are not renamed.

serviceNameSuffixstring · max: 64Optional

Appended to the name of every service that ilert creates from the telemetry of this source. Leading and trailing whitespace is removed, no separator is inserted. If prefix, service name and suffix together exceed the 255 character service name limit, the service name is shortened so that both affixes are kept in full.

createdAtstring · date-timeRead-onlyOptional
updatedAtstring · date-timeRead-onlyOptional
get/telemetry-sources/name/{name}
GET /api/telemetry-sources/name/{name} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

the telemetry source object

{
  "id": 1,
  "name": "text",
  "description": "text",
  "type": "OTEL",
  "status": "PENDING",
  "integrationKey": "text",
  "serviceNamePrefix": "text",
  "serviceNameSuffix": "text",
  "labels": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "managedBy": {
    "type": "API",
    "source": "text"
  },
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Get the telemetry source with the specified id.

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
idinteger · int64Required

the id of the telemetry source

Query parameters
Responses
200

the telemetry source object

application/json
idinteger · int64Read-onlyOptional
namestringRequired
descriptionstringOptional
typestring · enumRequired

The telemetry protocol of this source. Required on create and immutable afterwards.

Possible values:
statusstring · enumRead-onlyOptional

Whether ilert is currently receiving telemetry from this source.

Possible values:
integrationKeystringRead-onlyOptional

The credential used to send telemetry to ilert. Server-managed and read-only: it is omitted from list responses, and from the detail response for users without update permission on the telemetry source.

serviceNamePrefixstring · max: 64Optional

Prepended to the name of every service that ilert creates from the telemetry of this source, for example to keep the services of a staging environment apart from production. Leading and trailing whitespace is removed, no separator is inserted. Services that already exist are not renamed.

serviceNameSuffixstring · max: 64Optional

Appended to the name of every service that ilert creates from the telemetry of this source. Leading and trailing whitespace is removed, no separator is inserted. If prefix, service name and suffix together exceed the 255 character service name limit, the service name is shortened so that both affixes are kept in full.

createdAtstring · date-timeRead-onlyOptional
updatedAtstring · date-timeRead-onlyOptional
get/telemetry-sources/{id}
GET /api/telemetry-sources/{id} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

the telemetry source object

{
  "id": 1,
  "name": "text",
  "description": "text",
  "type": "OTEL",
  "status": "PENDING",
  "integrationKey": "text",
  "serviceNamePrefix": "text",
  "serviceNameSuffix": "text",
  "labels": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "managedBy": {
    "type": "API",
    "source": "text"
  },
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Update the telemetry source with the specified id.

put
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
idinteger · int64Required

the id of the telemetry source

Query parameters
Body
idinteger · int64Read-onlyOptional
namestringRequired
descriptionstringOptional
typestring · enumRequired

The telemetry protocol of this source. Required on create and immutable afterwards.

Possible values:
statusstring · enumRead-onlyOptional

Whether ilert is currently receiving telemetry from this source.

Possible values:
integrationKeystringRead-onlyOptional

The credential used to send telemetry to ilert. Server-managed and read-only: it is omitted from list responses, and from the detail response for users without update permission on the telemetry source.

serviceNamePrefixstring · max: 64Optional

Prepended to the name of every service that ilert creates from the telemetry of this source, for example to keep the services of a staging environment apart from production. Leading and trailing whitespace is removed, no separator is inserted. Services that already exist are not renamed.

serviceNameSuffixstring · max: 64Optional

Appended to the name of every service that ilert creates from the telemetry of this source. Leading and trailing whitespace is removed, no separator is inserted. If prefix, service name and suffix together exceed the 255 character service name limit, the service name is shortened so that both affixes are kept in full.

createdAtstring · date-timeRead-onlyOptional
updatedAtstring · date-timeRead-onlyOptional
Responses
200

the updated telemetry source

application/json
idinteger · int64Read-onlyOptional
namestringRequired
descriptionstringOptional
typestring · enumRequired

The telemetry protocol of this source. Required on create and immutable afterwards.

Possible values:
statusstring · enumRead-onlyOptional

Whether ilert is currently receiving telemetry from this source.

Possible values:
integrationKeystringRead-onlyOptional

The credential used to send telemetry to ilert. Server-managed and read-only: it is omitted from list responses, and from the detail response for users without update permission on the telemetry source.

serviceNamePrefixstring · max: 64Optional

Prepended to the name of every service that ilert creates from the telemetry of this source, for example to keep the services of a staging environment apart from production. Leading and trailing whitespace is removed, no separator is inserted. Services that already exist are not renamed.

serviceNameSuffixstring · max: 64Optional

Appended to the name of every service that ilert creates from the telemetry of this source. Leading and trailing whitespace is removed, no separator is inserted. If prefix, service name and suffix together exceed the 255 character service name limit, the service name is shortened so that both affixes are kept in full.

createdAtstring · date-timeRead-onlyOptional
updatedAtstring · date-timeRead-onlyOptional
put/telemetry-sources/{id}
PUT /api/telemetry-sources/{id} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "name": "text",
  "description": "text",
  "type": "OTEL",
  "serviceNamePrefix": "text",
  "serviceNameSuffix": "text",
  "labels": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ]
}
200

the updated telemetry source

{
  "id": 1,
  "name": "text",
  "description": "text",
  "type": "OTEL",
  "status": "PENDING",
  "integrationKey": "text",
  "serviceNamePrefix": "text",
  "serviceNameSuffix": "text",
  "labels": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "managedBy": {
    "type": "API",
    "source": "text"
  },
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Delete the telemetry source with the specified id.

delete
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
idinteger · int64Required

the id of the telemetry source

Responses
204

Empty body delete response

delete/telemetry-sources/{id}
DELETE /api/telemetry-sources/{id} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
204

Empty body delete response

No content

Rotate the integration key of a telemetry source.

put

Invalidates the current integration key and issues a new one. Requires update permission. Fetch the telemetry source afterwards to read the new key.

Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
idinteger · int64Required

the id of the telemetry source

Responses
204

Empty body response

put/telemetry-sources/{id}/rotate-integration-key
PUT /api/telemetry-sources/{id}/rotate-integration-key HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
204

Empty body response

No content

Get ingestion statistics of a telemetry source.

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
idinteger · int64Required

the id of the telemetry source

Responses
200

the telemetry source statistics

application/json
lastTraceAtstring · date-timeRead-onlyOptional

When the most recent telemetry was received from this source.

get/telemetry-sources/{id}/stats
GET /api/telemetry-sources/{id}/stats HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

the telemetry source statistics

{
  "lastTraceAt": "2026-01-01T00:00:00.000Z"
}

List the distinct label keys used by the telemetry sources of this account.

get

Fixed page size of 100. start-index must be 0 or a multiple of 100 and max-results must be 100; any other value returns 400.

Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Query parameters
querystringOptional

Filter the returned label keys by prefix.

start-indexintegerOptional

must be 0 or a multiple of 100

Default: 0
max-resultsintegerOptional

must be 100

Default: 100
Responses
200

the list of distinct label keys

application/json
keystringOptional
get/telemetry-sources/labels
GET /api/telemetry-sources/labels HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

the list of distinct label keys

[
  {
    "key": "text"
  }
]

List the distinct values used for a label key by the telemetry sources of this account.

get

Fixed page size of 100. start-index must be 0 or a multiple of 100 and max-results must be 100; any other value returns 400.

Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
keystringRequired

the label key

Query parameters
querystringOptional

Filter the returned label values by prefix.

start-indexintegerOptional

must be 0 or a multiple of 100

Default: 0
max-resultsintegerOptional

must be 100

Default: 100
Responses
200

the list of distinct label values

application/json
valuestringOptional
get/telemetry-sources/labels/{key}/values
GET /api/telemetry-sources/labels/{key}/values HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

the list of distinct label values

[
  {
    "value": "text"
  }
]

Last updated

Was this helpful?