Status Pages

List Status Pages

get

https://api.eu.squadcast.comhttps://api.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

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.StatusPages.List(ctx, 301790, 172386, "<value>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V4StatusPagesListStatusPagesResponse != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

{
  "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.eu.squadcast.comhttps://api.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

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.StatusPages.Create(ctx, components.V4StatusPagesCreateStatusPageRequest{
        Name: "<value>",
        DomainName: "failing-convection.com",
        LogoURL: "https://snarling-season.info",
        Timezone: "Pacific/Chuuk",
        TeamID: "<id>",
        ContactEmail: "<value>",
        OwnerType: components.V4StatusPagesCreateStatusPageRequestOwnerTypeTeam,
        OwnerID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "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.eu.squadcast.comhttps://api.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}

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.StatusPages.GetByID(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "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.eu.squadcast.comhttps://api.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}

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.StatusPages.UpdateByID(ctx, "<id>", components.V4StatusPagesUpdateStatusPageByIDRequest{
        Name: "<value>",
        IsPublic: false,
        DomainName: "blank-brief.info",
        TeamID: "<id>",
        ThemeColor: components.V4StatusPagesUpdateStatusPageByIDRequestThemeColor{
            Primary: "<value>",
            Secondary: "<value>",
        },
        ContactEmail: "<value>",
        OwnerType: "<value>",
        OwnerID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "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.eu.squadcast.comhttps://api.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}

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.StatusPages.DeleteByID(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

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

List Status Page Statuses

get

https://api.eu.squadcast.comhttps://api.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

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.StatusPages.GetStatuses(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

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