Skip to content

IntegrationsServiceNowApi.md

Latest commit

 

History

History
215 lines (163 loc) · 12.4 KB

IntegrationsServiceNowApi.md

File metadata and controls

215 lines (163 loc) · 12.4 KB

esp_sdk.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, include=include, all_high_risk=all_high_risk, all_low_risk=all_low_risk, all_medium_risk=all_medium_risk, custom_signature_ids=custom_signature_ids, send_updates=send_updates, send_when_suppressed=send_when_suppressed, signature_ids=signature_ids, statuses=statuses)

Create a ServiceNow Integration

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

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

try: 
    # Create a ServiceNow Integration
    api_response = api_instance.create(external_account_ids, incident_type, instance_url, name, password, username, include=include, all_high_risk=all_high_risk, all_low_risk=all_low_risk, all_medium_risk=all_medium_risk, custom_signature_ids=custom_signature_ids, send_updates=send_updates, send_when_suppressed=send_when_suppressed, signature_ids=signature_ids, statuses=statuses)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationsServiceNowApi->create: %s\n" % e)

Parameters

Name Type Description Notes
external_account_ids list[int] External accounts for integration
incident_type str The password for accessing the ServiceNow instance. Valid values are incident, sn_si_incident
instance_url str The URL for the ServiceNow instance
name str Name of the integration
password str A password to access the JIRA project
username str The username for accessing the ServiceNow instance
include str Related objects that can be included in the response: integration See Including Objects for more information. [optional]
all_high_risk bool Send all high risk alerts [optional]
all_low_risk bool Send all low risk alerts [optional]
all_medium_risk bool Send all medium risk alerts [optional]
custom_signature_ids list[int] Custom signatures for integration [optional]
send_updates bool 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 bool Send notifications for suppressed alerts [optional]
signature_ids list[int] Signatures for integration [optional]
statuses list[str] 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-python#set-your-hmac-security-keys

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

show

IntegrationServicenow show(integration_id, include=include)

Show a single ServiceNow Integration

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.IntegrationsServiceNowApi()
integration_id = 56 # int | The ID of the integration
include = 'include_example' # str | Related objects that can be included in the response:  integration See Including Objects for more information. (optional)

try: 
    # Show a single ServiceNow Integration
    api_response = api_instance.show(integration_id, include=include)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationsServiceNowApi->show: %s\n" % e)

Parameters

Name Type Description Notes
integration_id int The ID of the integration
include str 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-python#set-your-hmac-security-keys

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

IntegrationServicenow update(integration_id, include=include, all_high_risk=all_high_risk, all_low_risk=all_low_risk, all_medium_risk=all_medium_risk, custom_signature_ids=custom_signature_ids, external_account_ids=external_account_ids, incident_type=incident_type, instance_url=instance_url, name=name, password=password, send_updates=send_updates, send_when_suppressed=send_when_suppressed, signature_ids=signature_ids, statuses=statuses, username=username)

Update a ServiceNow Integration

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.IntegrationsServiceNowApi()
integration_id = 56 # int | The ID of the integration
include = 'include_example' # str | Related objects that can be included in the response:  integration See Including Objects for more information. (optional)
all_high_risk = true # bool | Send all high risk alerts (optional)
all_low_risk = true # bool | Send all low risk alerts (optional)
all_medium_risk = true # bool | Send all medium risk alerts (optional)
custom_signature_ids = [56] # list[int] | Custom signatures for integration (optional)
external_account_ids = [56] # list[int] | External accounts for integration (optional)
incident_type = 'incident_type_example' # str | The password for accessing the ServiceNow instance. Valid values are incident, sn_si_incident (optional)
instance_url = 'instance_url_example' # str | The URL for the ServiceNow instance (optional)
name = 'name_example' # str | Name of the integration (optional)
password = 'password_example' # str | A password to access the JIRA project (optional)
send_updates = true # bool | 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 = true # bool | Send notifications for suppressed alerts (optional)
signature_ids = [56] # list[int] | Signatures for integration (optional)
statuses = ['statuses_example'] # list[str] | Only send alerts that have the status in this list. Valid values are fail, warn, error, pass, info (optional)
username = 'username_example' # str | The username for accessing the ServiceNow instance (optional)

try: 
    # Update a ServiceNow Integration
    api_response = api_instance.update(integration_id, include=include, all_high_risk=all_high_risk, all_low_risk=all_low_risk, all_medium_risk=all_medium_risk, custom_signature_ids=custom_signature_ids, external_account_ids=external_account_ids, incident_type=incident_type, instance_url=instance_url, name=name, password=password, send_updates=send_updates, send_when_suppressed=send_when_suppressed, signature_ids=signature_ids, statuses=statuses, username=username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationsServiceNowApi->update: %s\n" % e)

Parameters

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

Return type

IntegrationServicenow

Authorization

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

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]