Skip to main content

OpsGenie v3

This Integration is part of the OpsGenie Pack.#

Supported versions

Supported Cortex XSOAR versions: 6.2.0 and later.

Integration with Atlassian OpsGenie. OpsGenie is a cloud-based service that enables operations teams to manage alerts generated by monitoring tools to ensure the right people are notified, and the problems are addressed in a timely manner. This integration was integrated and tested with OpsGenie.

Some changes have been made that might affect your existing content. If you are upgrading from a previous of this integration, see Breaking Changes.

Configure OpsGenie v3 on Cortex XSOAR#

  1. Navigate to Settings > Integrations > Servers & Services.

  2. Search for OpsGenie v3.

  3. Click Add instance to create and configure a new integration instance.

    ParameterDescriptionRequired
    Server URL (e.g., https://api.opsgenie.com)True
    API TokenFalse
    Fetch incidentsFalse
    First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)False
    Max FetchFalse
    Event typesFetch only events with selected event types.False
    StatusFetch only events with selected status. If query is used, this parameter will be overridden.False
    PriorityFetch only events with selected priority. If query is used, this parameter will be overridden.False
    TagsFetch only events with selected tags. If query is used, this parameter will be overridden.False
    QueryQuery parameters will be used as URL encoded values for “query” key. i.e. 'https://api.opsgenie.com/v2/alerts?query=status%3Aopenor%20acknowledged%3Atrue&amp;limit=10&amp;sort=createdAt'False
    Incident typeFalse
    Trust any certificate (not secure)False
    Use system proxy settingsFalse
  4. Click Test to validate the URLs, token, and connection.

Commands#

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

opsgenie-create-alert#


Create an alert in Opsgenie.

Base Command#

opsgenie-create-alert

Input#

Argument NameDescriptionRequired
messageAlert message.Required
aliasClient-defined identifier of the alert.Optional
descriptionDescription field of the alert that is generally used to provide detailed information about the alert.Optional
respondersTeams/users to whom the alert is routed via notifications.
You need to insert it as List of triples - responder_type,value_type,value.
The responder_type can be: team, user, escalation or schedule.
The value_type can be: id or name.
You can retrieve the value from the output of the following commands '!opsgenie-get-teams', '!opsgenie-get-schedules' or '!opsgenie-get-escalations'.
For example: schedule,name,test_schedule,user,id,123,team,name,test_team.
Optional
tagsComma-separated list of tags to add.Optional
priorityIncident priority. Possible values are: P1, P2, P3, P4, P5. Default is P3.Optional
sourceDisplay name of the request source. Defaults to IP address of the request sender.Optional
noteAdditional alert note.Optional

Context Output#

PathTypeDescription
OpsGenie.Alert.actionStringAction of this request.
OpsGenie.Alert.alertIdStringID of the created alert.
OpsGenie.Alert.aliasStringAlias of the created alert.
OpsGenie.Alert.integrationIdStringIntegration ID of the created alert.
OpsGenie.Alert.isSuccessBooleanWhether the request was successful.
OpsGenie.Alert.processedAtDateWhen the request was processed.
OpsGenie.Alert.requestIdStringThe ID of the request.
OpsGenie.Alert.statusStringThe human readable result of the request.
OpsGenie.Alert.successBooleanWhether the request was successful.

Command Example#

!opsgenie-create-alert message="Example Message"

Context Example#

{
"OpsGenie": {
"Alert": {
"action": "Create",
"alertId": "4c4623e3-0b3f-47b7-becd-907d3e51d129-1638366498716",
"alias": "4c4623e3-0b3f-47b7-becd-907d3e51d129-1638366498716",
"integrationId": "3cc69931-167f-411c-a331-768997c29d2e",
"isSuccess": true,
"processedAt": "2021-12-01T13:48:18.757Z",
"status": "Created alert",
"success": true
}
}
}

Human Readable Output#

OpsGenie#

actionalertIdaliasintegrationIdisSuccessprocessedAtstatussuccess
Create4c4623e3-0b3f-47b7-becd-907d3e51d129-16383664987164c4623e3-0b3f-47b7-becd-907d3e51d129-16383664987163cc69931-167f-411c-a331-768997c29d2etrue2021-12-01T13:48:18.757ZCreated alerttrue

opsgenie-get-alerts#


List the current alerts from OpsGenie.

Base Command#

opsgenie-get-alerts

Input#

Argument NameDescriptionRequired
alert-idThe ID of the alert from Opsgenie.Optional
sortName of the field that the result set will be sorted by.
The options are: createdAt, updatedAt, tinyId, alias, message, status, acknowledged, isSeen snoozed, snoozedUntil, count, lastOccurredAt, source, owner, integration.name, integration.type, report.ackTime, report.closeTime, report.acknowledgedBy, report.closedBy.
Optional
limitMaximum results to return. Default is 20.Optional
offsetStart index of the result set (to apply pagination). Minimum value is 0. Default is 0.Optional
statusThe status of the alert from Opsgenie. Possible values are: Open, Closed.Optional
priorityThe priority of the alert from Opsgenie. Possible values are: P1, P2, P3, P4, P5. Default is P3.Optional
tagsComma-separated list of tags.Optional
queryURL encoded query parameters.Optional
request_idID of the polling request. No need to enter a value.Optional
pagingThe next URL to request. No need to enter a value.Optional
resultResult of the previous command. No need to enter a value.Optional

Context Output#

PathTypeDescription
OpsGenie.Alert.acknowledgedBooleanWhether the alert was acknowledge.
OpsGenie.Alert.aliasStringAlert alias.
OpsGenie.Alert.countNumberNumber of alert occurrences.
OpsGenie.Alert.createdAtDateTime the alert was created.
OpsGenie.Alert.idStringID of the alert.
OpsGenie.Alert.integration.idStringID of the integration.
OpsGenie.Alert.integration.nameStringIntegration name.
OpsGenie.Alert.integration.typeStringType of the integration.
OpsGenie.Alert.isSeenBooleanWhether the alert was seen.
OpsGenie.Alert.lastOccurredAtDateTime the alert last occurred.
OpsGenie.Alert.messageStringAlert message.
OpsGenie.Alert.ownerStringOwner of the alert.
OpsGenie.Alert.ownerTeamIdStringTeam ID of the owner.
OpsGenie.Alert.priorityStringAlert priority.
OpsGenie.Alert.responders.idStringID of the responders.
OpsGenie.Alert.responders.typeStringType of the responders.
OpsGenie.Alert.seenBooleanWhether the alert was seen.
OpsGenie.Alert.snoozedBooleanWhether alert was snoozed.
OpsGenie.Alert.sourceStringSource of the alert.
OpsGenie.Alert.statusStringStatus of the alert.
OpsGenie.Alert.teams.idStringID of the teams associated with the alert.
OpsGenie.Alert.tinyIdStringShort ID for the alert.
OpsGenie.Alert.updatedAtDateLast time the alert was updated.
OpsGenie.Alert.report.ackTimeNumberTime the alert was acknowledged.
OpsGenie.Alert.report.acknowledgedByStringUser who acknowledged the alert.
OpsGenie.Alert.report.closeTimeNumberTime the alert was closed.
OpsGenie.Alert.report.closedByStringUser who closed the alert.

Command Example#

!opsgenie-get-alerts limit=1

Context Example#

{
"OpsGenie": {
"Alert": [
{
"acknowledged": false,
"alias": "4c4623e3-0b3f-47b7-becd-907d3e51d129-1638366498716",
"count": 1,
"createdAt": "2021-12-01T13:48:18.716Z",
"event_type": "Alerts",
"id": "4c4623e3-0b3f-47b7-becd-907d3e51d129-1638366498716",
"integration": {
"id": "3cc69931-167f-411c-a331-768997c29d2e",
"name": "API",
"type": "API"
},
"isSeen": false,
"lastOccurredAt": "2021-12-01T13:48:18.716Z",
"message": "Example Message",
"owner": "",
"ownerTeamId": "",
"priority": "P3",
"responders": [],
"seen": false,
"snoozed": false,
"source": "192.168.x.x",
"status": "open",
"tags": [],
"teams": [],
"tinyId": "194",
"updatedAt": "2021-12-01T13:48:18.787Z"
}
]
}
}

Human Readable Output#

OpsGenie#

idcreatedAtacknowledgedcountstatus
4c4623e3-0b3f-47b7-becd-907d3e51d129-16383664987162021-12-01T13:48:18.716Zfalse1open

opsgenie-delete-alert#


Delete an alert from OpsGenie.

Base Command#

opsgenie-delete-alert

Input#

Argument NameDescriptionRequired
alert-idThe ID of the alert from Opsgenie.Required

Context Output#

PathTypeDescription
OpsGenie.DeletedAlert.actionStringAction of this request.
OpsGenie.DeletedAlert.alertIdStringID of the deleted alert.
OpsGenie.DeletedAlert.aliasStringAlias of the deleted alert.
OpsGenie.DeletedAlert.integrationIdStringIntegration of the deleted alert.
OpsGenie.DeletedAlert.isSuccessBooleanWhether the request was successful.
OpsGenie.DeletedAlert.processedAtDateWhen the request was processed.
OpsGenie.DeletedAlert.requestIdStringThe ID of the request.
OpsGenie.DeletedAlert.statusStringThe human readable result of the request.
OpsGenie.DeletedAlert.successBooleanWhether the request was successful.

Command Example#

!opsgenie-delete-alert alert-id=69df59c2-41c6-4866-8c03-65c1ecf5417d-1636973048286

Context Example#

{
"OpsGenie": {
"DeletedAlert": {
"action": "Delete",
"alertId": "",
"alias": "",
"integrationId": "3cc69931-167f-411c-a331-768997c29d2e",
"isSuccess": false,
"processedAt": "2021-12-01T13:48:40.911Z",
"status": "Alert does not exist",
"success": false
}
}
}

Human Readable Output#

OpsGenie#

actionalertIdaliasintegrationIdisSuccessprocessedAtstatussuccess
Delete3cc69931-167f-411c-a331-768997c29d2efalse2021-12-01T13:48:40.911ZAlert does not existfalse

opsgenie-ack-alert#


Acknowledge an alert in OpsGenie.

Base Command#

opsgenie-ack-alert

Input#

Argument NameDescriptionRequired
alert-idThe ID of the alert from Opsgenie.Required
noteAdditional alert note.Optional

Context Output#

PathTypeDescription
OpsGenie.AckedAlert.actionStringAction of this request.
OpsGenie.AckedAlert.alertIdStringID of the acknowledged alert.
OpsGenie.AckedAlert.aliasStringAlias of the acknowledged alert.
OpsGenie.AckedAlert.integrationIdStringIntegration of the acknowledged alert.
OpsGenie.AckedAlert.isSuccessBooleanWhether the request was successful.
OpsGenie.AckedAlert.processedAtDateWhen the request was processed.
OpsGenie.AckedAlert.requestIdStringThe ID of the request.
OpsGenie.AckedAlert.statusStringThe human readable result of the request.
OpsGenie.AckedAlert.successBooleanWhether the request was successful.

Command Example#

!opsgenie-ack-alert alert-id=69df59c2-41c6-4866-8c03-65c1ecf5417d-1636973048286

Context Example#

{
"OpsGenie": {
"AckedAlert": {
"action": "Acknowledge",
"alertId": "",
"alias": "",
"integrationId": "3cc69931-167f-411c-a331-768997c29d2e",
"isSuccess": false,
"processedAt": "2021-12-01T13:48:23.374Z",
"status": "Alert does not exist",
"success": false
}
}
}

Human Readable Output#

OpsGenie#

actionalertIdaliasintegrationIdisSuccessprocessedAtstatussuccess
Acknowledge3cc69931-167f-411c-a331-768997c29d2efalse2021-12-01T13:48:23.374ZAlert does not existfalse

opsgenie-close-alert#


Close an alert in OpsGenie.

Base Command#

opsgenie-close-alert

Input#

Argument NameDescriptionRequired
alert-idThe ID of the alert from Opsgenie.Required
noteAdditional alert note.Optional

Context Output#

PathTypeDescription
OpsGenie.ClosedAlert.actionStringAction of this request.
OpsGenie.ClosedAlert.alertIdStringID of the closed alert.
OpsGenie.ClosedAlert.aliasStringAlias of the closed alert.
OpsGenie.ClosedAlert.integrationIdStringIntegration ID of the acknowledged alert.
OpsGenie.ClosedAlert.isSuccessBooleanWhether the request was successful.
OpsGenie.ClosedAlert.processedAtDateWhen the request was processed.
OpsGenie.ClosedAlert.requestIdStringThe ID of the request.
OpsGenie.ClosedAlert.statusStringThe human readable result of the request.
OpsGenie.ClosedAlert.successBooleanWhether the request was successful.

Command Example#

!opsgenie-close-alert alert-id=69df59c2-41c6-4866-8c03-65c1ecf5417d-1636973048286

Context Example#

{
"OpsGenie": {
"ClosedAlert": {
"action": "Close",
"alertId": "",
"alias": "",
"integrationId": "3cc69931-167f-411c-a331-768997c29d2e",
"isSuccess": false,
"processedAt": "2021-12-01T13:48:38.491Z",
"status": "Alert does not exist",
"success": false
}
}
}

Human Readable Output#

OpsGenie#

actionalertIdaliasintegrationIdisSuccessprocessedAtstatussuccess
Close3cc69931-167f-411c-a331-768997c29d2efalse2021-12-01T13:48:38.491ZAlert does not existfalse

opsgenie-assign-alert#


Assign an OpsGenie alert.

Base Command#

opsgenie-assign-alert

Input#

Argument NameDescriptionRequired
alert-idID of the Opsgenie alert.Required
owner_idID of the user to whom the alert will be assigned. Not required if owner_username is present.Optional
owner_usernameDisplay name of the request owner. Not required if owner_id is present.Optional
noteAdditional alert note.Optional

Context Output#

PathTypeDescription
OpsGenie.AssignAlert.actionStringAction of this request.
OpsGenie.AssignAlert.alertIdStringID of assigned Alert
OpsGenie.AssignAlert.aliasStringAlias of the assigned alert.
OpsGenie.AssignAlert.integrationIdStringIntegration ID of the assigned alert.
OpsGenie.AssignAlert.isSuccessBooleanWhether the request was successful.
OpsGenie.AssignAlert.processedAtDateWhen the request was processed.
OpsGenie.AssignAlert.requestIdStringThe ID of the request.
OpsGenie.AssignAlert.statusStringThe human readable result of the request.
OpsGenie.AssignAlert.successBooleanWhether the request was successful.

Command Example#

!opsgenie-assign-alert alert-id=69df59c2-41c6-4866-8c03-65c1ecf5417d-1636973048286 owner_username=b@g.com

Context Example#

{
"OpsGenie": {
"AssignAlert": {
"action": "Assign",
"alertId": "",
"alias": "",
"integrationId": "3cc69931-167f-411c-a331-768997c29d2e",
"isSuccess": false,
"processedAt": "2021-12-01T13:48:24.942Z",
"status": "Alert does not exist",
"success": false
}
}
}

Human Readable Output#

OpsGenie#

actionalertIdaliasintegrationIdisSuccessprocessedAtstatussuccess
Assign3cc69931-167f-411c-a331-768997c29d2efalse2021-12-01T13:48:24.942ZAlert does not existfalse

opsgenie-add-responder-alert#


Add a responder to an OpsGenie alert.

Base Command#

opsgenie-add-responder-alert

Input#

Argument NameDescriptionRequired
alert-idID of the Opsgenie alert.Required
identifierTypeType of the identifier. Possible values are: id, tiny, alias.Optional
respondersTeam/user to whom the alert is routed via notifications.
For now, it can be inserted only one responder at a time.
You need to insert it as List of triple - responder_type,value_type,value.
The responder_type can be: team or user.
The value_type can be: id or name.
You can retrieve the value from the output of the following '!opsgenie-get-teams' command.
For example: user,id,123 Another example: team,name,test_team.
Required
noteAdditional alert note.Optional

Context Output#

PathTypeDescription
OpsGenie.AddResponderAlert.actionStringAction of this request.
OpsGenie.AddResponderAlert.alertIdStringID of the created alert.
OpsGenie.AddResponderAlert.aliasStringAlias of the created alert.
OpsGenie.AddResponderAlert.integrationIdStringIntegration ID of the created alert.
OpsGenie.AddResponderAlert.isSuccessBooleanWhether the request was successful.
OpsGenie.AddResponderAlert.processedAtDateWhen the request was processed.
OpsGenie.AddResponderAlert.requestIdStringThe ID of the request.
OpsGenie.AddResponderAlert.statusStringThe human readable result of the request.
OpsGenie.AddResponderAlert.successBooleanWhether the request was successful.

Command Example#

!opsgenie-add-responder-alert alert-id=69df59c2-41c6-4866-8c03-65c1ecf5417d-1636973048286 responders=schedule,name,test_schedule

Context Example#

{
"OpsGenie": {
"AddResponderAlert": {
"action": "Add Responder",
"alertId": "",
"alias": "",
"integrationId": "3cc69931-167f-411c-a331-768997c29d2e",
"isSuccess": false,
"processedAt": "2021-12-01T13:48:26.82Z",
"status": "Alert does not exist",
"success": false
}
}
}

Human Readable Output#

OpsGenie#

actionalertIdaliasintegrationIdisSuccessprocessedAtstatussuccess
Add Responder3cc69931-167f-411c-a331-768997c29d2efalse2021-12-01T13:48:26.82ZAlert does not existfalse

opsgenie-get-escalations#


Get escalations from OpsGenie.

Base Command#

opsgenie-get-escalations

Input#

Argument NameDescriptionRequired
escalation_idID of the escalation.Optional
escalation_nameName of the escalation.Optional

Context Output#

PathTypeDescription
OpsGenie.Escalation.actionStringAction of this request.
OpsGenie.Escalation.IdStringID of the escalation.
OpsGenie.Escalation.nameStringName of the escalation.
OpsGenie.Escalation.descriptionStringDescription of the escalation.
OpsGenie.Escalation.ownerTeamStringOwner team of the escalation.
OpsGenie.Escalation.rulesStringRules of the escalation.
OpsGenie.Escalation.integrationIdStringIntegration ID of the escalated alert.
OpsGenie.Escalation.isSuccessBooleanWhether the request was successful.
OpsGenie.Escalation.processedAtDateWhen the request was processed.
OpsGenie.Escalation.requestIdStringThe ID of the request.
OpsGenie.Escalation.statusStringThe human readable result of the request.
OpsGenie.Escalation.successBooleanWhether the request was successful.

Command Example#

!opsgenie-get-escalations

Context Example#

{
"OpsGenie": {
"Escalations": [
{
"description": "",
"id": "9a441a8d-2410-43f4-9ef2-f7a265e12b74",
"name": "Engineering_escalation",
"ownerTeam": {
"id": "51d69df8-c40b-439e-9808-e1a78e54f91b",
"name": "Engineering"
},
"rules": [
{
"condition": "if-not-acked",
"delay": {
"timeAmount": 0,
"timeUnit": "minutes"
},
"notifyType": "default",
"recipient": {
"id": "7835aa84-7440-41d5-90bf-92e0045714d5",
"name": "Engineering_schedule",
"type": "schedule"
}
},
{
"condition": "if-not-acked",
"delay": {
"timeAmount": 5,
"timeUnit": "minutes"
},
"notifyType": "next",
"recipient": {
"id": "7835aa84-7440-41d5-90bf-92e0045714d5",
"name": "Engineering_schedule",
"type": "schedule"
}
},
{
"condition": "if-not-acked",
"delay": {
"timeAmount": 10,
"timeUnit": "minutes"
},
"notifyType": "all",
"recipient": {
"id": "51d69df8-c40b-439e-9808-e1a78e54f91b",
"name": "Engineering",
"type": "team"
}
}
]
},
{
"description": "",
"id": "c8a0f950-577c-4da5-894b-1fd463d9f51c",
"name": "Integration Team_escalation",
"ownerTeam": {
"id": "fbbc3f9a-12f4-4794-9938-7e0a85a06f8b",
"name": "Integration Team"
},
"rules": [
{
"condition": "if-not-acked",
"delay": {
"timeAmount": 0,
"timeUnit": "minutes"
},
"notifyType": "default",
"recipient": {
"id": "df918339-b999-4878-b69b-3c2c0d508b01",
"name": "Integration Team_schedule",
"type": "schedule"
}
},
{
"condition": "if-not-acked",
"delay": {
"timeAmount": 1,
"timeUnit": "minutes"
},
"notifyType": "default",
"recipient": {
"id": "154d6425-c120-4beb-a3e6-a66c8c44f61d",
"type": "user",
"username": "dvilenchik@paloaltonetworks.com"
}
},
{
"condition": "if-not-acked",
"delay": {
"timeAmount": 5,
"timeUnit": "minutes"
},
"notifyType": "next",
"recipient": {
"id": "df918339-b999-4878-b69b-3c2c0d508b01",
"name": "Integration Team_schedule",
"type": "schedule"
}
},
{
"condition": "if-not-acked",
"delay": {
"timeAmount": 10,
"timeUnit": "minutes"
},
"notifyType": "all",
"recipient": {
"id": "fbbc3f9a-12f4-4794-9938-7e0a85a06f8b",
"name": "Integration Team",
"type": "team"
}
}
]
}
]
}
}

Human Readable Output#

OpsGenie Escalations#

descriptionidnameownerTeamrules
9a441a8d-2410-43f4-9ef2-f7a265e12b74Engineering_escalationid: 51d69df8-c40b-439e-9808-e1a78e54f91b
name: Engineering
{'condition': 'if-not-acked', 'notifyType': 'default', 'delay': {'timeAmount': 0, 'timeUnit': 'minutes'}, 'recipient': {'type': 'schedule', 'id': '7835aa84-7440-41d5-90bf-92e0045714d5', 'name': 'Engineering_schedule'}},
{'condition': 'if-not-acked', 'notifyType': 'next', 'delay': {'timeAmount': 5, 'timeUnit': 'minutes'}, 'recipient': {'type': 'schedule', 'id': '7835aa84-7440-41d5-90bf-92e0045714d5', 'name': 'Engineering_schedule'}},
{'condition': 'if-not-acked', 'notifyType': 'all', 'delay': {'timeAmount': 10, 'timeUnit': 'minutes'}, 'recipient': {'type': 'team', 'id': '51d69df8-c40b-439e-9808-e1a78e54f91b', 'name': 'Engineering'}}
c8a0f950-577c-4da5-894b-1fd463d9f51cIntegration Team_escalationid: fbbc3f9a-12f4-4794-9938-7e0a85a06f8b
name: Integration Team
{'condition': 'if-not-acked', 'notifyType': 'default', 'delay': {'timeAmount': 0, 'timeUnit': 'minutes'}, 'recipient': {'type': 'schedule', 'id': 'df918339-b999-4878-b69b-3c2c0d508b01', 'name': 'Integration Team_schedule'}},
{'condition': 'if-not-acked', 'notifyType': 'default', 'delay': {'timeAmount': 1, 'timeUnit': 'minutes'}, 'recipient': {'type': 'user', 'id': '154d6425-c120-4beb-a3e6-a66c8c44f61d', 'username': 'dvilenchik@paloaltonetworks.com'}},
{'condition': 'if-not-acked', 'notifyType': 'next', 'delay': {'timeAmount': 5, 'timeUnit': 'minutes'}, 'recipient': {'type': 'schedule', 'id': 'df918339-b999-4878-b69b-3c2c0d508b01', 'name': 'Integration Team_schedule'}},
{'condition': 'if-not-acked', 'notifyType': 'all', 'delay': {'timeAmount': 10, 'timeUnit': 'minutes'}, 'recipient': {'type': 'team', 'id': 'fbbc3f9a-12f4-4794-9938-7e0a85a06f8b', 'name': 'Integration Team'}}

opsgenie-escalate-alert#


Escalate an OpsGenie alert.

Base Command#

opsgenie-escalate-alert

Input#

Argument NameDescriptionRequired
alert-idID of the Opsgenie alert.Required
escalation_nameName of the escalation to which the alert will be escalated. Provide either the ID or name of the escalation.Optional
escalation_idID of the escalation to which the alert will be escalated. Provide either the ID or name of the escalation.Optional
noteAdditional alert note.Optional

Context Output#

PathTypeDescription
OpsGenie.EscalateAlert.actionStringAction of this request.
OpsGenie.EscalateAlert.idStringID of the escalation.
OpsGenie.EscalateAlert.nameStringName of the escalation.
OpsGenie.EscalateAlert.descriptionStringDescription of the escalation.
OpsGenie.EscalateAlert.integrationIdStringIntegration ID of the escalated alert.
OpsGenie.EscalateAlert.isSuccessBooleanWhether the request was successful.
OpsGenie.EscalateAlert.processedAtDateWhen the request was processed.
OpsGenie.EscalateAlert.requestIdStringThe ID of the request.
OpsGenie.EscalateAlert.statusStringThe human readable result of the request.
OpsGenie.EscalateAlert.successBooleanWhether the request was successful.

Command Example#

!opsgenie-escalate-alert alert-id=69df59c2-41c6-4866-8c03-65c1ecf5417d-1636973048286 escalation_id=9a441a8d-2410-43f4-9ef2-f7a265e12b74

Context Example#

{
"OpsGenie": {
"EscalateAlert": {
"action": "Escalate",
"alertId": "",
"alias": "",
"integrationId": "3cc69931-167f-411c-a331-768997c29d2e",
"isSuccess": false,
"processedAt": "2021-12-01T13:48:31.549Z",
"status": "Alert does not exist",
"success": false
}
}
}

Human Readable Output#

OpsGenie#

actionalertIdaliasintegrationIdisSuccessprocessedAtstatussuccess
Escalate3cc69931-167f-411c-a331-768997c29d2efalse2021-12-01T13:48:31.549ZAlert does not existfalse

opsgenie-add-alert-tag#


Add tag to the OpsGenie alert.

Base Command#

opsgenie-add-alert-tag

Input#

Argument NameDescriptionRequired
alert-idID of the Opsgenie alert.Required
tagsComma-separated list of tags to add to the alert.Required
noteAdditional alert note.Optional

Context Output#

PathTypeDescription
OpsGenie.AddTagAlert.actionStringAction of this request.
OpsGenie.AddTagAlert.alertIdStringID of the added alert.
OpsGenie.AddTagAlert.aliasStringAlias of the added alert.
OpsGenie.AddTagAlert.integrationIdStringIntegration ID of the added alert.
OpsGenie.AddTagAlert.isSuccessBooleanWhether the request was successful.
OpsGenie.AddTagAlert.processedAtDateWhen the request was processed.
OpsGenie.AddTagAlert.requestIdStringThe ID of the request.
OpsGenie.AddTagAlert.statusStringThe human readable result of the request.
OpsGenie.AddTagAlert.successBooleanWhether the request was successful.

Command Example#

!opsgenie-add-alert-tag alert-id=69df59c2-41c6-4866-8c03-65c1ecf5417d-1636973048286 tags=1,2,3

Context Example#

{
"OpsGenie": {
"AddTagAlert": {
"action": "Add Tags",
"alertId": "",
"alias": "",
"integrationId": "3cc69931-167f-411c-a331-768997c29d2e",
"isSuccess": false,
"processedAt": "2021-12-01T13:48:33.376Z",
"status": "Alert does not exist",
"success": false
}
}
}

Human Readable Output#

OpsGenie#

actionalertIdaliasintegrationIdisSuccessprocessedAtstatussuccess
Add Tags3cc69931-167f-411c-a331-768997c29d2efalse2021-12-01T13:48:33.376ZAlert does not existfalse

opsgenie-remove-alert-tag#


Remove a tag from the OpsGenie alert.

Base Command#

opsgenie-remove-alert-tag

Input#

Argument NameDescriptionRequired
alert-idID of the Opsgenie alert.Required
tagsComma-separated list of tags to remove from the alert.Required
noteAdditional alert note.Optional

Context Output#

PathTypeDescription
OpsGenie.RemoveTagAlert.actionStringAction of this request.
OpsGenie.RemoveTagAlert.alertIdStringID of the tag removed from the alert.
OpsGenie.RemoveTagAlert.aliasStringAlias of the removed tag alert.
OpsGenie.RemoveTagAlert.integrationIdStringIntegration ID of the removed tag alert.
OpsGenie.RemoveTagAlert.isSuccessBooleanWhether the request was successful.
OpsGenie.RemoveTagAlert.processedAtDateWhen the request was processed.
OpsGenie.RemoveTagAlert.requestIdStringThe ID of the request.
OpsGenie.RemoveTagAlert.statusStringThe human readable result of the request.
OpsGenie.RemoveTagAlert.successBooleanWhether the request was successful.

Command Example#

!opsgenie-remove-alert-tag alert-id=69df59c2-41c6-4866-8c03-65c1ecf5417d-1636973048286 tags=1,2,3

Context Example#

{
"OpsGenie": {
"RemoveTagAlert": {
"action": "Remove Tags",
"alertId": "",
"alias": "",
"integrationId": "3cc69931-167f-411c-a331-768997c29d2e",
"isSuccess": false,
"processedAt": "2021-12-01T13:48:35.606Z",
"status": "Alert does not exist",
"success": false
}
}
}

Human Readable Output#

OpsGenie#

actionalertIdaliasintegrationIdisSuccessprocessedAtstatussuccess
Remove Tags3cc69931-167f-411c-a331-768997c29d2efalse2021-12-01T13:48:35.606ZAlert does not existfalse

opsgenie-get-alert-attachments#


Get the attachments of the alert.

Base Command#

opsgenie-get-alert-attachments

Input#

Argument NameDescriptionRequired
alert-idID of the Opsgenie alert.Required
attachment_idIdentifier of the attachment.Optional

Context Output#

PathTypeDescription
OpsGenie.Alert.Attachment.actionStringAction of this request.
OpsGenie.Alert.Attachment.alertIdStringID of the alert.
OpsGenie.Alert.Attachment.aliasStringAlias of the alert.
OpsGenie.Alert.Attachment.integrationIdStringIntegration ID the alert.
OpsGenie.Alert.Attachment.isSuccessBooleanWhether the request was successful.
OpsGenie.Alert.Attachment.processedAtDateWhen the request was processed.
OpsGenie.Alert.Attachment.requestIdStringThe ID of the request.
OpsGenie.Alert.Attachment.statusStringThe human readable result of the request.
OpsGenie.Alert.Attachment.successBooleanWhether the request was successful.

Command Example#

Human Readable Output#

opsgenie-get-schedules#


Get a schedule from OpsGenie.

Base Command#

opsgenie-get-schedules

Input#

Argument NameDescriptionRequired
schedule_idID of the schedule.Optional
schedule_nameName of the schedule.Optional

Context Output#

PathTypeDescription
OpsGenie.Schedule.descriptionStringDescription of the schedule.
OpsGenie.Schedule.enabledBooleanWhether the schedule was enabled.
OpsGenie.Schedule.idStringID of the schedule.
OpsGenie.Schedule.nameStringName of the schedule.
OpsGenie.Schedule.ownerTeam.idStringID of the schedule owner.
OpsGenie.Schedule.ownerTeam.nameStringName of the schedule owner.
OpsGenie.Schedule.timezoneStringTimezone of the schedule.

Command Example#

!opsgenie-get-schedules

Context Example#

{
"OpsGenie": {
"Schedule": [
{
"description": "Schedule when escalation was activated",
"enabled": true,
"id": "5892636c-6183-4788-99d6-6d93b9095194",
"name": "Escalation Schedule",
"ownerTeam": {
"id": "fbbc3f9a-12f4-4794-9938-7e0a85a06f8b",
"name": "Integration Team"
},
"rotations": [],
"timezone": "Asia/Jerusalem"
},
{
"description": "",
"enabled": true,
"id": "7835aa84-7440-41d5-90bf-92e0045714d5",
"name": "Engineering_schedule",
"ownerTeam": {
"id": "51d69df8-c40b-439e-9808-e1a78e54f91b",
"name": "Engineering"
},
"rotations": [],
"timezone": "Asia/Jerusalem"
},
{
"description": "24/7 Shift",
"enabled": true,
"id": "df918339-b999-4878-b69b-3c2c0d508b01",
"name": "Integration Team_schedule",
"ownerTeam": {
"id": "fbbc3f9a-12f4-4794-9938-7e0a85a06f8b",
"name": "Integration Team"
},
"rotations": [],
"timezone": "Asia/Jerusalem"
}
]
}
}

Human Readable Output#

OpsGenie Schedule#

descriptionenabledidnameownerTeamrotationstimezone
Schedule when escalation was activatedtrue5892636c-6183-4788-99d6-6d93b9095194Escalation Scheduleid: fbbc3f9a-12f4-4794-9938-7e0a85a06f8b
name: Integration Team
Asia/Jerusalem
true7835aa84-7440-41d5-90bf-92e0045714d5Engineering_scheduleid: 51d69df8-c40b-439e-9808-e1a78e54f91b
name: Engineering
Asia/Jerusalem
24/7 Shifttruedf918339-b999-4878-b69b-3c2c0d508b01Integration Team_scheduleid: fbbc3f9a-12f4-4794-9938-7e0a85a06f8b
name: Integration Team
Asia/Jerusalem

opsgenie-get-schedule-overrides#


Get schedule overrides.

Base Command#

opsgenie-get-schedule-overrides

Input#

Argument NameDescriptionRequired
schedule_idID of the schedule.Optional
schedule_nameName of the schedule.Optional
override_aliasAlias of the schedule override.Optional

Context Output#

PathTypeDescription
OpsGenie.Schedule.Override.actionStringAction of this request.
OpsGenie.Schedule.Override.alertIdStringID of the schedule.
OpsGenie.Schedule.Override.aliasStringAlias of the schedule.
OpsGenie.Schedule.Override.integrationIdStringIntegration ID of the schedule.
OpsGenie.Schedule.Override.isSuccessBooleanWhether the request was successful.
OpsGenie.Schedule.Override.processedAtDateWhen the request was processed.
OpsGenie.Schedule.Override.requestIdStringThe ID of the request.
OpsGenie.Schedule.Override.statusStringThe human readable result of the request.
OpsGenie.Schedule.Override.successBooleanWhether the request was successful.

Command Example#

!opsgenie-get-schedule-overrides schedule_id=5892636c-6183-4788-99d6-6d93b9095194

Human Readable Output#

OpsGenie Schedule#

No entries.

opsgenie-get-on-call#


Get the on-call users for the provided schedule.

Base Command#

opsgenie-get-on-call

Input#

Argument NameDescriptionRequired
schedule_idSchedule ID from which to return on-call users.Optional
schedule_nameName of the schedule from which to return on-call users.Optional
starting_dateStart date of the timeline in the following format (yyyy-MM-dd'T'HH:mm:ssZ).Optional

Context Output#

PathTypeDescription
OpsGenie.Schedule.OnCall._parent.enabledBooleanWhether this on-call schedule is enabled.
OpsGenie.Schedule.OnCall._parent.idStringID Of the parent on-call schedule.
OpsGenie.Schedule.OnCall._parent.nameStringName of parent on-call schedule.
OpsGenie.Schedule.OnCall.onCallParticipants.idStringID of the on-call participant.
OpsGenie.Schedule.OnCall.onCallParticipants.nameStringName of the on-call participant.
OpsGenie.Schedule.OnCall.onCallParticipants.typeStringType of the on-call participant.

Command Example#

!opsgenie-get-on-call schedule_id=5892636c-6183-4788-99d6-6d93b9095194

Context Example#

{
"OpsGenie": {
"Schedule": {
"OnCall": {
"data": {
"_parent": {
"enabled": true,
"id": "5892636c-6183-4788-99d6-6d93b9095194",
"name": "Escalation Schedule"
},
"onCallParticipants": [
{
"id": "154d6425-c120-4beb-a3e6-a66c8c44f61d",
"name": "dvilenchik@paloaltonetworks.com",
"type": "user"
}
]
},
"requestId": "e88ae246-5d0f-4ebf-826c-f3617e6a3d42",
"took": 0.007
}
}
}
}

Human Readable Output#

OpsGenie Schedule OnCall#

_parentonCallParticipants
id: 5892636c-6183-4788-99d6-6d93b9095194
name: Escalation Schedule
enabled: true
{'id': '154d6425-c120-4beb-a3e6-a66c8c44f61d', 'name': 'dvilenchik@paloaltonetworks.com', 'type': 'user'}

opsgenie-create-incident#


Create an incident in Opsgenie.

Base Command#

opsgenie-create-incident

Input#

Argument NameDescriptionRequired
interval_in_secondsInterval in seconds between each poll. Default is 5.Optional
messageIncident message.Required
descriptionDetailed information about the incident.Optional
respondersTeams/users to whom the incident is routed via notifications.
You need to insert it as List of triples - responder_type,value_type,value.
The responder_type can be: team or user.
The value_type can be: id or name.
You can retrieve the value from the output of the '!opsgenie-get-teams' command.
For example: user,id,123,team,name,test_team.
Optional
tagsComma-separated list of tags to add.Optional
priorityIncident Priority. Possible values are: P1, P2, P3, P4, P5. Default is P3.Optional

Context Output#

PathTypeDescription
OpsGenie.Incident.actionStringAction of this request.
OpsGenie.Incident.incidentIdStringID of the created incident.
OpsGenie.Incident.integrationIdStringIntegration ID of the created alert.
OpsGenie.Incident.isSuccessBooleanWhether the request was successful.
OpsGenie.Incident.processedAtDateWhen the request was processed.
OpsGenie.Incident.requestIdStringThe ID of the request.
OpsGenie.Incident.statusStringThe human readable result of the request.
OpsGenie.Incident.successBooleanWhether the request was successful.

Command Example#

!opsgenie-create-incident message="test" responders=team,name,test_team,team,name,test_team_1

Context Example#

{
"OpsGenie": {
"Incident": {
"action": "Create",
"incidentId": "4ba53100-30dc-47a6-992a-a96df4d1ba20",
"integrationId": "3cc69931-167f-411c-a331-768997c29d2e",
"isSuccess": true,
"processedAt": "2021-12-01T13:48:49.133Z",
"status": "Incident created successfully",
"success": true
}
}
}

Human Readable Output#

OpsGenie#

actionincidentIdintegrationIdisSuccessprocessedAtstatussuccess
Create4ba53100-30dc-47a6-992a-a96df4d1ba203cc69931-167f-411c-a331-768997c29d2etrue2021-12-01T13:48:49.133ZIncident created successfullytrue

opsgenie-delete-incident#


Delete an incident from OpsGenie.

Base Command#

opsgenie-delete-incident

Input#

Argument NameDescriptionRequired
incident_idThe ID of the incident from Opsgenie.Required

Context Output#

PathTypeDescription
OpsGenie.DeletedIncident.actionStringAction of this request.
OpsGenie.DeletedIncident.incidentIdStringID of the deleted incident.
OpsGenie.DeletedIncident.integrationIdStringIntegration ID of the deleted incident.
OpsGenie.DeletedIncident.isSuccessBooleanWhether the request was successful.
OpsGenie.DeletedIncident.processedAtDateWhen the request was processed.
OpsGenie.DeletedIncident.requestIdStringThe ID of the request.
OpsGenie.DeletedIncident.statusStringThe human readable result of the request.
OpsGenie.DeletedIncident.successBooleanWhether the request was successful.

Command Example#

!opsgenie-delete-incident incident_id=c59086e0-bf2c-44e2-bdfb-ed7747cc126b

Context Example#

{
"OpsGenie": {
"DeletedIncident": {
"action": "Delete",
"incidentId": "",
"integrationId": "3cc69931-167f-411c-a331-768997c29d2e",
"isSuccess": false,
"processedAt": "2021-12-01T13:48:52.534Z",
"status": "",
"success": false
}
}
}

Human Readable Output#

OpsGenie#

actionincidentIdintegrationIdisSuccessprocessedAtstatussuccess
Delete3cc69931-167f-411c-a331-768997c29d2efalse2021-12-01T13:48:52.534Zfalse

opsgenie-get-incidents#


List the current incidents from OpsGenie.

Base Command#

opsgenie-get-incidents

Input#

Argument NameDescriptionRequired
incident_idThe ID of the incident from Opsgenie.Optional
limitMaximum number of results to return. Default is 20.Optional
offsetStart index of the result set (to apply pagination). Minimum value is 0. Default is 0.Optional
statusThe status of the alert from Opsgenie. Possible values are: Open, Closed.Optional
priorityIncident Priority. Possible values are: P1, P2, P3, P4, P5. Default is P3.Optional
tagsComma-separated list of tags to add.Optional
queryURL encoded query parameters.Optional
request_idID of the polling request. No need to enter a value.Optional
pagingThe next URL to request. No need to enter a value.Optional
resultResult of the previous command. No need to enter a value.Optional

Context Output#

PathTypeDescription
OpsGenie.Incident.countNumberThe number of alert occurrences.
OpsGenie.Incident.createdAtDateTime the alert was created.
OpsGenie.Incident.incidentIdStringID of the alert.
OpsGenie.Incident.integration.idStringID of the integration.
OpsGenie.Incident.integration.nameStringIntegration name
OpsGenie.Incident.integration.typeStringType of the integration.
OpsGenie.Incident.messageStringAlert message.
OpsGenie.Incident.ownerTeamStringTeam ID of the owner.
OpsGenie.Incident.priorityStringAlert priority.
OpsGenie.Incident.responders.idStringID of the responders.
OpsGenie.Incident.responders.typeStringType of the responders.
OpsGenie.Incident.statusStringStatus of the alert.
OpsGenie.Incident.tinyIdStringShort ID for the alert.
OpsGenie.Incident.updatedAtDateLast updated time for the alert.

Command Example#

!opsgenie-get-incidents limit=1

Context Example#

{
"OpsGenie": {
"Incident": [
{
"actions": [],
"createdAt": "2021-12-01T13:48:49.006Z",
"description": "",
"event_type": "Incidents",
"extraProperties": {},
"id": "4ba53100-30dc-47a6-992a-a96df4d1ba20",
"impactStartDate": "2021-12-01T13:48:49.006Z",
"impactedServices": [],
"links": {
"api": "https://api.opsgenie.com/v1/incidents/4ba53100-30dc-47a6-992a-a96df4d1ba20",
"web": "https://demisto1.app.opsgenie.com/incident/detail/4ba53100-30dc-47a6-992a-a96df4d1ba20"
},
"message": "test",
"ownerTeam": "",
"priority": "P3",
"responders": [],
"status": "open",
"tags": [],
"tinyId": "100",
"updatedAt": "2021-12-01T13:48:49.006Z"
}
]
}
}

Human Readable Output#

OpsGenie#

idcreatedAtstatus
4ba53100-30dc-47a6-992a-a96df4d1ba202021-12-01T13:48:49.006Zopen

opsgenie-close-incident#


Close an incident from OpsGenie.

Base Command#

opsgenie-close-incident

Input#

Argument NameDescriptionRequired
incident_idThe ID of the incident from Opsgenie.Required
noteAdditional incident note.Optional

Context Output#

PathTypeDescription
OpsGenie.ClosedIncident.actionStringAction of this request.
OpsGenie.ClosedIncident.incidentIdStringID of the closed incident.
OpsGenie.ClosedIncident.integrationIdStringIntegration ID of the closed incident
OpsGenie.ClosedIncident.isSuccessBooleanWhether the request was successful.
OpsGenie.ClosedIncident.processedAtDateWhen the request was processed.
OpsGenie.ClosedIncident.requestIdStringThe ID of the request.
OpsGenie.ClosedIncident.statusStringThe human readable result of the request.
OpsGenie.ClosedIncident.successBooleanWhether the request was successful.

Command Example#

!opsgenie-close-incident incident_id=c59086e0-bf2c-44e2-bdfb-ed7747cc126b

Context Example#

{
"OpsGenie": {
"ClosedIncident": {
"action": "Close",
"incidentId": "",
"integrationId": "3cc69931-167f-411c-a331-768997c29d2e",
"isSuccess": false,
"processedAt": "2021-12-01T13:48:50.974Z",
"status": "",
"success": false
}
}
}

Human Readable Output#

OpsGenie#

actionincidentIdintegrationIdisSuccessprocessedAtstatussuccess
Close3cc69931-167f-411c-a331-768997c29d2efalse2021-12-01T13:48:50.974Zfalse

opsgenie-resolve-incident#


Resolve an incident from OpsGenie.

Base Command#

opsgenie-resolve-incident

Input#

Argument NameDescriptionRequired
incident_idThe ID of the incident from Opsgenie.Required
noteAdditional incident note.Optional

Context Output#

PathTypeDescription
OpsGenie.ResolvedIncident.actionStringAction of this request.
OpsGenie.ResolvedIncident.incidentIdStringID of the closed incident.
OpsGenie.ResolvedIncident.integrationIdStringIntegration ID of the closed incident.
OpsGenie.ResolvedIncident.isSuccessBooleanWhether the request was successful.
OpsGenie.ResolvedIncident.processedAtDateWhen the request was processed.
OpsGenie.ResolvedIncident.requestIdStringThe ID of the request.
OpsGenie.ResolvedIncident.statusStringThe human readable result of the request.
OpsGenie.ResolvedIncident.successBooleanWhether the request was successful.

Command Example#

!opsgenie-resolve-incident incident_id=b15c7555-d685-4a96-8798-46320618004e

Context Example#

{
"OpsGenie": {
"ResolvedIncident": {
"action": "Resolve",
"incidentId": "",
"integrationId": "3cc69931-167f-411c-a331-768997c29d2e",
"isSuccess": false,
"processedAt": "2021-12-01T13:48:57.042Z",
"status": "",
"success": false
}
}
}

Human Readable Output#

OpsGenie#

actionincidentIdintegrationIdisSuccessprocessedAtstatussuccess
Resolve3cc69931-167f-411c-a331-768997c29d2efalse2021-12-01T13:48:57.042Zfalse

opsgenie-add-responder-incident#


Add a responder to an OpsGenie incident.

Base Command#

opsgenie-add-responder-incident

Input#

Argument NameDescriptionRequired
incident_idThe ID of the incident from Opsgenie.Required
respondersTeams/users to whom the incident is routed via notifications.
You need to insert it as list of triples - responder_type,value_type,value.
The responder_type can be: team or user.
The value_type can be: id or name.
You can retrieve the value from the output of the '!opsgenie-get-teams' command.
For example: user,id,123,team,name,test_team.
Required
noteAdditional alert note.Optional

Context Output#

PathTypeDescription
OpsGenie.AddResponderIncident.actionStringAction of this request.
OpsGenie.AddResponderIncident.incidentIdStringID of the created incident.
OpsGenie.AddResponderIncident.integrationIdStringIntegration ID of the created incident.
OpsGenie.AddResponderIncident.isSuccessBooleanWhether the request was successful.
OpsGenie.AddResponderIncident.processedAtDateWhen the request was processed.
OpsGenie.AddResponderIncident.requestIdStringThe ID of the request.
OpsGenie.AddResponderIncident.statusStringThe human readable result of the request.
OpsGenie.AddResponderIncident.successBooleanWhether the request was successful.

Command Example#

!opsgenie-add-responder-incident incident_id=577424c1-b03c-4d23-9871-da0d395fea17 responders="team,name,Integration Team"

Context Example#

{
"OpsGenie": {
"AddResponderIncident": {
"action": "Add Responder",
"incidentId": "",
"integrationId": "3cc69931-167f-411c-a331-768997c29d2e",
"isSuccess": false,
"processedAt": "2021-12-01T13:48:59.193Z",
"status": "Given teams/users already added as responders.",
"success": false
}
}
}

Human Readable Output#

OpsGenie#

actionincidentIdintegrationIdisSuccessprocessedAtstatussuccess
Add Responder3cc69931-167f-411c-a331-768997c29d2efalse2021-12-01T13:48:59.193ZGiven teams/users already added as responders.false

opsgenie-add-tag-incident#


Add a tag to the OpsGenie incident.

Base Command#

opsgenie-add-tag-incident

Input#

Argument NameDescriptionRequired
incident_idThe ID of the incident from Opsgenie.Required
tagsComma-separated list of tags to add to the incident.Required
noteAdditional incident note.Optional

Context Output#

PathTypeDescription
OpsGenie.AddTagIncident.actionStringAction of this request.
OpsGenie.AddTagIncident.incidentIdStringID of the added incident.
OpsGenie.AddTagIncident.integrationIdStringIntegration ID of the added incident.
OpsGenie.AddTagIncident.isSuccessBooleanWhether the request was successful.
OpsGenie.AddTagIncident.processedAtDateWhen the request was processed.
OpsGenie.AddTagIncident.requestIdStringThe ID of the request.
OpsGenie.AddTagIncident.statusStringThe human readable result of the request.
OpsGenie.AddTagIncident.successBooleanWhether the request was successful.

Command Example#

!opsgenie-add-tag-incident incident_id=b15c7555-d685-4a96-8798-46320618004e tags=1,2,3

Context Example#

{
"OpsGenie": {
"AddTagIncident": {
"action": "Add Tags",
"incidentId": "b15c7555-d685-4a96-8798-46320618004e",
"integrationId": "3cc69931-167f-411c-a331-768997c29d2e",
"isSuccess": true,
"processedAt": "2021-12-01T13:49:00.839Z",
"status": "Added tags",
"success": true
}
}
}

Human Readable Output#

OpsGenie#

actionincidentIdintegrationIdisSuccessprocessedAtstatussuccess
Add Tagsb15c7555-d685-4a96-8798-46320618004e3cc69931-167f-411c-a331-768997c29d2etrue2021-12-01T13:49:00.839ZAdded tagstrue

opsgenie-remove-tag-incident#


Remove a tag from the OpsGenie alert.

Base Command#

opsgenie-remove-tag-incident

Input#

Argument NameDescriptionRequired
incident_idThe ID of the incident from Opsgenie.Required
tagsComma-separated list of tags to add to the incident.Required
noteAdditional incident note.Optional

Context Output#

PathTypeDescription
OpsGenie.RemoveTagIncident.actionStringAction of this request.
OpsGenie.RemoveTagIncident.incidentIdStringIncident ID of the remove tag incident.
OpsGenie.RemoveTagIncident.integrationIdStringIntegration ID of the remove tag incident.
OpsGenie.RemoveTagIncident.isSuccessBooleanWhether the request was successful.
OpsGenie.RemoveTagIncident.processedAtDateWhen the request was processed.
OpsGenie.RemoveTagIncident.requestIdStringThe ID of the request.
OpsGenie.RemoveTagIncident.statusStringThe human readable result of the request.
OpsGenie.RemoveTagIncident.successBooleanWhether the request was successful.

Command Example#

!opsgenie-remove-tag-incident incident_id=b15c7555-d685-4a96-8798-46320618004e tags=1,2

Context Example#

{
"OpsGenie": {
"RemoveTagIncident": {
"action": "Remove Tags",
"incidentId": "b15c7555-d685-4a96-8798-46320618004e",
"integrationId": "3cc69931-167f-411c-a331-768997c29d2e",
"isSuccess": true,
"processedAt": "2021-12-01T13:49:02.53Z",
"status": "Removed tags",
"success": true
}
}
}

Human Readable Output#

OpsGenie#

actionincidentIdintegrationIdisSuccessprocessedAtstatussuccess
Remove Tagsb15c7555-d685-4a96-8798-46320618004e3cc69931-167f-411c-a331-768997c29d2etrue2021-12-01T13:49:02.53ZRemoved tagstrue

opsgenie-get-teams#


Get teams

Base Command#

opsgenie-get-teams

Input#

Argument NameDescriptionRequired
team_idThe ID of the team from Opsgenie.Optional

Context Output#

PathTypeDescription
OpsGenie.Team.descriptionStringTeam description.
OpsGenie.Team.idStringTeam ID.
OpsGenie.Team.links.apiStringTeam API links.
OpsGenie.Team.links.webStringTeam web links.
OpsGenie.Team.nameStringTeam name.

Command Example#

!opsgenie-get-teams

Context Example#

{
"OpsGenie": {
"Team": [
{
"description": "Engineering",
"id": "51d69df8-c40b-439e-9808-e1a78e54f91b",
"links": {
"api": "https://api.opsgenie.com/v2/teams/51d69df8-c40b-439e-9808-e1a78e54f91b",
"web": "https://demisto1.app.opsgenie.com/teams/dashboard/51d69df8-c40b-439e-9808-e1a78e54f91b/main"
},
"name": "Engineering"
},
{
"description": "Integration Team",
"id": "fbbc3f9a-12f4-4794-9938-7e0a85a06f8b",
"links": {
"api": "https://api.opsgenie.com/v2/teams/fbbc3f9a-12f4-4794-9938-7e0a85a06f8b",
"web": "https://demisto1.app.opsgenie.com/teams/dashboard/fbbc3f9a-12f4-4794-9938-7e0a85a06f8b/main"
},
"name": "Integration Team"
}
]
}
}

Human Readable Output#

OpsGenie Team#

descriptionidlinksname
Engineering51d69df8-c40b-439e-9808-e1a78e54f91bweb: https://demisto1.app.opsgenie.com/teams/dashboard/51d69df8-c40b-439e-9808-e1a78e54f91b/main
api: https://api.opsgenie.com/v2/teams/51d69df8-c40b-439e-9808-e1a78e54f91b
Engineering
Integration Teamfbbc3f9a-12f4-4794-9938-7e0a85a06f8bweb: https://demisto1.app.opsgenie.com/teams/dashboard/fbbc3f9a-12f4-4794-9938-7e0a85a06f8b/main
api: https://api.opsgenie.com/v2/teams/fbbc3f9a-12f4-4794-9938-7e0a85a06f8b
Integration Team

opsgenie-get-request#


Get a request in Opsgenie.

Base Command#

opsgenie-get-request

Input#

Argument NameDescriptionRequired
request_idThe id of the request to getRequired
request_typeThe type of the request to getRequired

Context Output#

PathTypeDescription
OpsGenie.Alert.actionStringAction of this request.
OpsGenie.Alert.alertIdStringID of the created alert.
OpsGenie.Alert.aliasStringAlias of the created alert.
OpsGenie.Alert.integrationIdStringIntegration ID of the created alert.
OpsGenie.Alert.isSuccessBooleanWhether the request was successful.
OpsGenie.Alert.processedAtDateWhen the request was processed.
OpsGenie.Alert.requestIdStringThe ID of the request.
OpsGenie.Alert.statusStringThe human readable result of the request.
OpsGenie.Alert.successBooleanWhether the request was successful.
OpsGenie.Incident.actionStringAction of this request.
OpsGenie.Incident.alertIdStringID of the created alert.
OpsGenie.Incident.aliasStringAlias of the created alert.
OpsGenie.Incident.integrationIdStringIntegration ID of the created alert.
OpsGenie.Incident.isSuccessBooleanWhether the request was successful.
OpsGenie.Incident.processedAtDateWhen the request was processed.
OpsGenie.Incident.requestIdStringThe ID of the request.
OpsGenie.Incident.statusStringThe human readable result of the request.
OpsGenie.Incident.successBooleanWhether the request was successful.

Command Example#

opsgenie-get-request request_id=b79800b2-4378-4249-8677-0bf2332b8a1f request_type=alerts"

Context Example#

{
"OpsGenie": {
"Alert": {
"action": "Create",
"alertId": "4c4623e3-0b3f-47b7-becd-907d3e51d129-1638366498716",
"alias": "4c4623e3-0b3f-47b7-becd-907d3e51d129-1638366498716",
"integrationId": "3cc69931-167f-411c-a331-768997c29d2e",
"isSuccess": true,
"processedAt": "2021-12-01T13:48:18.757Z",
"status": "Created alert",
"success": true
}
}
}

Human Readable Output#

OpsGenie#

actionalertIdaliasintegrationIdisSuccessprocessedAtstatussuccess
Create4c4623e3-0b3f-47b7-becd-907d3e51d129-16383664987164c4623e3-0b3f-47b7-becd-907d3e51d129-16383664987163cc69931-167f-411c-a331-768997c29d2etrue2021-12-01T13:48:18.757ZCreated alerttrue

Breaking changes from the previous version of this integration - OpsGenie v3#

Commands#

Removed the following commands in this version:

  • opsgenie-list-alerts - this command was replaced by opsgenie-get-alerts.
  • opsgenie-get-alert - this command was replaced by opsgenie-get-alerts.
  • opsgenie-get-schedule - this command was replaced by opsgenie-get-schedules.
  • opsgenie-list-schedules - this command was replaced by opsgenie-get-schedules.

Arguments#

  • In the opsgenie-get-on-call command, the schedule-id argument was replaced by the schedule_id and schedule_name arguments.
  • In the opsgenie-create-alert command, the default value of the priority argument was changed to 'P3'.

Outputs#

  • In the opsgenie-create-alert command the following outputs were replaced:

    • OpsGenieV2.CreatedAlert.action - replaced by OpsGenie.Alert.action.
    • OpsGenieV2.CreatedAlert.alertId - replaced by OpsGenie.Alert.alertId.
    • OpsGenieV2.CreatedAlert.alias - replaced by OpsGenie.Alert.alias.
    • OpsGenieV2.CreatedAlert.integrationId - replaced by OpsGenie.Alert.integrationId.
    • OpsGenieV2.CreatedAlert.isSuccess - replaced by OpsGenie.Alert.isSuccess.
    • OpsGenieV2.CreatedAlert.processedAt - replaced by OpsGenie.Alert.processedAt.
    • OpsGenieV2.CreatedAlert.requestId - replaced by OpsGenie.Alert.requestId.
    • OpsGenieV2.CreatedAlert.status - replaced by OpsGenie.Alert.status.
    • OpsGenieV2.CreatedAlert.success - replaced by OpsGenie.Alert.success.
  • In the opsgenie-delete-alert command the following outputs were replaced:

    • OpsGenieV2.DeletedAlert.action - replaced by OpsGenie.DeletedAlert.action.
    • OpsGenieV2.DeletedAlert.alertId - replaced by OpsGenie.DeletedAlert.alertId.
    • OpsGenieV2.DeletedAlert.alias - replaced by OpsGenie.DeletedAlert.alias.
    • OpsGenieV2.DeletedAlert.integrationId - replaced by OpsGenie.DeletedAlert.integrationId.
    • OpsGenieV2.DeletedAlert.isSuccess - replaced by OpsGenie.DeletedAlert.isSuccess.
    • OpsGenieV2.DeletedAlert.processedAt - replaced by OpsGenie.DeletedAlert.processedAt.
    • OpsGenieV2.DeletedAlert.requestId - replaced by OpsGenie.DeletedAlert.requestId.
    • OpsGenieV2.DeletedAlert.status - replaced by OpsGenie.DeletedAlert.status.
    • OpsGenieV2.DeletedAlert.success - replaced by OpsGenie.DeletedAlert.success.
  • In the opsgenie-ack-alert command the following outputs were replaced:

    • OpsGenieV2.AckedAlert.action - replaced by OpsGenie.AckedAlert.action.
    • OpsGenieV2.AckedAlert.alertId -replaced by OpsGenie.AckedAlert.alertId.
    • OpsGenieV2.AckedAlert.alias -replaced by OpsGenie.AckedAlert.alias.
    • OpsGenieV2.AckedAlert.integrationId - replaced by OpsGenie.AckedAlert.integrationId.
    • OpsGenieV2.AckedAlert.isSuccess - replaced by OpsGenie.AckedAlert.isSuccess.
    • OpsGenieV2.AckedAlert.processedAt - replaced by OpsGenie.AckedAlert.processedAt.
    • OpsGenieV2.AckedAlert.requestId - replaced by OpsGenie.AckedAlert.requestId.
    • OpsGenieV2.AckedAlert.status - replaced by OpsGenie.AckedAlert.status.
    • OpsGenieV2.AckedAlert.success - replaced by OpsGenie.AckedAlert.success.
  • In the opsgenie-get-on-call command the following outputs were replaced:

    • OpsGenieV2.OnCall._parent.enabled - replaced by OpsGenie.Schedule.OnCall._parent.enabled.
    • OpsGenieV2.OnCall._parent.id - replaced by OpsGenie.Schedule.OnCall._parent.id.
    • OpsGenieV2.OnCall._parent.name - replaced by OpsGenie.Schedule.OnCall._parent.name.
    • OpsGenieV2.OnCall.onCallParticipants.id - replaced by OpsGenie.Schedule.OnCall.onCallParticipants.id.
    • OpsGenieV2.OnCall.onCallParticipants.name - replaced by OpsGenie.Schedule.OnCall.onCallParticipants.name.
    • OpsGenieV2.OnCall.onCallParticipants.type - replaced by OpsGenie.Schedule.OnCall.onCallParticipants.type.
  • In the opsgenie-close-alert command the following outputs were replaced:

    • OpsGenieV2.CloseAlert.action - replaced by OpsGenie.ClosedAlert.action.
    • OpsGenieV2.CloseAlert.alertId - replaced by OpsGenie.ClosedAlert.alertId.
    • OpsGenieV2.CloseAlert.alias - replaced by OpsGenie.ClosedAlert.alias.
    • OpsGenieV2.CloseAlert.integrationId - replaced by OpsGenie.ClosedAlert.integrationId.
    • OpsGenieV2.CloseAlert.isSuccess - replaced by OpsGenie.ClosedAlert.isSuccess.
    • OpsGenieV2.CloseAlert.processedAt - replaced by OpsGenie.ClosedAlert.processedAt.
    • OpsGenieV2.CloseAlert.requestId - replaced by OpsGenie.ClosedAlert.requestId.
    • OpsGenieV2.CloseAlert.status - replaced by OpsGenie.ClosedAlert.status.
    • OpsGenieV2.CloseAlert.success - replaced by OpsGenie.ClosedAlert.success.