2

Vultr Server Status JSON Endpoints

 2 years ago
source link: https://www.vultr.com/docs/vultr-server-status-json-endpoints
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
<?xml encoding="utf-8" ??>

In addition to our HTML status page, Vultr also provides real-time status and alert information in JSON format. This guide documents our JSON schema for alerts and status.

JSON Status Endpoint

The Status endpoint provides a JSON object containing the current Vultr infrastructure status. This summary includes all regions, current outages, alerts, and upcoming scheduled maintenance. The status endpoint is:

Status Schema

The status object consists of two top-level nodes:

  • service_alerts: Array

    • Array of service alert objects related to Vultr API or Customer Portal service issues.
      This field only returns data if there is an active issue.
  • regions: String

    • A collection of Regions

Regions are prefixed by RegionID and consist of:

  • location: String

    • Location name
  • country: String

    • Country code
  • country_name: String

    • Country name
  • alerts: Array

    • A array of alert objects. See the Alert schema for details.

Status JSON Example

{
    "service_alerts": [],
    "regions": {
        "atl": {
            "location": "Atlanta",
            "country": "US",
            "country_name": "United States",
            "alerts": [
                {
                    "id": "80349394-43b0-438a-ba4d-ac05a726deb2",
                    "subject": "Atlanta Scheduled Maintenance - 2020-11-10",
                    "status": "ongoing",
                    "start_date": "2020-11-02T16:07:00+00:00",
                    "updated_at": "",
                    "entries": [
                        {
                            "updated_at": "2020-11-02T16:07:00+00:00",
                            "message": "Event Type: Network Upgrade\r\n\r\nWe are performing system changes in the Atlanta location during the following scheduled maintenance window. \r\n\r\nStart Time: 2020-11-10 11:00:00 UTC\r\nEnd Time: 2020-11-10 15:00:00 UTC"
                        }
                    ]
                },
                {
                    "id": "e08e4b1e-9b4d-47a7-8931-86c19d490fa9",
                    "subject": "Atlanta Datacenter Scheduled Maintenance - 2020-11-03",
                    "status": "resolved",
                    "start_date": "2020-11-02T14:10:00+00:00",
                    "updated_at": "2020-11-02T15:19:00+00:00",
                    "entries": [
                        {
                            "updated_at": "2020-11-02T15:19:00+00:00",
                            "message": "Maintenance will be moved to next week. Nov 9-13. More info to follow."
                        },
                        {
                            "updated_at": "2020-11-02T14:10:00+00:00",
                            "message": "Event Type: Network Upgrade\r\n\r\nWe are performing system changes in the Atlanta Datacenter Datacenter location during the following scheduled maintenance window. \r\n\r\nStart Time: 2020-11-03 11:00:00 UTC\r\nEnd Time: 2020-11-03 15:00:00 UTC"
                        }
                    ]
                }
            ]
        },
        "ord": {
            "location": "Chicago",
            "country": "US",
            "country_name": "United States",
            "alerts": []
        },
        "dfw": {
            "location": "Dallas",
            "country": "US",
            "country_name": "United States",
            "alerts": []
        },
        "lax": {
            "location": "Los Angeles",
            "country": "US",
            "country_name": "United States",
            "alerts": []
        },
        "mia": {
            "location": "Miami",
            "country": "US",
            "country_name": "United States",
            "alerts": []
        },
        "ewr": {
            "location": "New Jersey",
            "country": "US",
            "country_name": "United States",
            "alerts": []
        },
        "sea": {
            "location": "Seattle",
            "country": "US",
            "country_name": "United States",
            "alerts": []
        },
        "sjc": {
            "location": "Silicon Valley",
            "country": "US",
            "country_name": "United States",
            "alerts": []
        },
        "sgp": {
            "location": "Singapore",
            "country": "SG",
            "country_name": "Singapore",
            "alerts": []
        },
        "ams": {
            "location": "Amsterdam",
            "country": "NL",
            "country_name": "Netherlands",
            "alerts": []
        },
        "icn": {
            "location": "Seoul",
            "country": "KR",
            "country_name": "Korea, Republic of",
            "alerts": []
        },
        "nrt": {
            "location": "Tokyo",
            "country": "JP",
            "country_name": "Japan",
            "alerts": []
        },
        "lhr": {
            "location": "London",
            "country": "GB",
            "country_name": "United Kingdom",
            "alerts": []
        },
        "cdg": {
            "location": "Paris",
            "country": "FR",
            "country_name": "France",
            "alerts": []
        },
        "fra": {
            "location": "Frankfurt",
            "country": "DE",
            "country_name": "Germany",
            "alerts": []
        },
        "yto": {
            "location": "Toronto",
            "country": "CA",
            "country_name": "Canada",
            "alerts": []
        },
        "syd": {
            "location": "Sydney",
            "country": "AU",
            "country_name": "Australia",
            "alerts": []
        }
    }
}

JSON Alert Endpoint

The alert endpoint provides a JSON object containing a stream of the current alerts, with new alerts added to the beginning of the stream. The Alert endpoint is:

Alert Schema

The Alert object is an array of service_alerts consisting of:

  • ID: String

    • A Version 4 UUID
  • region: String

    • A RegionID
  • subject: String

    • The subject line of the alert
  • start_date: String

  • updated_at: String

  • status: String

    • The alert status. Valid values are ongoing and resolved
  • entries: Array

    • An array of service_alert entries

A service_alert entry consists of:

  • updated_at: String

  • message: String

    • The service_alert message body

Alert JSON Example

{
    "service_alerts": [
        {
            "id": "80349394-43b0-438a-ba4d-ac05a726deb2",
            "region": "atl",
            "subject": "Atlanta Scheduled Maintenance - 2020-11-10",
            "start_date": "2020-11-02T16:07:00+00:00",
            "updated_at": "",
            "status": "ongoing",
            "entries": [
                {
                    "updated_at": "2020-11-02T16:07:00+00:00",
                    "message": "Event Type: Network Upgrade\r\n\r\nWe are performing system changes in the Atlanta location during the following scheduled maintenance window. \r\n\r\nStart Time: 2020-11-10 11:00:00 UTC\r\nEnd Time: 2020-11-10 15:00:00 UTC"
                }
            ]
        },
        {
            "id": "e08e4b1e-9b4d-47a7-8931-86c19d490fa9",
            "region": "atl",
            "subject": "Atlanta Datacenter Scheduled Maintenance - 2020-11-03",
            "start_date": "2020-11-02T14:10:00+00:00",
            "updated_at": "2020-11-02T15:19:00+00:00",
            "status": "resolved",
            "entries": [
                {
                    "updated_at": "2020-11-02T15:19:00+00:00",
                    "message": "Maintenance will be moved to next week. Nov 9-13. More info to follow."
                },
                {
                    "updated_at": "2020-11-02T14:10:00+00:00",
                    "message": "Event Type: Network Upgrade\r\n\r\nWe are performing system changes in the Atlanta Datacenter Datacenter location during the following scheduled maintenance window. \r\n\r\nStart Time: 2020-11-03 11:00:00 UTC\r\nEnd Time: 2020-11-03 15:00:00 UTC"
                }
            ]
        }
    ]
}

HTML Server Status

The Server Status page displays the status and compute availability of each Vultr location in HTML. If a location's status is other than Ok, click the status notification to view the alert. The Server Status page is:

Want to contribute?

You could earn up to $600 by adding new articles


About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK