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

IntegrationsHipchatApi.md

Latest commit

 

History

History
207 lines (155 loc) · 11 KB

IntegrationsHipchatApi.md

File metadata and controls

207 lines (155 loc) · 11 KB

esp_sdk.IntegrationsHipchatApi

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

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

create

IntegrationHipchat create(external_account_ids, name, room, token, 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 Hipchat 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.IntegrationsHipchatApi()
external_account_ids = [56] # list[int] | External accounts for integration
name = 'name_example' # str | Name of the integration
room = 'room_example' # str | The Hipchat room
token = 'token_example' # str | The Hipchat token
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 Hipchat Integration
    api_response = api_instance.create(external_account_ids, name, room, token, 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 IntegrationsHipchatApi->create: %s\n" % e)

Parameters

Name Type Description Notes
external_account_ids list[int] External accounts for integration
name str Name of the integration
room str The Hipchat room
token str The Hipchat token
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

IntegrationHipchat

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

IntegrationHipchat show(integration_id, include=include)

Show a single Hipchat 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.IntegrationsHipchatApi()
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 Hipchat Integration
    api_response = api_instance.show(integration_id, include=include)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationsHipchatApi->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

IntegrationHipchat

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

IntegrationHipchat 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, name=name, room=room, send_updates=send_updates, send_when_suppressed=send_when_suppressed, signature_ids=signature_ids, statuses=statuses, token=token)

Update a Hipchat 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.IntegrationsHipchatApi()
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)
name = 'name_example' # str | Name of the integration (optional)
room = 'room_example' # str | The Hipchat room (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)
token = 'token_example' # str | The Hipchat token (optional)

try: 
    # Update a Hipchat 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, name=name, room=room, send_updates=send_updates, send_when_suppressed=send_when_suppressed, signature_ids=signature_ids, statuses=statuses, token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationsHipchatApi->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]
name str Name of the integration [optional]
room str The Hipchat room [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]
token str The Hipchat token [optional]

Return type

IntegrationHipchat

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]