Services.MaintenanceMode

Overview

Available Operations

• Get - Get Maintenance Mode

• CreateOrUpdate - Create or Update Maintenance Mode

Get

Get Maintenance Mode

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/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
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
serviceID	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.MaintenanceModeGetMaintenanceModeResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*

CreateOrUpdate

Create or Update Maintenance Mode

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/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
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
serviceID	string	✔️	N/A
v3ServicesMaintenanceModeCreateOrUpdateMaintenanceModeRequest	components.V3ServicesMaintenanceModeCreateOrUpdateMaintenanceModeRequest	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.MaintenanceModeCreateOrUpdateMaintenanceModeResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*