Get an alert rule

GET

/v1/metric-alerts/{id}

const url = 'https://shareout.site/v1/metric-alerts/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://shareout.site/v1/metric-alerts/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

required

string

Responses

200

The rule

application/json

object

artifact_id

required

string

metric_id

required

string

name

required

string

condition

required

object

required

string

Allowed values: gt gte lt lte eq neq

value

required

number

schedule

required

5-field cron expression.

string

destination

required

object

kind

required

string

Allowed values: slack email discord webhook http_get telegram

config

required

Destination config matching the kind (see Jobs config interfaces).

object

message

string

cooldown_seconds

integer

string

enabled

boolean

created_at

integer

Example

{
  "condition": {
    "op": "gt"
  },
  "destination": {
    "kind": "slack"
  }
}

404

Resource not found

application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

Example

{
  "success": false
}