Alerts

List customer-visible alert episodes and containments

GET

https://api.signals.pressone.africa/v1

/alerts

List customer-visible alert episodes and containments › query Parameters

range

string · enum

Enum values:

24h

30d

90d

trunk_id

string

One trk_ trunk id; leave it out for every trunk.

List customer-visible alert episodes and containments › Headers

X-Project-ID

string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

List customer-visible alert episodes and containments › Responses

Alerts and containments visible to the caller's role.

AlertFeed

Containment[] · required

Alert[] · required

GET/alerts

curl https://api.signals.pressone.africa/v1/alerts \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "containments": [
    {
      "case_ref": "case_ref",
      "expires_at": "2024-08-25T15:00:00Z",
      "id": "00000000-0000-0000-0000-000000000000",
      "notified_at": "2024-08-25T15:00:00Z",
      "notified_event": "notified_event",
      "prefix": "prefix",
      "reason_category": "spend_velocity",
      "reason_detail": "reason_detail",
      "rejection_code": "DESTINATION_CONTAINED",
      "rejection_count": 0,
      "release_request": {
        "decision_at": "2024-08-25T15:00:00Z",
        "decision_by": "decision_by",
        "decision_reason": "decision_reason",
        "id": "00000000-0000-0000-0000-000000000000",
        "note": "note",
        "requested_at": "2024-08-25T15:00:00Z",
        "requested_by": "requested_by",
        "state": "pending"
      },
      "released_at": "2024-08-25T15:00:00Z",
      "released_by": "released_by",
      "source_alert_id": "source_alert_id",
      "starts_at": "2024-08-25T15:00:00Z",
      "trunk_id": "trunk_id",
      "trunk_name": "trunk_name"
    }
  ],
  "data": [
    {
      "acknowledged_at": "2024-08-25T15:00:00Z",
      "acknowledged_by": "acknowledged_by",
      "channels": [
        "email"
      ],
      "containment_id": "00000000-0000-0000-0000-000000000000",
      "dedupe_key": "dedupe_key",
      "evidence": [
        {
          "amount_minor": 0,
          "currency": "currency",
          "held": true,
          "label": "label",
          "note": "note",
          "text": "text"
        }
      ],
      "fired_at": "2024-08-25T15:00:00Z",
      "id": "id",
      "kind": "balance_low",
      "policy_id": "policy_id",
      "policy_revision": 0,
      "reason": "reason",
      "remediation": "remediation",
      "resolved_at": "2024-08-25T15:00:00Z",
      "severity": "critical",
      "source_state": "measured",
      "state": "firing",
      "subject": {
        "id": "id",
        "name": "name",
        "type": "account"
      },
      "suggested_action": {
        "href": "href",
        "label": "label"
      },
      "trunk_id": "trunk_id"
    }
  ]
}

json

application/json

List alert policies visible to the caller's role

GET

https://api.signals.pressone.africa/v1

/alerts/policies

List alert policies visible to the caller's role › Responses

Every alert policy the caller's role can see.

AlertPolicyList

AlertPolicy[] · required

GET/alerts/policies

curl https://api.signals.pressone.africa/v1/alerts/policies \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "channels": [
        "email"
      ],
      "enabled": true,
      "id": "id",
      "kind": "balance_low",
      "platform_ceiling_minor": 0,
      "platform_ceiling_window_seconds": 0,
      "resolution": {
        "amount_minor": 0,
        "count": 0,
        "currency": "currency",
        "for_seconds": 0,
        "percent": "percent",
        "rule": "rule"
      },
      "revision": 0,
      "scope": {
        "id": "id",
        "label": "label",
        "type": "account"
      },
      "threshold": {
        "amount_minor": 0,
        "currency": "currency",
        "min_events": 0,
        "percent": "percent",
        "window_seconds": 0
      },
      "updated_at": "2024-08-25T15:00:00Z",
      "updated_by": "updated_by"
    }
  ]
}

json

application/json

Create the next immutable revision of an alert policy

PATCH

https://api.signals.pressone.africa/v1

/alerts/policies/{policy_id}

Create the next immutable revision of an alert policy › path Parameters

policy_id

string · required

Alert policy id

Create the next immutable revision of an alert policy › Headers

If-Match

string · required

The quoted revision the caller last read, so a concurrent change answers 412.

Idempotency-Key

string · required

One nonblank key of at most 128 characters; a retry with the same key repeats the outcome.

Create the next immutable revision of an alert policy › Request Body

UpdateAlertPolicyRequest

channels

array | null

Enum values:

webhook

in_app

sms

enabled

boolean | null

Create the next immutable revision of an alert policy › Responses

The new policy revision.

AlertPolicy

channels

AlertChannel[] · required

Enum values:

webhook

in_app

sms

enabled

boolean · required

id

string · required

kind

AlertKind · enum · required

Enum values:

balance_low

spend_daily

spend_monthly

spend_velocity

first_seen_high_cost_destination

new_source_ip

endpoint_health

trunk_apply_failed

platform_ceiling_minor

integer | null · int64 · required

platform_ceiling_window_seconds

integer | null · int32 · required

AlertPolicyResolution · required

revision

integer · int64 · required

AlertPolicyScope · required

AlertPolicyThreshold · required

updated_at

string · date-time · required

updated_by

string · required

PATCH/alerts/policies/{policy_id}

curl https://api.signals.pressone.africa/v1/alerts/policies/:policy_id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'If-Match: <string>' \
  --header 'Idempotency-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "channels": [
    "email"
  ],
  "enabled": true,
  "resolution": {
    "amount_minor": 0,
    "count": 0,
    "currency": "currency",
    "for_seconds": 0,
    "percent": "percent",
    "rule": "below_threshold"
  },
  "scope": {
    "id": "id",
    "label": "label",
    "type": "account"
  },
  "threshold": {
    "amount_minor": 0,
    "currency": "currency",
    "min_events": 0,
    "percent": "percent",
    "window_seconds": 0
  }
}'

Example Request Body

{
  "channels": [
    "email"
  ],
  "enabled": true,
  "resolution": {
    "amount_minor": 0,
    "count": 0,
    "currency": "currency",
    "for_seconds": 0,
    "percent": "percent",
    "rule": "below_threshold"
  },
  "scope": {
    "id": "id",
    "label": "label",
    "type": "account"
  },
  "threshold": {
    "amount_minor": 0,
    "currency": "currency",
    "min_events": 0,
    "percent": "percent",
    "window_seconds": 0
  }
}

json

Example Responses

{
  "channels": [
    "email"
  ],
  "enabled": true,
  "id": "id",
  "kind": "balance_low",
  "platform_ceiling_minor": 0,
  "platform_ceiling_window_seconds": 0,
  "resolution": {
    "amount_minor": 0,
    "count": 0,
    "currency": "currency",
    "for_seconds": 0,
    "percent": "percent",
    "rule": "rule"
  },
  "revision": 0,
  "scope": {
    "id": "id",
    "label": "label",
    "type": "account"
  },
  "threshold": {
    "amount_minor": 0,
    "currency": "currency",
    "min_events": 0,
    "percent": "percent",
    "window_seconds": 0
  },
  "updated_at": "2024-08-25T15:00:00Z",
  "updated_by": "updated_by"
}

json

application/json

Audit