Prometheus API

Use these operations to interact with the Prometheus integration in Cortex.

Required permissions

Your API key must have the Configure integrations permission.

Operations

Retrieve configurations

get

Authorizations

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/prometheus/configurations' \
  --header 'Authorization: Bearer JWT'

200

400

429

200

{
  "configurations": [
    {
      "alias": "text",
      "host": "text",
      "isDefault": true,
      "lastFour": "text",
      "prometheusTenantId": "text",
      "username": "text"
    }
  ]
}

Successfully found configurations

Retrieve default configuration

get

Authorizations

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/prometheus/default-configuration' \
  --header 'Authorization: Bearer JWT'

200

400

429

200

{
  "alias": "text",
  "host": "text",
  "isDefault": true,
  "lastFour": "text",
  "prometheusTenantId": "text",
  "username": "text"
}

Successfully found default configuration

Retrieve a configuration

get

Authorizations

Path parameters

aliasstringrequired

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/prometheus/configuration/{alias}' \
  --header 'Authorization: Bearer JWT'

200

400

404

429

200

{
  "alias": "text",
  "host": "text",
  "isDefault": true,
  "lastFour": "text",
  "prometheusTenantId": "text",
  "username": "text"
}

Successfully found configuration

Add multiple configurations

post

Authorizations

Body

configurationsobject[]required

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/prometheus/configurations' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "configurations": [
      {
        "alias": "text",
        "host": "text",
        "isDefault": true,
        "password": "text",
        "prometheusTenantId": "text",
        "username": "text"
      }
    ]
  }'

200

403

429

200

{
  "configurations": [
    {
      "alias": "text",
      "host": "text",
      "isDefault": true,
      "lastFour": "text",
      "prometheusTenantId": "text",
      "username": "text"
    }
  ],
  "skippedConfigurations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Successfully added configurations

Add a single configuration

post

Authorizations

Body

aliasstringrequired

hoststringrequired

isDefaultbooleanrequired

passwordstringrequired

prometheusTenantIdstringoptional

usernamestringrequired

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/prometheus/configuration' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "alias": "text",
    "host": "text",
    "isDefault": true,
    "password": "text",
    "prometheusTenantId": "text",
    "username": "text"
  }'

200

400

403

429

200

{
  "configurations": [
    {
      "alias": "text",
      "host": "text",
      "isDefault": true,
      "lastFour": "text",
      "prometheusTenantId": "text",
      "username": "text"
    }
  ]
}

Successfully added configuration

Validate all configurations

post

Authorizations

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/prometheus/configuration/validate' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

{
  "configurations": [
    {
      "alias": "text",
      "isValid": true,
      "message": "text"
    }
  ]
}

Successfully validated all configurations

Validate a configuration

post

Authorizations

Path parameters

aliasstringrequired

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/prometheus/configuration/validate/{alias}' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

{
  "alias": "text",
  "isValid": true,
  "message": "text"
}

Successfully validated configuration

Update a configuration

put

WARNING: Updating aliases for configurations or changing the default configuration could cause entity YAMLs that use this integration to break.

Authorizations

Path parameters

aliasstringrequired

Body

aliasstringrequired

isDefaultbooleanrequired

Responses

application/json

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/prometheus/configuration/{alias}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "alias": "text",
    "isDefault": true
  }'

200

400

403

404

429

200

{
  "configurations": [
    {
      "alias": "text",
      "host": "text",
      "isDefault": true,
      "lastFour": "text",
      "prometheusTenantId": "text",
      "username": "text"
    }
  ]
}

Successfully updated configuration

Delete a configuration

delete

Authorizations

Path parameters

aliasstringrequired

Responses

application/json

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/prometheus/configuration/{alias}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

429

200

{
  "configurations": [
    {
      "alias": "text",
      "host": "text",
      "isDefault": true,
      "lastFour": "text",
      "prometheusTenantId": "text",
      "username": "text"
    }
  ]
}

Successfully deleted configuration

Delete all configurations

delete

Authorizations

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/prometheus/configurations' \
  --header 'Authorization: Bearer JWT'

200

400

403

429

200

No body

Successfully deleted all configurations