Status Pages

List Status Pages

get

https://api.squadcast.comhttps://api.eu.squadcast.com

/v4/statuspages

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageSizeintegerRequired

pageNumberintegerRequired

filters.isPublicstringRequired

teamIDstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get/v4/statuspages

HTTPcURLJavaScriptPython

GET /v4/statuspages?pageSize=1&pageNumber=1&filters.isPublic=text&teamID=text HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": 1,
      "name": "text",
      "isPublic": true,
      "domainName": "text",
      "customDomainName": "text",
      "timezone": "text",
      "logoUrl": "text",
      "components": [
        {
          "id": 1,
          "name": "text"
        }
      ],
      "isCustomDomainEnabled": true,
      "isCustomARecordVerified": true,
      "isCustomTxtVerified": true,
      "txtRecord": "text",
      "aRecord": "text",
      "subscribersCount": 1,
      "status": {
        "id": 1,
        "name": "text",
        "color": "text",
        "slug": "text"
      },
      "underMaintenance": true,
      "statusMaintenance": {
        "id": 1,
        "name": "text",
        "color": "text",
        "slug": "text"
      },
      "ownerType": "text",
      "ownerID": "text"
    }
  ],
  "meta": {
    "totalCount": 1,
    "orgTotalCount": 1
  }
}

Create Status Page

post

https://api.squadcast.comhttps://api.eu.squadcast.com

/v4/statuspages

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

descriptionstringOptional

isPublicbooleanOptional

domainNamestringRequired

customDomainNamestringOptional

logoUrlstringRequired

timezonestringRequired

teamIDstringRequired

contactEmailstringRequired

allowWebhookSubscriptionbooleanOptional

allowComponentsSubscriptionbooleanOptional

allowMaintenanceSubscriptionbooleanOptional

ownerTypestring · enumRequiredPossible values:

ownerIDstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

post/v4/statuspages

HTTPcURLJavaScriptPython

POST /v4/statuspages HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 572

{
  "name": "text",
  "description": "text",
  "isPublic": true,
  "domainName": "text",
  "customDomainName": "text",
  "logoUrl": "text",
  "timezone": "text",
  "teamID": "text",
  "themeColor": {
    "primary": "text",
    "secondary": "text"
  },
  "components": [
    {
      "type": "component",
      "name": "text",
      "allowSubscription": true,
      "description": "text",
      "components": [
        {
          "type": "component",
          "name": "text",
          "allowSubscription": true,
          "description": "text",
          "serviceID": "text"
        }
      ]
    }
  ],
  "contactEmail": "text",
  "allowWebhookSubscription": true,
  "allowComponentsSubscription": true,
  "allowMaintenanceSubscription": true,
  "ownerType": "team",
  "ownerID": "text"
}

{
  "data": {
    "id": 1,
    "organizationID": "text",
    "name": "text",
    "isPublic": true,
    "timezone": "text",
    "description": "text",
    "domainName": "text",
    "contactEmail": "text",
    "themeColor": {
      "primary": "text",
      "secondary": "text"
    },
    "components": [
      {
        "type": "component",
        "name": "text",
        "allowSubscription": true,
        "description": "text",
        "components": [
          {
            "type": "component",
            "name": "text",
            "allowSubscription": true,
            "description": "text",
            "serviceID": "text"
          }
        ]
      }
    ],
    "allowComponentsSubscription": true,
    "allowMaintenanceSubscription": true,
    "allowWebhookSubscription": true,
    "ownerType": "text",
    "ownerID": "text",
    "teamID": "text"
  }
}

Get Status Page By ID

get

https://api.squadcast.comhttps://api.eu.squadcast.com

/v4/statuspages/{statuspageID}

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

statuspageIDstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get/v4/statuspages/{statuspageID}

HTTPcURLJavaScriptPython

GET /v4/statuspages/{statuspageID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": 1,
    "organizationID": "text",
    "name": "text",
    "isPublic": true,
    "timezone": "text",
    "description": "text",
    "domainName": "text",
    "customDomainName": "text",
    "contactEmail": "text",
    "themeColor": {
      "primary": "text",
      "secondary": "text"
    },
    "allowComponentsSubscription": true,
    "allowMaintenanceSubscription": true,
    "allowWebhookSubscription": true,
    "ownerType": "text",
    "ownerID": "text",
    "teamID": "text"
  }
}

Update Status Page By ID

put

https://api.squadcast.comhttps://api.eu.squadcast.com

/v4/statuspages/{statuspageID}

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

statuspageIDstringRequired

Body

application/json

namestringRequired

descriptionstringOptional

isPublicbooleanRequired

domainNamestringRequired

customDomainNamestringOptional

logoUrlstringOptional

timezonestringOptional

teamIDstringRequired

allowComponentsSubscriptionbooleanOptional

allowMaintenanceSubscriptionbooleanOptional

allowWebhookSubscriptionbooleanOptional

contactEmailstringRequired

isCustomDomainEnabledbooleanOptional

hideFromSearchEnginesbooleanOptional

ownerTypestringRequired

ownerIDstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

put/v4/statuspages/{statuspageID}

HTTPcURLJavaScriptPython

PUT /v4/statuspages/{statuspageID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 620

{
  "name": "text",
  "description": "text",
  "isPublic": true,
  "domainName": "text",
  "customDomainName": "text",
  "logoUrl": "text",
  "timezone": "text",
  "teamID": "text",
  "themeColor": {
    "primary": "text",
    "secondary": "text"
  },
  "allowComponentsSubscription": true,
  "allowMaintenanceSubscription": true,
  "allowWebhookSubscription": true,
  "components": [
    {
      "type": "text",
      "name": "text",
      "allowSubscription": true,
      "description": "text",
      "components": [
        {
          "type": "text",
          "name": "text",
          "allowSubscription": true,
          "description": "text",
          "serviceID": "text"
        }
      ]
    }
  ],
  "contactEmail": "text",
  "isCustomDomainEnabled": true,
  "hideFromSearchEngines": true,
  "ownerType": "text",
  "ownerID": "text"
}

{
  "data": {
    "id": 1,
    "organizationID": "text",
    "name": "text",
    "isPublic": true,
    "timezone": "text",
    "description": "text",
    "domainName": "text",
    "customDomainName": "text",
    "contactEmail": "text",
    "themeColor": {
      "primary": "text",
      "secondary": "text"
    },
    "allowComponentsSubscription": true,
    "allowMaintenanceSubscription": true,
    "allowWebhookSubscription": true,
    "hideFromSearchEngines": true,
    "ownerType": "text",
    "ownerID": "text",
    "teamID": "text"
  }
}

Delete Status Page By ID

delete

https://api.squadcast.comhttps://api.eu.squadcast.com

/v4/statuspages/{statuspageID}

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

statuspageIDstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

delete/v4/statuspages/{statuspageID}

HTTPcURLJavaScriptPython

DELETE /v4/statuspages/{statuspageID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": 1,
    "name": "text",
    "organizationID": "text",
    "teamID": "text"
  }
}

List Status Page Statuses

get

https://api.squadcast.comhttps://api.eu.squadcast.com

/v4/statuspages/{statuspageID}/status

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

statuspageIDstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get/v4/statuspages/{statuspageID}/status

HTTPcURLJavaScriptPython

GET /v4/statuspages/{statuspageID}/status HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": 1,
      "name": "text",
      "status": "text",
      "description": "text",
      "color": "text"
    }
  ]
}