API overview

The xrelia API allows you to send custom reliability data directly to xrelia. Using the API, you can submit metrics, synthetic request results, dependency health information, and deployment or configuration changes that contribute to your platform’s overall health and reliability analysis.

All API endpoints are versioned and currently use the v1 API.

Authentication

Before using the API, you must generate an API key from the xrelia console.

Each API key consists of two parts:

API key ID (for example: apk-5dfb88dc43fd53a2)
API key value (a secret value generated by xrelia)

Authentication is performed using the X-API-Key request header.

To generate the value for this header:

Concatenate the API key ID and API key value.
Generate a SHA256 hash of the resulting string.
Concatenate the API key ID without the apk- prefix and the generated hash.
Supply the result as the value of the X-API-Key header.

Example

API key ID:

apk-5dfb88dc43fd53a2

API key value:

9afsNDU1Zyt7KrK2OpCTrjaAHLJTUvMMBinq4tuFfrjiNVhUehHCGRd5CWpEI7Nd

Concatenated value:

apk-5dfb88dc43fd53a29afsNDU1Zyt7KrK2OpCTrjaAHLJTUvMMBinq4tuFfrjiNVhUehHCGRd5CWpEI7Nd

Header value:

5dfb88dc43fd53a2 + SHA256(concatenated value)

The final string should be supplied as the value of the X-API-Key header for every API request.

API endpoints

xrelia currently provides four ingestion endpoints.

Endpoint	Purpose
`/v1/metrics`	Submit custom metrics
`/v1/user-journey`	Submit synthetic request and user journey results
`/v1/dependencies`	Submit dependency health information
`/v1/changes`	Submit deployment and configuration changes

Base URLs:

https://api.xrelia.com/v1/metrics
https://api.xrelia.com/v1/user-journey
https://api.xrelia.com/v1/dependencies
https://api.xrelia.com/v1/changes

Detailed request and response specifications for each endpoint are available in the corresponding API reference pages.

Request format

All API requests use the following conventions:

HTTP method: POST
Content type: application/json
Request body: JSON object
Authentication: X-API-Key header

Every request must include:

platformId
instanceId

These identifiers can be obtained from the xrelia console and determine where incoming data is associated within your xrelia environment.

Example request

{
  "platformId": "PLATFORM_ID",
  "instanceId": "INSTANCE_ID",
  "samples": [
    {
      "id": "mtr-7e67f568763dacc1",
      "ts": 1785513412,
      "val": 58.17422866821289
    },
    {
      "id": "mtr-682a6ed20af12b4b",
      "ts": 1785513412,
      "val": 3.5928143716714303
    }
  ]
}

The exact payload structure varies depending on the endpoint being used.

Responses

xrelia uses standard HTTP status codes to indicate the outcome of a request.

Status	Meaning
`200 OK`	Request completed successfully
`207 Multi-Status`	Request partially succeeded and partially failed
`4xx`	Client-side error
`5xx`	Server-side error

When a request fails, xrelia returns a descriptive error message explaining the reason for the failure.

For partial success scenarios, xrelia returns an HTTP 207 Multi-Status response together with details describing which operations succeeded and which failed.

Next steps

Learn how to submit custom metrics
Send synthetic request and user journey results
Track dependency health
Record deployments and configuration changes

Each endpoint has its own dedicated reference page containing payload definitions, examples, validation rules, and response details.