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

IntegrationsSlackApi.md

Latest commit

 

History

History
194 lines (145 loc) · 9.69 KB

IntegrationsSlackApi.md

File metadata and controls

194 lines (145 loc) · 9.69 KB

IntegrationsSlackApi

All URIs are relative to http://localhost/

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

create

IntegrationSlack create(externalAccountIds, name, url, include, allHighRisk, allLowRisk, allMediumRisk, customSignatureIds, sendUpdates, sendWhenSuppressed, signatureIds, statuses)

Create a Slack Integration

Example

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


IntegrationsSlackApi apiInstance = new IntegrationsSlackApi();
List<Integer> externalAccountIds = Arrays.asList(56); // List<Integer> | External accounts for integration
String name = "name_example"; // String | Name of the integration
String url = "url_example"; // String | The URL for the Slack 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 {
    IntegrationSlack result = apiInstance.create(externalAccountIds, name, url, include, allHighRisk, allLowRisk, allMediumRisk, customSignatureIds, sendUpdates, sendWhenSuppressed, signatureIds, statuses);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IntegrationsSlackApi#create");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountIds List<Integer> External accounts for integration
name String Name of the integration
url String The URL for the Slack 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

IntegrationSlack

Authorization

No authorization required

HTTP request headers

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

show

IntegrationSlack show(integrationId, include)

Show a single Slack Integration

Example

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


IntegrationsSlackApi apiInstance = new IntegrationsSlackApi();
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 {
    IntegrationSlack result = apiInstance.show(integrationId, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IntegrationsSlackApi#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

IntegrationSlack

Authorization

No authorization required

HTTP request headers

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

update

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

Update a Slack Integration

Example

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


IntegrationsSlackApi apiInstance = new IntegrationsSlackApi();
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
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
String url = "url_example"; // String | The URL for the Slack integration
try {
    IntegrationSlack result = apiInstance.update(integrationId, include, allHighRisk, allLowRisk, allMediumRisk, customSignatureIds, externalAccountIds, name, sendUpdates, sendWhenSuppressed, signatureIds, statuses, url);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IntegrationsSlackApi#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]
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]
url String The URL for the Slack integration [optional]

Return type

IntegrationSlack

Authorization

No authorization required

HTTP request headers

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