/metric-alerts (POST)

POST

/metric-alerts

curl --request POST \
  --url https://example.com/api/v1/metric-alerts \
  --header 'Content-Type: application/json' \
  --data '{ "scope": "server", "targetId": "example", "metric": "cpu", "thresholdPct": 1, "windowSeconds": 1 }'

Request Body ^required

Media type application/json

object

scope

required

Any of:

string

string

Allowed values: server

string

string

Allowed values: app

targetId

required

string

>= 1 characters <= 64 characters

metric

required

Any of:

string

string

Allowed values: cpu

string

string

Allowed values: mem

thresholdPct

required

number

>= 1 <= 100

windowSeconds

integer

>= 60 <= 86400

Responses

201

Default Response

Media type application/json

object

id

required

string

scope

required

Any of:

string

string

Allowed values: server

string

string

Allowed values: app

targetId

required

string

metric

required

string

thresholdPct

required

number

windowSeconds

required

integer

enabled

required

boolean

lastFiredAt

required

Any of:

string

string format: date-time

null

null

createdAt

required

string format: date-time

Example

{
  "scope": "server"
}

400

Default Response

Media type application/json

object

type

required

string

title

required

string

status

required

integer

code

required

string

detail

string

instance

string

errors

Array<object>

object

path

required

string

message

required

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}