Services

Overview

Available Operations

• List - Get All Services
• Create - Create Service
• GetByName - Get Services By Name
• GetByID - Get Service By ID
• Update - Update Service
• Delete - Delete Service
• CreateOrUpdateAptaConfig - Auto Pause Transient Alerts (APTA)
• UpsertIagConfig - Intelligent Alert Grouping (IAG)
• UpdateNotificationDelayConfig - Delayed Notification Config
• CreateOrUpdateDependencies - Create or Update Dependencies
• CreateOrUpdateNotificationTemplateOverlay - Create or Update Notification Template Overlay
• GetAllDedupKeyOverlays - Get All Dedup Key Overlay by Service
• UpdateDedupKeyOverlay - Update Dedup Key Overlay
• GetRoutingRules - Get Routing Rules
• CreateOrUpdateSuppressionRules - Create or Update Suppression Rules
• CreateOrUpdateTaggingRules - Create or Update Tagging Rules

List

Get All Services

Example Usage

Parameters

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

Response

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

Create

Create Service

Example Usage

Parameters

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

Response

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

GetByName

Get Services By Name

Example Usage

Parameters

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

Response

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

GetByID

Get Service By ID

Example Usage

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

Update

Update Service

Example Usage

Parameters

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

Response

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

Delete

Delete Service

Example Usage

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

CreateOrUpdateAptaConfig

Auto Pause Transient Alerts (APTA)

Example Usage

Parameters

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

Response

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

UpsertIagConfig

Intelligent Alert Grouping (IAG)

Example Usage

Parameters

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

Response

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

UpdateNotificationDelayConfig

Delayed Notification Config

Example Usage

Parameters

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

Response

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

CreateOrUpdateDependencies

Create or Update Dependencies

Example Usage

Parameters

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

Response

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

CreateOrUpdateNotificationTemplateOverlay

Create or Update Notification Template Overlay

Example Usage

Parameters

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

Response

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

GetAllDedupKeyOverlays

Get All Dedup Key Overlay by Service

Example Usage

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.OverlayGetAllDedupKeyOverlayByServiceResponse, 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