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
ownerID
string
✔️
N/A
entityOwner
*string
➖
N/A
name
*string
➖
N/A
Response
*operations.ServicesGetServicesResponse, error
Errors
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
ownerID
string
✔️
N/A
Response
*operations.ServicesCreateServiceResponse, error
Errors
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
name
string
✔️
N/A
ownerID
string
✔️
N/A
Response
*operations.ServicesGetServicesByNameResponse, error
Errors
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
serviceID
string
✔️
N/A
Response
*operations.ServicesGetServiceByIDResponse, error
Errors
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
serviceID
string
✔️
N/A
Response
*operations.ServicesUpdateServiceResponse, error
Errors
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
serviceID
string
✔️
N/A
Response
*operations.ServicesDeleteServiceResponse, error
Errors
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
serviceID
string
✔️
N/A
Response
*operations.ServicesCreateOrUpdateAPTAConfigResponse, error
Errors
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
serviceID
string
✔️
N/A
Response
*operations.ServicesCreateOrUpdateIAGConfigResponse, error
Errors
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
serviceID
string
✔️
N/A
Response
*operations.ServicesDelayedNotificationConfigResponse, error
Errors
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
serviceID
string
✔️
N/A
v3ServicesDependenciesCreateOrUpdateDependenciesRequest
✔️
N/A
Response
*operations.DependenciesCreateOrUpdateDependenciesResponse, error
Errors
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
serviceID
string
✔️
N/A
alertSource
string
✔️
N/A
v3ServicesOverlayUpdateCustomContentTemplateOverlayRequest
✔️
N/A
Response
*operations.OverlayCreateOrUpdateNotificationTemplateOverlayResponse, error
Errors
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
serviceID
string
✔️
N/A
Response
*operations.OverlayGetAllDedupKeyOverlayByServiceResponse, error
Errors
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
*/*
UpdateDedupKeyOverlay
Update Dedup Key Overlay
Example Usage
Parameters
serviceID
string
✔️
N/A
alertSource
string
✔️
N/A
v3ServicesOverlayUpdateDedupKeyOverlayRequest
✔️
N/A
Response
*operations.OverlayUpdateDedupKeyOverlayResponse, error
Errors
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
*/*
GetRoutingRules
Get Routing Rules
Example Usage
Parameters
serviceID
string
✔️
N/A
Response
*operations.RoutingRulesGetRoutingRulesResponse, error
Errors
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
*/*
CreateOrUpdateSuppressionRules
Create or Update Suppression Rules
Example Usage
Parameters
serviceID
string
✔️
N/A
v3ServicesSuppressionRulesCreateOrUpdateSuppressionRulesRequest
✔️
N/A
Response
*operations.SuppressionRulesCreateOrUpdateSuppressionRulesResponse, error
Errors
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
*/*
CreateOrUpdateTaggingRules
Create or Update Tagging Rules
Example Usage
Parameters
serviceID
string
✔️
N/A
v3ServicesTaggingRulesCreateOrUpdateTaggingRulesRequest
✔️
N/A
Response
*operations.TaggingRulesCreateOrUpdateTaggingRulesResponse, error
Errors
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
*/*
Last updated