UNPKG

@itentialopensource/adapter-opsgenie

Version:

This adapter integrates with system described as: opsgenieRestApi.

1,893 lines (1,892 loc) 279 kB
{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/v2/alerts/requests/{requestId}": { "get": { "tags": [ "Alert" ], "operationId": "getRequestStatus", "description": "The parameters and request body are for method: getRequestStatus. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "title": "requestId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/alerts": { "get": { "tags": [ "Alert" ], "operationId": "listAlerts", "description": "The parameters and request body are for method: listAlerts. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "type": "object" } }, { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "searchIdentifier", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "searchIdentifierType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Alert" ], "operationId": "createAlert", "description": "The parameters and request body are for method: createAlert. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "took": { "type": "number" }, "result": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "requestId": "string", "took": 7, "result": "string", "data": { "id": "string", "name": "string" } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/alerts/{identifier}": { "get": { "tags": [ "Alert" ], "operationId": "getAlert", "description": "The parameters and request body are for method: getAlert. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Alert" ], "operationId": "deleteAlert", "description": "The parameters and request body are for method: deleteAlert. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "took": { "type": "number" }, "result": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "requestId": "string", "took": 10, "result": "string", "data": { "id": "string", "name": "string" } } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/alerts/{identifier}/acknowledge": { "post": { "tags": [ "Alert" ], "operationId": "acknowledgeAlert", "description": "The parameters and request body are for method: acknowledgeAlert. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "took": { "type": "number" }, "result": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "requestId": "string", "took": 8, "result": "string", "data": { "id": "string", "name": "string" } } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/alerts/{identifier}/unacknowledge": { "post": { "tags": [ "Alert" ], "operationId": "unAcknowledgeAlert", "description": "The parameters and request body are for method: unAcknowledgeAlert. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "took": { "type": "number" }, "result": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "requestId": "string", "took": 4, "result": "string", "data": { "id": "string", "name": "string" } } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/alerts/{identifier}/close": { "post": { "tags": [ "Alert" ], "operationId": "closeAlert", "description": "The parameters and request body are for method: closeAlert. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "took": { "type": "number" }, "result": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "requestId": "string", "took": 7, "result": "string", "data": { "id": "string", "name": "string" } } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/alerts/{identifier}/snooze": { "post": { "tags": [ "Alert" ], "operationId": "snoozeAlert", "description": "The parameters and request body are for method: snoozeAlert. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "took": { "type": "number" }, "result": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "requestId": "string", "took": 3, "result": "string", "data": { "id": "string", "name": "string" } } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/alerts/{identifier}/escalate": { "post": { "tags": [ "Alert" ], "operationId": "escalateAlert", "description": "The parameters and request body are for method: escalateAlert. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "took": { "type": "number" }, "result": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "requestId": "string", "took": 1, "result": "string", "data": { "id": "string", "name": "string" } } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/alerts/{identifier}/assign": { "post": { "tags": [ "Alert" ], "operationId": "assignAlert", "description": "The parameters and request body are for method: assignAlert. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "took": { "type": "number" }, "result": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "requestId": "string", "took": 1, "result": "string", "data": { "id": "string", "name": "string" } } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/alerts/{identifier}/responders": { "post": { "tags": [ "Alert" ], "operationId": "addResponder", "description": "The parameters and request body are for method: addResponder. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "took": { "type": "number" }, "result": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "requestId": "string", "took": 10, "result": "string", "data": { "id": "string", "name": "string" } } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/alerts/{identifier}/teams": { "post": { "tags": [ "Alert" ], "operationId": "addTeam", "description": "The parameters and request body are for method: addTeam. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "took": { "type": "number" }, "result": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "requestId": "string", "took": 2, "result": "string", "data": { "id": "string", "name": "string" } } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/alerts/{identifier}/actions/{actionName}": { "post": { "tags": [ "Alert" ], "operationId": "executeCustomAlertAction", "description": "The parameters and request body are for method: executeCustomAlertAction. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "took": { "type": "number" }, "result": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "requestId": "string", "took": 7, "result": "string", "data": { "id": "string", "name": "string" } } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "actionName", "in": "path", "required": true, "schema": { "title": "actionName", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/alerts/{identifier}/recipients": { "get": { "tags": [ "Alert" ], "operationId": "listRecipients", "description": "The parameters and request body are for method: listRecipients. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/alerts/{identifier}/logs": { "get": { "tags": [ "Alert" ], "operationId": "listLogs", "description": "The parameters and request body are for method: listLogs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "direction", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/alerts/{identifier}/attachments": { "get": { "tags": [ "Alert" ], "operationId": "listAttachments", "description": "The parameters and request body are for method: listAttachments. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "alertIdentifierType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Alert" ], "operationId": "addAttachment", "description": "The parameters and request body are for method: addAttachment. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "alertIdentifierType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/alerts/{identifier}/attachments/{attachmentId}": { "get": { "tags": [ "Alert" ], "operationId": "getAttachment", "description": "The parameters and request body are for method: getAttachment. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "attachmentId", "in": "path", "required": true, "schema": { "title": "attachmentId", "type": "number" } }, { "name": "alertIdentifierType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Alert" ], "operationId": "removeAttachment", "description": "The parameters and request body are for method: removeAttachment. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "attachmentId", "in": "path", "required": true, "schema": { "title": "attachmentId", "type": "number" } }, { "name": "alertIdentifierType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/alerts/{identifier}/tags": { "post": { "tags": [ "Alert" ], "operationId": "addTags", "description": "The parameters and request body are for method: addTags. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "took": { "type": "number" }, "result": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "requestId": "string", "took": 4, "result": "string", "data": { "id": "string", "name": "string" } } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Alert" ], "operationId": "removeTags", "description": "The parameters and request body are for method: removeTags. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "took": { "type": "number" }, "result": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "requestId": "string", "took": 7, "result": "string", "data": { "id": "string", "name": "string" } } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "note", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "tags", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/alerts/{identifier}/details": { "post": { "tags": [ "Alert" ], "operationId": "addDetails", "description": "The parameters and request body are for method: addDetails. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "took": { "type": "number" }, "result": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "requestId": "string", "took": 7, "result": "string", "data": { "id": "string", "name": "string" } } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Alert" ], "operationId": "removeDetails", "description": "The parameters and request body are for method: removeDetails. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string" }, "took": { "type": "number" }, "result": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "requestId": "string", "took": 7, "result": "string", "data": { "id": "string", "name": "string" } } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "note", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "keys", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/alerts/{identifier}/notes": { "get": { "tags": [ "Alert" ], "operationId": "listNotes", "description": "The parameters and request body are for method: listNotes. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "identifier", "type": "string" } }, { "name": "identifierType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "direction", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit",