Skip to main content

AccountStatus

objectrequired
Constant value: account_status
accountstringrequired
planstringrequired
Examples:
Example: evaluation
jurisdictionstringrequired

Possible values: [anz, eu, us]

indicatorstringrequired

The worst status among your components, as in the public status API.

Possible values: [none, minor, major, critical, maintenance]

components object[]required
  • Array [
    • idstringrequired

    The public status API's component id.

    namestringrequired
    statusstringrequired

    Possible values: [operational, degraded_performance, partial_outage, major_outage, under_maintenance, not_in_service]

  • ]
    • incidents object[]required

    Open incidents that touch your components in your jurisdiction.

  • Array [
    • idstringrequired
    namestringrequired
    statusstringrequired

    Possible values: [investigating, identified, monitoring, resolved, scheduled, in_progress, verifying, completed]

    impactstringrequired

    Possible values: [none, minor, major, critical, maintenance]

    started_at(string | null)<date-time>nullable
    scheduled_for(string | null)<date-time>nullable
    scheduled_until(string | null)<date-time>nullable
    componentsstring[]required
    shortlinkstring<uri>required
  • ]
    • scheduled_maintenances object[]required

    Maintenance scheduled or in progress that touches your components in your jurisdiction.

  • Array [
    • idstringrequired
    namestringrequired
    statusstringrequired

    Possible values: [investigating, identified, monitoring, resolved, scheduled, in_progress, verifying, completed]

    impactstringrequired

    Possible values: [none, minor, major, critical, maintenance]

    started_at(string | null)<date-time>nullable
    scheduled_for(string | null)<date-time>nullable
    scheduled_until(string | null)<date-time>nullable
    componentsstring[]required
    shortlinkstring<uri>required
  • ]
    • availability object | null

    This calendar month (UTC), measured as the service contract defines it. Null on a plan with no availability target.

    periodstring
    Example: 2026-11
    targetnumber

    Your plan's target, a percentage.

    measurednumber | nullnullable

    So far this month.

    credit_eligibleboolean

    True once the month is below target and a service credit applies.

    page_urlstring<uri>required
    checked_atstring<date-time>required
    AccountStatus
    {
      "account": "string",
      "plan": "evaluation",
      "jurisdiction": "anz",
      "indicator": "none",
      "components": [
        {
          "id": "string",
          "name": "string",
          "status": "operational"
        }
      ],
      "incidents": [
        {
          "id": "string",
          "name": "string",
          "status": "investigating",
          "impact": "none",
          "started_at": "2024-07-29T15:51:28.071Z",
          "scheduled_for": "2024-07-29T15:51:28.071Z",
          "scheduled_until": "2024-07-29T15:51:28.071Z",
          "components": [
            "string"
          ],
          "shortlink": "string"
        }
      ],
      "scheduled_maintenances": [
        {
          "id": "string",
          "name": "string",
          "status": "investigating",
          "impact": "none",
          "started_at": "2024-07-29T15:51:28.071Z",
          "scheduled_for": "2024-07-29T15:51:28.071Z",
          "scheduled_until": "2024-07-29T15:51:28.071Z",
          "components": [
            "string"
          ],
          "shortlink": "string"
        }
      ],
      "availability": "Unknown Type: object,null",
      "page_url": "string",
      "checked_at": "2024-07-29T15:51:28.071Z"
    }