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

IntegrationsServiceNowApi.md

Latest commit

 

History

History
223 lines (157 loc) · 10.2 KB

IntegrationsServiceNowApi.md

File metadata and controls

223 lines (157 loc) · 10.2 KB

ESP::IntegrationsServiceNowApi

All URIs are relative to https://api.evident.io

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

create

IntegrationServicenow create(external_account_ids, incident_type, instance_url, name, password, username, opts)

Create a ServiceNow Integration

Example

# load the gem
require 'esp_sdk'

api_instance = ESP::IntegrationsServiceNowApi.new

external_account_ids = [56] # Array<Integer> | External accounts for integration

incident_type = "incident_type_example" # String | The password for accessing the ServiceNow instance. Valid values are incident, sn_si_incident

instance_url = "instance_url_example" # String | The URL for the ServiceNow instance

name = "name_example" # String | Name of the integration

password = "password_example" # String | A password to access the JIRA project

username = "username_example" # String | The username for accessing the ServiceNow instance

opts = { 
  include: "include_example", # String | Related objects that can be included in the response:  integration See Including Objects for more information.
  all_high_risk: true, # BOOLEAN | Send all high risk alerts
  all_low_risk: true, # BOOLEAN | Send all low risk alerts
  all_medium_risk: true, # BOOLEAN | Send all medium risk alerts
  custom_signature_ids: [56], # Array<Integer> | Custom signatures for integration
  send_updates: 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.
  send_when_suppressed: true, # BOOLEAN | Send notifications for suppressed alerts
  signature_ids: [56], # Array<Integer> | Signatures for integration
  statuses: ["statuses_example"] # Array<String> | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info
}

begin
  #Create a ServiceNow Integration
  result = api_instance.create(external_account_ids, incident_type, instance_url, name, password, username, opts)
  p result
rescue ESP::ApiError => e
  puts "Exception when calling IntegrationsServiceNowApi->create: #{e}"
end

Parameters

Name Type Description Notes
external_account_ids Array<Integer> External accounts for integration
incident_type String The password for accessing the ServiceNow instance. Valid values are incident, sn_si_incident
instance_url String The URL for the ServiceNow instance
name String Name of the integration
password String A password to access the JIRA project
username String The username for accessing the ServiceNow instance
include String Related objects that can be included in the response: integration See Including Objects for more information. [optional]
all_high_risk BOOLEAN Send all high risk alerts [optional]
all_low_risk BOOLEAN Send all low risk alerts [optional]
all_medium_risk BOOLEAN Send all medium risk alerts [optional]
custom_signature_ids Array<Integer> Custom signatures for integration [optional]
send_updates 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]
send_when_suppressed BOOLEAN Send notifications for suppressed alerts [optional]
signature_ids Array<Integer> Signatures for integration [optional]
statuses Array<String> Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info [optional]

Return type

IntegrationServicenow

Authorization

See https://github.com/EvidentSecurity/esp-sdk-ruby#set-your-hmac-security-keys

HTTP request headers

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

show

IntegrationServicenow show(integration_id, opts)

Show a single ServiceNow Integration

Example

# load the gem
require 'esp_sdk'

api_instance = ESP::IntegrationsServiceNowApi.new

integration_id = 56 # Integer | The ID of the integration

opts = { 
  include: "include_example" # String | Related objects that can be included in the response:  integration See Including Objects for more information.
}

begin
  #Show a single ServiceNow Integration
  result = api_instance.show(integration_id, opts)
  p result
rescue ESP::ApiError => e
  puts "Exception when calling IntegrationsServiceNowApi->show: #{e}"
end

Parameters

Name Type Description Notes
integration_id 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

IntegrationServicenow

Authorization

See https://github.com/EvidentSecurity/esp-sdk-ruby#set-your-hmac-security-keys

HTTP request headers

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

update

IntegrationServicenow update(integration_id, opts)

Update a ServiceNow Integration

Example

# load the gem
require 'esp_sdk'

api_instance = ESP::IntegrationsServiceNowApi.new

integration_id = 56 # Integer | The ID of the integration

opts = { 
  include: "include_example", # String | Related objects that can be included in the response:  integration See Including Objects for more information.
  all_high_risk: true, # BOOLEAN | Send all high risk alerts
  all_low_risk: true, # BOOLEAN | Send all low risk alerts
  all_medium_risk: true, # BOOLEAN | Send all medium risk alerts
  custom_signature_ids: [56], # Array<Integer> | Custom signatures for integration
  external_account_ids: [56], # Array<Integer> | External accounts for integration
  incident_type: "incident_type_example", # String | The password for accessing the ServiceNow instance. Valid values are incident, sn_si_incident
  instance_url: "instance_url_example", # String | The URL for the ServiceNow instance
  name: "name_example", # String | Name of the integration
  password: "password_example", # String | A password to access the JIRA project
  send_updates: 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.
  send_when_suppressed: true, # BOOLEAN | Send notifications for suppressed alerts
  signature_ids: [56], # Array<Integer> | Signatures for integration
  statuses: ["statuses_example"], # Array<String> | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info
  username: "username_example" # String | The username for accessing the ServiceNow instance
}

begin
  #Update a ServiceNow Integration
  result = api_instance.update(integration_id, opts)
  p result
rescue ESP::ApiError => e
  puts "Exception when calling IntegrationsServiceNowApi->update: #{e}"
end

Parameters

Name Type Description Notes
integration_id 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]
all_high_risk BOOLEAN Send all high risk alerts [optional]
all_low_risk BOOLEAN Send all low risk alerts [optional]
all_medium_risk BOOLEAN Send all medium risk alerts [optional]
custom_signature_ids Array<Integer> Custom signatures for integration [optional]
external_account_ids Array<Integer> External accounts for integration [optional]
incident_type String The password for accessing the ServiceNow instance. Valid values are incident, sn_si_incident [optional]
instance_url String The URL for the ServiceNow instance [optional]
name String Name of the integration [optional]
password String A password to access the JIRA project [optional]
send_updates 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]
send_when_suppressed BOOLEAN Send notifications for suppressed alerts [optional]
signature_ids Array<Integer> Signatures for integration [optional]
statuses Array<String> Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info [optional]
username String The username for accessing the ServiceNow instance [optional]

Return type

IntegrationServicenow

Authorization

See https://github.com/EvidentSecurity/esp-sdk-ruby#set-your-hmac-security-keys

HTTP request headers

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