Services/Maintenance Mode

Get Maintenance Mode

get

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

/v3/services/{serviceID}/maintenance

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

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

/v3/services/{serviceID}/maintenance

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

{
  "data": [
    {
      "service_id": "text",
      "maintenance_from": "2026-03-18T06:16:10.133Z",
      "maintenance_till": "2026-03-18T06:16:10.133Z",
      "repetition_daily": true,
      "repetition_weekly": true,
      "repetition_two_weekly": true,
      "repetition_three_weekly": true,
      "repetition_monthly": true,
      "deleted": true,
      "repeat_till": "2026-03-18T06:16:10.133Z"
    }
  ]
}

Create or Update Maintenance Mode

post

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

/v3/services/{serviceID}/maintenance

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

Body

application/json

onMaintenancebooleanRequired

Responses

200

The request has succeeded.

application/json

datastringRequired

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

/v3/services/{serviceID}/maintenance

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.Services.MaintenanceMode.CreateOrUpdate(ctx, "<id>", components.V3ServicesMaintenanceModeCreateOrUpdateMaintenanceModeRequest{
        OnMaintenance: true,
        ServiceMaintenance: []components.V3ServicesMaintenanceModeServiceMaintenance{
            components.V3ServicesMaintenanceModeServiceMaintenance{
                MaintenanceStartDate: "<value>",
                Daily: false,
                Weekly: true,
                TwoWeekly: false,
                ThreeWeekly: true,
                Monthly: true,
                Deleted: false,
                RepeatTill: "<value>",
            },
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": "text"
}