NAV

Introduction

Welcome to the Statusy API. This documentation is for Version 1 of our API.

We have designed our API to be as accessible as possible so you can manage your status page in any way you prefer.

Have questions? Let us know

Authentication

curl -X POST
     -h "Content-Type:application/json"
     -d '{}'
     https://app.statusy.co/api/v1/APITOKEN/services

Statusy uses an in-line API token to authenticate each request you make to our servers.

You can generate an unlimited use API token on the profile page.

Please note, your API token will be shown once for your security, be sure to note it once it has been generated.

If you lose your API token you should delete it immediately. You can then generate a new token.

Conventions

To make things easier, we have established several conventions that can be used when interacting with the Statusy API:

  1. All objects will be singular. For example, accessing team settings is done in /team endpoints.
  2. All endpoints are predicated with /api followed by the API version (version 1 if you are reading this documentation) so the full predicate is /api/v1.
  3. All endpoints use standard request types (POST is create, PUT is for updates, etc.)
  4. All endpoints return data in JSON.

Status Pages

Get Status Page

curl https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGEID

The above command returns JSON structured like this:

{
  "google_analytics_token": null,
  "id": 10,
  "incidents": [],
  "is_active": true,
  "name": "AStatusPage",
  "services": [
    {
      "id": 1,
      "account_id": 1,
      "description": "Service",
      "status_enum": 1
    },
    {
      "id": 2,
      "account_id": 1,
      "description": "Another Service",
      "status_enum": 1
    },
    {
      "id": 3,
      "account_id": 1,
      "description": "Yet Another Service",
      "status_enum": 1
    }
  ],
  "subdomain": "AStatusPage",
  "updated_date": "Fri, 27 May 2016 03:48:22 GMT"
}

This endpoint returns an object with the details of the request status page.

HTTP Request

GET https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGEID

URL Parameters

Parameter Description
APITOKEN Your API token
STATUSPAGEID The ID of the status page you want to get

Get all Status Pages

curl https://app.statusy.co/api/v1/APITOKEN/statuspages

The above command returns JSON structured like this:

{
  "statuspages": [
    {
      "google_analytics_token": null,
      "id": 10,
      "incidents": [],
      "is_active": true,
      "name": "AStatusPage",
      "services": [
        {
          "id": 1,
          "account_id": 1,
          "description": "Service",
          "status_enum": 1
        },
        {
          "id": 2,
          "account_id": 1,
          "description": "Another Service",
          "status_enum": 1
        },
        {
          "id": 3,
          "account_id": 1,
          "description": "Yet Another Service",
          "status_enum": 1
        }
      ],
      "subdomain": "AStatusPage",
      "updated_date": "Fri, 27 May 2016 03:48:22 GMT"
    },
    {
      "google_analytics_token": null,
      "id": 11,
      "incidents": [],
      "is_active": true,
      "name": "AnotherStatusPage",
      "services": [
        {
          "id": 18,
          "account_id": 1,
          "description": "Service",
          "status_enum": 1
        }
      ],
      "subdomain": "AnotherStatusPage",
      "updated_date": "Fri, 27 May 2016 03:54:52 GMT"
    }
  ]
}

This endpoint returns an array of all the status pages on your account.

HTTP Request

GET https://app.statusy.co/api/v1/APITOKEN/statuspages

URL Parameters

Parameter Description
APITOKEN Your API token

Get all Statuses

curl https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/statuses

The above command returns JSON structured like this:

{
  "statuses": [
    {
      "color": "#22A722",
      "id": 48,
      "name": "Fully Operational",
      "weight": 1
    },
    {
      "color": "#F58F0D",
      "id": 49,
      "name": "Degraded Performance",
      "weight": 2
    },
    {
      "color": "#FF0000",
      "id": 50,
      "name": "Major Outage",
      "weight": 3
    }
  ]
}

HTTP Request

GET https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/statuses

URL Parameters

Parameter Description
APITOKEN Your API token
STATUSPAGE_ID The ID of the status page you want to view statuses for

Services

Get all Services

curl https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/service/all

The above command returns JSON structured like this:

{
  "services": [
    {
      "id": 1,
      "account_id": 1,
      "description": "Service",
      "status_enum": 1
    },
    {
      "id": 2,
      "account_id": 1,
      "description": "Another Service",
      "status_enum": 1
    },
    {
      "id": 3,
      "account_id": 1,
      "description": "Yet Another Service",
      "status_enum": 1
    }
  ]
}

This endpoint returns the details of all services on your account.

HTTP Request

GET https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/service/all

Get a Service

curl https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/service/SERVICE_ID

The above command returns JSON structured like this:

{
  "account_id": 1,
  "description": "Website",
  "status_enum": 1
}

This endpoint returns the details of a specific service.

HTTP Request

GET https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/service/SERVICE_ID

URL Parameters

Parameter Description
APITOKEN Your API token
SERVICE_ID The numeric ID of the service you want to get
STATUSPAGE_ID The numeric ID of the status page the service belongs to

Create a Service

curl
 -X POST
 -H "Content-Type:application/json"
 -d '{"description": "Website"}'
 https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/service

The above command returns JSON structured like this:

{
  "service_id": 6,
  "status": "success"
}

This endpoint allows for the creation of a new service.

HTTP Request

POST https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/service

URL Parameters

Parameter Description
APITOKEN Your API token
STATUSPAGE_ID The numeric ID of the status page the service belongs to

JSON Parameters

Parameter Description
description The description is the title of the service, for example “Website” or “Database”.

Update a Service

curl
 -X PUT
 -H "Content-Type:application/json"
 -d '{"description": "Son of Website"}'
 https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/service/SERVICE_ID

The above command returns JSON structured like this:

{
  "status": "success"
}

This endpoint allows you to update the description of a particular service.

HTTP Request

PUT https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/service/SERVICE_ID

URL Parameters

Parameter Description
APITOKEN Your API token
SERVICE_ID The numeric ID of the service you want to update
STATUSPAGE_ID The numeric ID of the status page the service belongs to

JSON Parameters

Parameter Description
description The description is the title of the service, for example “Website” or “Database”.

Delete a Service

curl
 -X DELETE
 -H "Content-Type:application/json"
 https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/service/SERVICE_ID

The above command returns JSON structured like this:

{
  "status": "success"
}

This endpoint allows you to delete an existing service.

HTTP Request

DELETE https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/service/SERVICE_ID

URL Parameters

Parameter Description
APITOKEN Your API token
SERVICE_ID The numeric ID of the service you want to delete
STATUSPAGE_ID The numeric ID of the status page the service belongs to

Incidents

Get all Incidents

curl https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/incident/all

The above command returns JSON structured like this:

{
  "incidents": [
    {
      "created_date": "Fri, 26 Feb 2016 03:36:32 GMT",
      "description": "It is super broken!",
      "id": 1,
      "service_id": 2,
      "solved_date": "Fri, 26 Feb 2016 04:20:39 GMT",
      "title": "Oh man, fire, everywhere!",
      "updated_date": "Fri, 26 Feb 2016 03:36:32 GMT"
    },
    {
      "created_date": "Fri, 26 Feb 2016 03:36:32 GMT",
      "description": "It is super SUPER broken!",
      "id": 2,
      "service_id": 3,
      "solved_date": "Fri, 26 Feb 2016 04:20:39 GMT",
      "title": "Abandon ship!",
      "updated_date": "Fri, 26 Feb 2016 03:36:32 GMT"
    }
  ]
}

This endpoint returns the details of all incidents on your account.

HTTP Request

GET https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/incident/all

URL Parameters

Parameter Description
APITOKEN Your API token
STATUSPAGE_ID The numberic ID of the status page this incident belongs to.

Get an Incident

curl https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/incident/INCIDENT_ID

The above command returns JSON structured like this:

{
  "created_date": "Fri, 26 Feb 2016 03:36:32 GMT",
  "description": "It is super broken!",
  "id": 1,
  "service_id": 2,
  "solved_date": "Fri, 26 Feb 2016 04:20:39 GMT",
  "title": "Oh man, fire, everywhere!",
  "updated_date": "Fri, 26 Feb 2016 03:36:32 GMT"
}

This endpoint returns the details of the specified incident.

HTTP Request

GET https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/incident/INCIDENT_ID

URL Parameters

Parameter Description
APITOKEN Your API token
STATUSPAGE_ID The numberic ID of the status page this incident belongs to.

Create an Incident

curl
 -X POST
 -H "Content-Type:application/json"
 -d '{"service_id": 2, "title": "Something broke!", "description": "Smoke, fire, everywhere!", "status": 1234}'
 https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/incident

The above command returns JSON structured like this:

{
  "incident_id": 2,
  "status": "success"
}

This endpoint allows you to create a new incident.

HTTP Request

POST https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/incident

URL Parameters

Parameter Description
APITOKEN Your API token
STATUSPAGE_ID The numberic ID of the status page this incident belongs to.

JSON Parameters

Parameter Description
service_id The numeric ID of the service this incident is related to
title The title of this incident
description A long text description of the incident. Tell your users what is happening here.
status This is the ID of a status representing the status of the service given this incident. Reference get all statuses endpoint for a list of valid IDs.

Import a Historical Incident

curl
 -X POST
 -H "Content-Type:application/json"
 -d '{"service_id": 2, "title": "Something broke!", "description": "Smoke, fire, everywhere!", "status": 2, "created_date": 2018-02-20 04:29:53.125354+00, "solved_date": 2018-02-20 04:29:53.125354+00}'
 https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/incident/historical

The above command returns JSON structured like this:

{
  "incident_id": 2,
  "status": "success"
}

This endpoint allows you to import old incidents you forgot to add, or that you want to import from a previous status page.

HTTP Request

POST https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/incident/historical

URL Parameters

Parameter Description
APITOKEN Your API token
STATUSPAGE_ID The numberic ID of the status page this incident belongs to.

JSON Parameters

Parameter Description
service_id The numeric ID of the service this incident is related to
title The title of this incident
description A long text description of the incident. Tell your users what is happening here.
status This is a status enum representing the status of the service given this incident.
created_date When this incident was originally created.
solved_date When this incident was originally solved.

Update an Incident

curl
 -X POST
 -H "Content-Type:application/json"
 -d '{"service_id": 2, "title": "Something broke!", "description": "Smoke, fire, everywhere!", "status": 2}'
 https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/incident/INCIDENT_ID

The above command returns JSON structured like this:

{
  "incident_id": 1,
  "incident_update_id": 3,
  "status": "success"
}

This endpoint allows you to add an update to an existing incident.

HTTP Request

POST https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/incident/INCIDENT_ID

URL Parameters

Parameter Description
APITOKEN Your API token
INCIDENT_ID The numeric ID of the incident you want to add an update to.
STATUSPAGE_ID The numberic ID of the status page this incident belongs to.

JSON Parameters

Parameter Description
service_id The numeric ID of the service this incident is related to
title The title of this incident
description A long text description of the incident. Tell your users what is happening here.
status This is a status enum representing the status of the service given this incident.

Maintenance

Get all Maintenance Instances

curl https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/maintenance/all

The above command returns JSON structured like this:

{
  "maintenance": [
    {
      "created_date": "Mon, 16 Apr 2018 03:12:23 GMT",
      "created_date_iso": "2018-04-16T03:12:23.020710+00:00",
      "description": "This is a maintenance",
      "end_date": "Wed, 12 Dec 1990 11:11:00 GMT",
      "id": 7,
      "service_description": "API",
      "service_id": 1,
      "start_date": "Wed, 12 Dec 1990 00:12:00 GMT",
      "statuspage_subdomain": "test",
      "title": "This is a threaded maintenance",
      "updated_date": "Mon, 16 Apr 2018 03:12:23 GMT",
      "updated_date_iso": "2018-04-16T03:12:23.020736+00:00",
      "updates": [
        {
          "created_date": "Mon, 16 Apr 2018 03:12:47 GMT",
          "description": "this is a maintenance update",
          "id": 3,
          "updated_date": "Mon, 16 Apr 2018 03:12:47 GMT"
        },
      ],
      "url": "http://test.statusy.co/maintenance/7"
    },
    {
      "created_date": "Wed, 11 Apr 2018 03:26:52 GMT",
      "created_date_iso": "2018-04-11T03:26:52.148906+00:00",
      "description": "test",
      "end_date": "Wed, 11 Apr 2018 22:26:30 GMT",
      "id": 6,
      "service_description": "API",
      "service_id": 1,
      "start_date": "Tue, 10 Apr 2018 22:26:28 GMT",
      "statuspage_subdomain": "test",
      "title": "Testasdasdasd",
      "updated_date": "Wed, 11 Apr 2018 03:26:52 GMT",
      "updated_date_iso": "2018-04-11T03:26:52.148934+00:00",
      "url": "http://test.statusy.co/maintenance/6"
    },
    {
      "created_date": "Wed, 11 Apr 2018 03:23:54 GMT",
      "created_date_iso": "2018-04-11T03:23:54.728377+00:00",
      "description": "test",
      "end_date": "Wed, 12 Dec 1212 00:12:00 GMT",
      "id": 3,
      "service_description": "Database",
      "service_id": 3,
      "start_date": "Wed, 12 Dec 1212 00:12:00 GMT",
      "statuspage_subdomain": "test",
      "title": "test",
      "updated_date": "Wed, 11 Apr 2018 03:23:54 GMT",
      "updated_date_iso": "2018-04-11T03:23:54.728399+00:00",
      "url": "http://test.statusy.co/maintenance/3"
    },
    {
      "created_date": "Mon, 09 Apr 2018 04:33:32 GMT",
      "created_date_iso": "2018-04-09T04:33:32.053706+00:00",
      "description": "this is a description",
      "end_date": "Tue, 10 Apr 2018 13:01:00 GMT",
      "id": 2,
      "service_description": "Database",
      "service_id": 3,
      "start_date": "Mon, 09 Apr 2018 01:01:00 GMT",
      "statuspage_subdomain": "test",
      "title": "Test maintenance",
      "updated_date": "Mon, 09 Apr 2018 04:33:32 GMT",
      "updated_date_iso": "2018-04-09T04:33:32.053732+00:00",
      "updates": [
        {
          "created_date": "Mon, 09 Apr 2018 04:38:07 GMT",
          "description": "update",
          "id": 2,
          "updated_date": "Mon, 09 Apr 2018 04:38:07 GMT"
        }
      ],
      "url": "http://test.statusy.co/maintenance/2"
    }
  ]
}

This endpoint returns the details of all maintenances on your account.

HTTP Request

GET https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/maintenance/all

URL Parameters

Parameter Description
APITOKEN Your API token
STATUSPAGE_ID The numberic ID of the status page this maintenance belongs to.

Get a Maintenance Event

curl https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/maintenance/MAINTENANCE_ID

The above command returns JSON structured like this:

{
  "created_date": "Mon, 16 Apr 2018 03:12:23 GMT",
  "created_date_iso": "2018-04-16T03:12:23.020710+00:00",
  "description": "This is a maintenance",
  "end_date": "Wed, 12 Dec 1990 11:11:00 GMT",
  "id": 7,
  "service_description": "API",
  "service_id": 1,
  "start_date": "Wed, 12 Dec 1990 00:12:00 GMT",
  "statuspage_subdomain": "test",
  "title": "This is a threaded maintenance",
  "updated_date": "Mon, 16 Apr 2018 03:12:23 GMT",
  "updated_date_iso": "2018-04-16T03:12:23.020736+00:00",
  "updates": [
    {
      "created_date": "Mon, 16 Apr 2018 03:12:47 GMT",
      "description": "this is a maintenance update",
      "id": 3,
      "updated_date": "Mon, 16 Apr 2018 03:12:47 GMT"
    },
  ],
  "url": "http://test.statusy.co/maintenance/7"
}

This endpoint returns the details of the specified maintenance event.

HTTP Request

GET https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/maintenance/MAINTENANCE_ID

URL Parameters

Parameter Description
APITOKEN Your API token
STATUSPAGE_ID The numeric ID of the status page this incident belongs to.
MAINTENANCE_ID The numeric ID of the maintenance event you want to view.

Users

Get details of User making request

curl
https://app.statusy.co/api/v1/APITOKEN/me

The above command returns JSON structured like this:

{
  "created_date": "Mon, 19 Feb 1958 02:00:13 GMT",
  "email": "ddraper@example.com",
  "first_name": "Don",
  "is_confirmed": true,
  "last_name": "Draper"
}

This endpoint returns the details of the user making the request.

HTTP Request

GET https://app.statusy.co/api/v1/APITOKEN/me

URL Parameters

Parameter Description
APITOKEN Your API token

Teams

Get all Users on a Team

curl
https://app.statusy.co/api/v1/APITOKEN/team

The above command returns JSON structured like this:

{
  "status": "success",
  "message": "team members successfully pulled",
  "team": [
    {
      "id": 1,
      "email": "demo@email.com"
    },
  ]
}

This endpoint returns the details of all users who are part of your team.

HTTP Request

GET https://app.statusy.co/api/v1/APITOKEN/team

URL Parameters

Parameter Description
APITOKEN Your API token

Invite User to a Team

curl
 -X POST
 -H "Content-Type:application/json"
 -d '{"email": "demo@email.com"}'
 https://app.statusy.co/api/v1/APITOKEN/team

The above command returns JSON structured like this:

{
  "status": "success",
  "message": "user successfully invited"
}

This endpoint allows you to invite a user to your team. After making the above call, the user will receive an email to complete the sign up process.

HTTP Request

POST https://app.statusy.co/api/v1/APITOKEN/team

URL Parameters

Parameter Description
APITOKEN Your API token

JSON Parameters

Parameter Description
email The email address of the person you wish to add to your team

Remove User from a Team

curl
 -X DELETE
 https://app.statusy.co/api/v1/APITOKEN/team/USERID

The above command returns JSON structured like this:

{
  "status": "success",
  "message": "user successfully deleted"
}

This endpoint allows you to remove a user from your team.

HTTP Request

DELETE https://app.statusy.co/api/v1/APITOKEN/team/USERID

URL Parameters

Parameter Description
APITOKEN Your API token
USERID The ID of the user you want to remove

Notifications

Add Email Subscriber

curl
  -X POST
  -H "Content-Type: application/json"
  -d '{"email":"anemail@adomain.com"}'
  https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/subscriber/email/new

The above command returns JSON structured like this:

{
  "email": "anemail@adomain.com",
  "notification_id": 21,
  "status": "success"
}

This endpoint allows you to add a new email subscriber to your status page. The email you provide will receive email notifications when the status of your service(s) has changed.

HTTP Request

POST https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/subscriber/email/new

URL Parameters

Parameter Description
APITOKEN Your API token
STATUSPAGE_ID The numeric ID of the status page this subscriber should be added to

JSON Parameters

Parameter Description
email The email address notifications should be sent to

Remove Email Subscriber

curl
  -X POST
  -H "Content-Type: application/json"
  -d '{"email":"anemail@adomain.com"}'
  https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/subscriber/email/delete

The above command returns JSON structured like this:

{
  "status": "success",
  "message": "subscriber removed"
}

This endpoint allows you to remove an existing email subscriber from your status page.

HTTP Request

POST https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/subscriber/email/delete

URL Parameters

Parameter Description
APITOKEN Your API token
STATUSPAGE_ID The numeric ID of the status page this subscriber belongs to

JSON Parameters

Parameter Description
email The email address of subscriber to remove

Add SMS Subscriber

curl
  -X POST
  -H "Content-Type: application/json"
  -d '{"phone":"5555555555"}'
  https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/subscriber/sms/new

The above command returns JSON structured like this:

{
  "phone": "5555555555",
  "notification_id": 21,
  "status": "success"
}

This endpoint allows you to add a new SMS subscriber to your status page. The email you provide will receive SMS notifications when the status of your service(s) has changed.

HTTP Request

POST https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/subscriber/sms/new

URL Parameters

Parameter Description
APITOKEN Your API token
STATUSPAGE_ID The numeric ID of the status page this subscriber should be added to

JSON Parameters

Parameter Description
phone The phone number notifications should be sent to

Remove SMS Subscriber

curl
  -X POST
  -H "Content-Type: application/json"
  -d '{"phone":"5555555555"}'
  https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/subscriber/sms/delete

The above command returns JSON structured like this:

{
  "status": "success",
  "message": "subscriber removed"
}

This endpoint allows you to remove an existing email subscriber from your status page.

HTTP Request

POST https://app.statusy.co/api/v1/APITOKEN/statuspage/STATUSPAGE_ID/subscriber/email/delete

URL Parameters

Parameter Description
APITOKEN Your API token
STATUSPAGE_ID The numeric ID of the status page this subscriber belongs to

JSON Parameters

Parameter Description
phone The phone number notifications should be sent to

Public Data

Public Status Page Status

curl
 https://app.statusy.co/api/v1/public/statuspage/STATUSPAGE_SUBDOMAIN

The above command returns JSON structured like this:

{
  "statuspage": {
    "id": "7",
    "name": "JustAStatusPage",
    "overall_status": "Fully Operational",
    "incidents": [
      {
        "created_date": "Tue, 20 Feb 2018 04:28:50 GMT",
        "created_date_iso": "2018-02-20T04:28:50.294807+00:00",
        "description": "test",
        "id": 4,
        "service_description": "API",
        "service_id": 1,
        "solved_date": null,
        "status": "Degraded Performance",
        "status_enum": 2,
        "statuspage_subdomain": "test",
        "title": "test",
        "updated_date": "Tue, 20 Feb 2018 04:28:50 GMT",
        "updated_date_iso": "2018-02-20T04:28:50.294832+00:00",
        "url": "http://justastatuspage.statusy.co/incident/4"
      },
    ],
    "maintenance": [
      {
        "created_date": "Mon, 09 Apr 2018 04:33:32 GMT",
        "created_date_iso": "2018-04-09T04:33:32.053706+00:00",
        "description": "this is a description",
        "end_date": "Tue, 10 Apr 2018 13:01:00 GMT",
        "id": 2,
        "service_description": "Database",
        "service_id": 3,
        "start_date": "Mon, 09 Apr 2018 01:01:00 GMT",
        "statuspage_subdomain": "test",
        "title": "Test maintenance",
        "updated_date": "Mon, 09 Apr 2018 04:33:32 GMT",
        "updated_date_iso": "2018-04-09T04:33:32.053732+00:00",
        "updates": [
          {
            "created_date": "Mon, 09 Apr 2018 04:38:07 GMT",
            "description": "Foo",
            "id": 2,
            "updated_date": "Mon, 09 Apr 2018 04:38:07 GMT"
          }
        ],
        "url": "http://justastatuspage.statusy.co/maintenance/2"
      },
    ],
    "services": [
      {
        "description": "OneService",
        "status": "Fully Operational",
        "status_obj": {
          "color": "#13BA74",
          "id": 1,
          "name": "Fully Operational",
          "text_color": "#FFFFFF",
          "weight": 1
        },
        "service_obj": {
          "description": "Test",
          "id": 8,
          "status": {
            "color": "#13BA74",
            "id": 1,
            "name": "Fully Operational",
            "text_color": "#FFFFFF",
            "weight": 1
          },
          "status_page_id": 1,
          "subservices": []
        }
      },
    ],
    "subdomain": "justastatuspage"
  }
}

This endpoint returns the overall status and individual service statuses of a public status page.

HTTP Request

GET https://app.statusy.co/api/v1/public/statuspage/STATUSPAGE_SUBDOMAIN

URL Parameters

Parameter Description
STATUSPAGE_SUBDOMAIN The subdomain of the status page you want the status of.

Errors

We make use of the following HTTP error codes:

Error Code Meaning
400 Bad Request – Your request was most likely formatted incorrectly
403 Forbidden – Your API key is either invalid or you are attempting to access something you do not have rights to access
404 Not Found – The thing you wanted to get or update didn’t exist
500 Internal Server Error – Our servers were unable to process your request - give it a few minutes and try again. If it keeps failing contact us
503 Service Unavailable – Our servers are offline, check our status page for more details.