StatusPages.Maintenances

Overview

Available Operations

• Create - Create Maintenance
• DeleteByID - Delete Maintenance By ID
• UpdateByID - Update Maintenance By ID

Create

Create Maintenance

Example Usage

package main

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

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

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_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
    }
}

Parameters

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

Response

*operations.MaintenancesCreateMaintenanceResponse, 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	*/*

DeleteByID

Delete Maintenance By ID

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_REFRESH_TOKEN_AUTH")),
    )

    res, err := s.StatusPages.Maintenances.DeleteByID(ctx, "<id>", "<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.
statuspageID	string	✔️	N/A
maintenanceID	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.MaintenancesDeleteMaintenanceByIDResponse, 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	*/*

UpdateByID

Update Maintenance By ID

Example Usage

package main

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

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

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_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
    }
}

Parameters

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

Response

*operations.MaintenancesUpdateMaintenanceByIDResponse, 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	*/*