Status Pages/Maintenances

List Maintenances

get

/v4/statuspages/{statuspageID}/maintenance

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

statuspageIDstringRequired

Query parameters

startTimestringRequired

endTimestringRequired

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}/maintenance

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.ListMaintenances(ctx, "<id>", "<value>", "<value>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V4StatusPagesMaintenancesListMaintenancesResponse != nil {
        // handle response
    }
}

{
  "data": [
    {
      "id": 1,
      "title": "text",
      "pageID": 1,
      "note": "text",
      "components": [
        {
          "id": 1,
          "name": "text",
          "groupName": "text"
        }
      ],
      "startTime": "2026-03-18T06:41:45.169Z",
      "endTime": "2026-03-18T06:41:45.169Z",
      "maintenanceState": "text"
    }
  ],
  "meta": {
    "totalCount": 1
  }
}

Create Maintenance

post

/v4/statuspages/{statuspageID}/maintenance

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

statuspageIDstringRequired

Body

titlestringRequired

notestringRequired

componentsinteger[]Required

startTimestring · date-timeRequired

endTimestring · date-timeRequired

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/{statuspageID}/maintenance

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/types"
	"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.Maintenances.Create(ctx, "<id>", components.V4StatusPagesMaintenancesCreateMaintenanceRequest{
        Title: "<value>",
        Note: "<value>",
        Components: []int64{
            191583,
            227211,
            362920,
        },
        StartTime: types.MustTimeFromString("2024-08-24T09:07:30.992Z"),
        EndTime: types.MustTimeFromString("2024-04-27T16:39:01.283Z"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": 1,
    "title": "text",
    "pageID": 1,
    "note": "text",
    "components": [
      1
    ],
    "startTime": "2026-03-18T06:41:45.169Z",
    "endTime": "2026-03-18T06:41:45.169Z"
  }
}

Get Maintenance By ID

get

/v4/statuspages/{statuspageID}/maintenance/{maintenance_id}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

statuspageIDstringRequired

maintenance_idstringRequired

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}/maintenance/{maintenance_id}

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.GetMaintenanceByID(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "ID": 1,
    "PageID": 1,
    "ComponentIDList": [
      1
    ],
    "Title": "text",
    "Note": "text",
    "StartTime": "2026-03-18T06:41:45.169Z",
    "EndTime": "2026-03-18T06:41:45.169Z",
    "createdAt": "2026-03-18T06:41:45.169Z",
    "updatedAt": "2026-03-18T06:41:45.169Z",
    "deletedAt": "2026-03-18T06:41:45.169Z"
  }
}

Update Maintenance By ID

put

/v4/statuspages/{statuspageID}/maintenance/{maintenance_id}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

statuspageIDstringRequired

maintenance_idstringRequired

Body

titlestringRequired

notestringRequired

componentsinteger[]Optional

startTimestring · date-timeRequired

endTimestring · date-timeRequired

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}/maintenance/{maintenance_id}

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/types"
	"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.Maintenances.UpdateByID(ctx, "<id>", "<id>", components.V4StatusPagesMaintenancesUpdateMaintenanceByIDRequest{
        Title: "<value>",
        Note: "<value>",
        StartTime: types.MustTimeFromString("2024-07-22T17:12:15.919Z"),
        EndTime: types.MustTimeFromString("2024-06-11T21:00:35.262Z"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": 1,
    "title": "text",
    "pageID": 1,
    "note": "text",
    "components": [
      1
    ],
    "startTime": "2026-03-18T06:41:45.169Z",
    "endTime": "2026-03-18T06:41:45.169Z"
  }
}

Delete Maintenance By ID

delete

/v4/statuspages/{statuspageID}/maintenance/{maintenance_id}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

statuspageIDstringRequired

maintenance_idstringRequired

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}/maintenance/{maintenance_id}

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.Maintenances.DeleteByID(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": 1,
    "title": "text",
    "pageID": 1,
    "note": "text",
    "components": [
      1
    ],
    "startTime": "2026-03-18T06:41:45.169Z",
    "endTime": "2026-03-18T06:41:45.169Z"
  }
}

PreviousStatus Pages/Issues NextStatus Pages/Components

Last updated 3 days ago

Good morning

hashtagList Maintenances

hashtagCreate Maintenance

hashtagGet Maintenance By ID

hashtagUpdate Maintenance By ID

hashtagDelete Maintenance By ID

List Maintenances

Create Maintenance

Get Maintenance By ID

Update Maintenance By ID

Delete Maintenance By ID