All URIs are relative to https://api.evident.io
| Method | HTTP request | Description |
|---|---|---|
| create | POST /api/v2/integrations/jira.json_api | Create a JIRA Integration |
| show | GET /api/v2/integrations/{integration_id}/jira.json_api | Show a single Jira Integration |
| update | PATCH /api/v2/integrations/{integration_id}/jira.json_api | Update a JIRA Integration |
IntegrationJira create(external_account_ids, issue_type, name, password, project_key, url, 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 JIRA Integration
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.IntegrationsJiraApi()
external_account_ids = [56] # list[int] | External accounts for integration
issue_type = 'issue_type_example' # str | The Issue Type for ESP Alerts
name = 'name_example' # str | Name of the integration
password = 'password_example' # str | A password to access the JIRA project
project_key = 'project_key_example' # str | The designated Key for your Jira project
url = 'url_example' # str | The host and port portion of the Jira REST API URL
username = 'username_example' # str | A username to access the Jira project
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 JIRA Integration
api_response = api_instance.create(external_account_ids, issue_type, name, password, project_key, url, 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 IntegrationsJiraApi->create: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| external_account_ids | list[int] | External accounts for integration | |
| issue_type | str | The Issue Type for ESP Alerts | |
| name | str | Name of the integration | |
| password | str | A password to access the JIRA project | |
| project_key | str | The designated Key for your Jira project | |
| url | str | The host and port portion of the Jira REST API URL | |
| username | str | A username to access the Jira project | |
| 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] |
See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys
- 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]
IntegrationJira show(integration_id, include=include)
Show a single Jira Integration
Password is not returned.
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.IntegrationsJiraApi()
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 Jira Integration
api_response = api_instance.show(integration_id, include=include)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsJiraApi->show: %s\n" % e)| 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] |
See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys
- 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]
IntegrationJira 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, issue_type=issue_type, name=name, password=password, project_key=project_key, send_updates=send_updates, send_when_suppressed=send_when_suppressed, signature_ids=signature_ids, statuses=statuses, url=url, username=username)
Update a JIRA Integration
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.IntegrationsJiraApi()
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)
issue_type = 'issue_type_example' # str | The Issue Type for ESP Alerts (optional)
name = 'name_example' # str | Name of the integration (optional)
password = 'password_example' # str | A password to access the JIRA project (optional)
project_key = 'project_key_example' # str | The designated Key for your 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)
url = 'url_example' # str | The host and port portion of the Jira REST API URL (optional)
username = 'username_example' # str | A username to access the Jira project (optional)
try:
# Update a JIRA 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, issue_type=issue_type, name=name, password=password, project_key=project_key, send_updates=send_updates, send_when_suppressed=send_when_suppressed, signature_ids=signature_ids, statuses=statuses, url=url, username=username)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsJiraApi->update: %s\n" % e)| 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] |
| issue_type | str | The Issue Type for ESP Alerts | [optional] |
| name | str | Name of the integration | [optional] |
| password | str | A password to access the JIRA project | [optional] |
| project_key | str | The designated Key for your 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] |
| url | str | The host and port portion of the Jira REST API URL | [optional] |
| username | str | A username to access the Jira project | [optional] |
See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys
- 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]