Skip to content
This repository was archived by the owner on Jan 12, 2021. It is now read-only.

Latest commit

 

History

History
194 lines (145 loc) · 9.9 KB

File metadata and controls

194 lines (145 loc) · 9.9 KB

IntegrationsPagerDutyApi

All URIs are relative to http://localhost/

Method HTTP request Description
create POST api/v2/integrations/pager_duty.json_api Create a Pager Duty Integration
show GET api/v2/integrations/{integration_id}/pager_duty.json_api Show a single Pager Duty Integration
update PATCH api/v2/integrations/{integration_id}/pager_duty.json_api Update a Pager Duty Integration

create

IntegrationPagerDuty create(apiKey, externalAccountIds, name, include, allHighRisk, allLowRisk, allMediumRisk, customSignatureIds, sendUpdates, sendWhenSuppressed, signatureIds, statuses)

Create a Pager Duty Integration

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.IntegrationsPagerDutyApi;


IntegrationsPagerDutyApi apiInstance = new IntegrationsPagerDutyApi();
String apiKey = "apiKey_example"; // String | The API Key for the PagerDuty Integration
List<Integer> externalAccountIds = Arrays.asList(56); // List<Integer> | External accounts for integration
String name = "name_example"; // String | Name of the integration
String include = "include_example"; // String | Related objects that can be included in the response:  integration See Including Objects for more information.
Boolean allHighRisk = true; // Boolean | Send all high risk alerts
Boolean allLowRisk = true; // Boolean | Send all low risk alerts
Boolean allMediumRisk = true; // Boolean | Send all medium risk alerts
List<Integer> customSignatureIds = Arrays.asList(56); // List<Integer> | Custom signatures for integration
Boolean sendUpdates = true; // Boolean | This feature enables the integration to send alerts when they are updated. When disabled, alerts will only be sent when they are initially created. When enabled, alerts will additionally be sent when a change is made such as the alert ending. An alert may end for multiple reasons.
Boolean sendWhenSuppressed = true; // Boolean | Send notifications for suppressed alerts
List<Integer> signatureIds = Arrays.asList(56); // List<Integer> | Signatures for integration
List<String> statuses = Arrays.asList("statuses_example"); // List<String> | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info
try {
    IntegrationPagerDuty result = apiInstance.create(apiKey, externalAccountIds, name, include, allHighRisk, allLowRisk, allMediumRisk, customSignatureIds, sendUpdates, sendWhenSuppressed, signatureIds, statuses);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IntegrationsPagerDutyApi#create");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiKey String The API Key for the PagerDuty Integration
externalAccountIds List<Integer> External accounts for integration
name String Name of the integration
include String Related objects that can be included in the response: integration See Including Objects for more information. [optional]
allHighRisk Boolean Send all high risk alerts [optional]
allLowRisk Boolean Send all low risk alerts [optional]
allMediumRisk Boolean Send all medium risk alerts [optional]
customSignatureIds List<Integer> Custom signatures for integration [optional]
sendUpdates Boolean This feature enables the integration to send alerts when they are updated. When disabled, alerts will only be sent when they are initially created. When enabled, alerts will additionally be sent when a change is made such as the alert ending. An alert may end for multiple reasons. [optional]
sendWhenSuppressed Boolean Send notifications for suppressed alerts [optional]
signatureIds List<Integer> Signatures for integration [optional]
statuses List<String> Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info [optional]

Return type

IntegrationPagerDuty

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

show

IntegrationPagerDuty show(integrationId, include)

Show a single Pager Duty Integration

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.IntegrationsPagerDutyApi;


IntegrationsPagerDutyApi apiInstance = new IntegrationsPagerDutyApi();
Integer integrationId = 56; // Integer | The ID of the integration
String include = "include_example"; // String | Related objects that can be included in the response:  integration See Including Objects for more information.
try {
    IntegrationPagerDuty result = apiInstance.show(integrationId, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IntegrationsPagerDutyApi#show");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
integrationId Integer The ID of the integration
include String Related objects that can be included in the response: integration See Including Objects for more information. [optional]

Return type

IntegrationPagerDuty

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

update

IntegrationPagerDuty update(integrationId, include, allHighRisk, allLowRisk, allMediumRisk, apiKey, customSignatureIds, externalAccountIds, name, sendUpdates, sendWhenSuppressed, signatureIds, statuses)

Update a Pager Duty Integration

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.IntegrationsPagerDutyApi;


IntegrationsPagerDutyApi apiInstance = new IntegrationsPagerDutyApi();
Integer integrationId = 56; // Integer | The ID of the integration
String include = "include_example"; // String | Related objects that can be included in the response:  integration See Including Objects for more information.
Boolean allHighRisk = true; // Boolean | Send all high risk alerts
Boolean allLowRisk = true; // Boolean | Send all low risk alerts
Boolean allMediumRisk = true; // Boolean | Send all medium risk alerts
String apiKey = "apiKey_example"; // String | The API Key for the PagerDuty Integration
List<Integer> customSignatureIds = Arrays.asList(56); // List<Integer> | Custom signatures for integration
List<Integer> externalAccountIds = Arrays.asList(56); // List<Integer> | External accounts for integration
String name = "name_example"; // String | Name of the integration
Boolean sendUpdates = true; // Boolean | This feature enables the integration to send alerts when they are updated. When disabled, alerts will only be sent when they are initially created. When enabled, alerts will additionally be sent when a change is made such as the alert ending. An alert may end for multiple reasons.
Boolean sendWhenSuppressed = true; // Boolean | Send notifications for suppressed alerts
List<Integer> signatureIds = Arrays.asList(56); // List<Integer> | Signatures for integration
List<String> statuses = Arrays.asList("statuses_example"); // List<String> | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info
try {
    IntegrationPagerDuty result = apiInstance.update(integrationId, include, allHighRisk, allLowRisk, allMediumRisk, apiKey, customSignatureIds, externalAccountIds, name, sendUpdates, sendWhenSuppressed, signatureIds, statuses);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IntegrationsPagerDutyApi#update");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
integrationId Integer The ID of the integration
include String Related objects that can be included in the response: integration See Including Objects for more information. [optional]
allHighRisk Boolean Send all high risk alerts [optional]
allLowRisk Boolean Send all low risk alerts [optional]
allMediumRisk Boolean Send all medium risk alerts [optional]
apiKey String The API Key for the PagerDuty Integration [optional]
customSignatureIds List<Integer> Custom signatures for integration [optional]
externalAccountIds List<Integer> External accounts for integration [optional]
name String Name of the integration [optional]
sendUpdates Boolean This feature enables the integration to send alerts when they are updated. When disabled, alerts will only be sent when they are initially created. When enabled, alerts will additionally be sent when a change is made such as the alert ending. An alert may end for multiple reasons. [optional]
sendWhenSuppressed Boolean Send notifications for suppressed alerts [optional]
signatureIds List<Integer> Signatures for integration [optional]
statuses List<String> Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info [optional]

Return type

IntegrationPagerDuty

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json