{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/v1/alerts/{alertId}": { "get": { "tags": [ "Alerts" ], "operationId": "alertDetails", "description": "The parameters and request body are for method: alertDetails. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "assignee": { "type": "string" }, "description": { "type": "string" }, "first_event_time": { "type": "number" }, "last_event_time": { "type": "number" }, "severity": { "type": "string" }, "status": { "type": "string" }, "alert_id": { "type": "number" }, "alias": { "type": "string" }, "check": { "type": "string" }, "class": { "type": "string" }, "dedupe_key": { "type": "string" }, "event_count": { "type": "number" }, "incidents": { "type": "array", "items": { "type": "number" } }, "last_status_change_time": { "type": "number" }, "location": { "type": "object" }, "maintenance": { "type": "string" }, "manager": { "type": "string" }, "manager_id": { "type": "string" }, "namespace": { "type": "string" }, "service": { "type": "array", "items": { "type": "string" } }, "source": { "type": "string" }, "tags": { "type": "object" }, "type": { "type": "string" }, "utcOffset": { "type": "string" }, "active_incidents_count": { "type": "number" }, "service_count": { "type": "number" } } }, "status": { "type": "string" } } }, "example": { "data": { "assignee": "test@moogsoft.com", "description": "1 Source: www.your-source.com Affected retail, support\n", "first_event_time": 1607985505, "last_event_time": 1607985505, "severity": "warning", "status": "open", "alert_id": 4, "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "event_count": 6, "incidents": [ 7, 4, 9, 5, 4, 9, 3 ], "last_status_change_time": 2, "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "service": [ "string", "string", "string", "string", "string" ], "source": "string", "tags": {}, "type": "string", "utcOffset": "string", "active_incidents_count": 4, "service_count": 6 }, "status": "success" } } } } }, "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "title": "alertId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Alerts" ], "operationId": "updateAlert", "description": "The parameters and request body are for method: updateAlert. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "title": "alertId", "type": "number" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/alerts": { "get": { "tags": [ "Alerts" ], "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": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "properties": { "assignee": { "type": "string" }, "description": { "type": "string" }, "first_event_time": { "type": "number" }, "last_event_time": { "type": "number" }, "severity": { "type": "string" }, "status": { "type": "string" }, "alert_id": { "type": "number" }, "alias": { "type": "string" }, "check": { "type": "string" }, "class": { "type": "string" }, "dedupe_key": { "type": "string" }, "event_count": { "type": "number" }, "incidents": { "type": "array", "items": { "type": "number" } }, "last_status_change_time": { "type": "number" }, "location": { "type": "object" }, "maintenance": { "type": "string" }, "manager": { "type": "string" }, "manager_id": { "type": "string" }, "namespace": { "type": "string" }, "service": { "type": "array", "items": { "type": "string" } }, "source": { "type": "string" }, "tags": { "type": "object" }, "type": { "type": "string" }, "utcOffset": { "type": "string" }, "active_incidents_count": { "type": "number" }, "service_count": { "type": "number" } } } } } } } }, "example": { "status": "success", "data": { "result": [ { "assignee": "test@moogsoft.com", "description": "1 Source: www.your-source.com Affected retail, support\n", "first_event_time": 1607985505, "last_event_time": 1607985505, "severity": "minor", "status": "resolved", "alert_id": 2, "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "event_count": 2, "incidents": [ 7 ], "last_status_change_time": 4, "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "service": [ "string", "string", "string", "string" ], "source": "string", "tags": {}, "type": "string", "utcOffset": "string", "active_incidents_count": 2, "service_count": 2 }, { "assignee": "test@moogsoft.com", "description": "1 Source: www.your-source.com Affected retail, support\n", "first_event_time": 1607985505, "last_event_time": 1607985505, "severity": "warning", "status": "in progress", "alert_id": 8, "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "event_count": 2, "incidents": [ 5, 3, 9, 3, 2, 5, 9, 2, 10, 3 ], "last_status_change_time": 5, "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "service": [ "string", "string", "string", "string", "string" ], "source": "string", "tags": {}, "type": "string", "utcOffset": "string", "active_incidents_count": 1, "service_count": 2 }, { "assignee": "test@moogsoft.com", "description": "1 Source: www.your-source.com Affected retail, support\n", "first_event_time": 1607985505, "last_event_time": 1607985505, "severity": "major", "status": "in progress", "alert_id": 10, "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "event_count": 6, "incidents": [ 6 ], "last_status_change_time": 9, "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "service": [ "string", "string", "string", "string", "string", "string" ], "source": "string", "tags": {}, "type": "string", "utcOffset": "string", "active_incidents_count": 5, "service_count": 10 }, { "assignee": "test@moogsoft.com", "description": "1 Source: www.your-source.com Affected retail, support\n", "first_event_time": 1607985505, "last_event_time": 1607985505, "severity": "minor", "status": "superseded", "alert_id": 2, "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "event_count": 2, "incidents": [ 7, 2, 10, 2, 3, 2, 7, 6 ], "last_status_change_time": 5, "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "service": [ "string" ], "source": "string", "tags": {}, "type": "string", "utcOffset": "string", "active_incidents_count": 1, "service_count": 10 }, { "assignee": "test@moogsoft.com", "description": "1 Source: www.your-source.com Affected retail, support\n", "first_event_time": 1607985505, "last_event_time": 1607985505, "severity": "clear", "status": "error", "alert_id": 2, "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "event_count": 1, "incidents": [ 6, 9 ], "last_status_change_time": 7, "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "service": [ "string", "string", "string", "string", "string" ], "source": "string", "tags": {}, "type": "string", "utcOffset": "string", "active_incidents_count": 9, "service_count": 3 }, { "assignee": "test@moogsoft.com", "description": "1 Source: www.your-source.com Affected retail, support\n", "first_event_time": 1607985505, "last_event_time": 1607985505, "severity": "unknown", "status": "superseded", "alert_id": 4, "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "event_count": 2, "incidents": [ 2, 9 ], "last_status_change_time": 7, "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "service": [ "string" ], "source": "string", "tags": {}, "type": "string", "utcOffset": "string", "active_incidents_count": 2, "service_count": 5 }, { "assignee": "test@moogsoft.com", "description": "1 Source: www.your-source.com Affected retail, support\n", "first_event_time": 1607985505, "last_event_time": 1607985505, "severity": "warning", "status": "open", "alert_id": 1, "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "event_count": 6, "incidents": [ 3, 10, 5 ], "last_status_change_time": 8, "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "service": [ "string", "string", "string" ], "source": "string", "tags": {}, "type": "string", "utcOffset": "string", "active_incidents_count": 3, "service_count": 1 }, { "assignee": "test@moogsoft.com", "description": "1 Source: www.your-source.com Affected retail, support\n", "first_event_time": 1607985505, "last_event_time": 1607985505, "severity": "warning", "status": "open", "alert_id": 6, "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "event_count": 9, "incidents": [ 8, 3, 2, 10, 8 ], "last_status_change_time": 2, "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "service": [ "string", "string", "string", "string" ], "source": "string", "tags": {}, "type": "string", "utcOffset": "string", "active_incidents_count": 8, "service_count": 7 } ] } } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "incidentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "utcOffset", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Alerts" ], "operationId": "updateAlerts", "description": "The parameters and request body are for method: updateAlerts. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/alerts/{alertId}/incidents": { "get": { "tags": [ "Alerts" ], "operationId": "incidentIds", "description": "The parameters and request body are for method: incidentIds. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "number" } } } } } }, "example": { "status": "success", "data": { "result": [ 8, 7, 8, 7, 9, 9, 6 ] } } } } } }, "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "title": "alertId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/alerts-columns": { "get": { "tags": [ "AlertsColumns" ], "operationId": "alertDtoColumnNames", "description": "The parameters and request body are for method: alertDtoColumnNames. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "object", "properties": { "internalName": { "type": "string" }, "type": { "type": "string" }, "uiName": { "type": "string" } } } } } }, "status": { "type": "string" } } }, "example": { "data": { "fields": [ { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" } ] }, "status": "success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/alerts-count": { "get": { "tags": [ "AlertsCount" ], "operationId": "getAlertCount", "description": "The parameters and request body are for method: getAlertCount. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/alerts-search": { "get": { "tags": [ "AlertsSearch" ], "operationId": "search", "description": "The parameters and request body are for method: search. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "number" } }, "example": [ 4 ] } } } }, "parameters": [ { "name": "eventTime", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/alerts-summaries": { "get": { "tags": [ "AlertsSummaries" ], "operationId": "alertSummaries", "description": "The parameters and request body are for method: alertSummaries. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "buckets": { "type": "number" }, "metrics": { "type": "array", "items": { "type": "object", "properties": { "metric": { "type": "string" }, "stats": { "type": "object", "properties": { "avg_prev_week": { "type": "number" } } }, "values": { "type": "array", "items": { "type": "array", "items": { "type": "object" } } } } } }, "time": { "type": "object", "properties": { "begin": { "type": "number" }, "end": { "type": "number" }, "interval": { "type": "number" } } } } } } }, "example": { "status": "success", "data": { "buckets": 3, "metrics": [ { "metric": "string", "stats": { "avg_prev_week": 5 }, "values": [ [ {} ], [ {}, {}, {}, {}, {} ], [ {}, {}, {}, {}, {}, {}, {}, {} ], [ {}, {} ], [ {}, {}, {} ], [ {}, {}, {}, {}, {}, {} ], [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], [ {}, {}, {}, {}, {}, {}, {}, {}, {} ] ] }, { "metric": "string", "stats": { "avg_prev_week": 9 }, "values": [ [ {}, {} ], [ {}, {}, {}, {}, {}, {}, {}, {} ], [ {}, {}, {}, {}, {} ], [ {}, {}, {}, {}, {} ], [ {}, {}, {}, {}, {}, {}, {}, {}, {} ] ] }, { "metric": "string", "stats": { "avg_prev_week": 3 }, "values": [ [ {}, {}, {}, {} ], [ {}, {}, {} ], [ {}, {}, {}, {}, {}, {} ], [ {}, {}, {}, {}, {}, {}, {}, {} ], [ {}, {}, {}, {}, {} ], [ {}, {}, {}, {}, {}, {} ] ] }, { "metric": "string", "stats": { "avg_prev_week": 9 }, "values": [ [ {}, {}, {}, {}, {}, {} ], [ {}, {}, {}, {}, {}, {}, {}, {} ], [ {}, {}, {}, {}, {}, {}, {}, {} ], [ {}, {}, {}, {}, {} ] ] } ], "time": { "begin": 7, "end": 7, "interval": 4 } } } } } } }, "parameters": [ { "name": "begin", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "buckets", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/automation-config": { "get": { "tags": [ "AutomationConfig" ], "operationId": "getAutomationConfig", "description": "The parameters and request body are for method: getAutomationConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "closeAlertsInSeconds": { "type": "number" }, "closeAlertsWhenAllIncidentsClosed": { "type": "boolean" }, "closeIncidentsInSeconds": { "type": "number" }, "closeResolvedAlertsInSeconds": { "type": "number" }, "closeResolvedIncidentsInSeconds": { "type": "number" } } } } }, "example": { "status": "success", "data": { "closeAlertsInSeconds": 7, "closeAlertsWhenAllIncidentsClosed": false, "closeIncidentsInSeconds": 2, "closeResolvedAlertsInSeconds": 1, "closeResolvedIncidentsInSeconds": 9 } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "AutomationConfig" ], "operationId": "patchAutomationConfig", "description": "The parameters and request body are for method: patchAutomationConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/test-workflows": { "post": { "tags": [ "TestWorkflows" ], "operationId": "testWorkflow", "description": "The parameters and request body are for method: testWorkflow. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "actionsTestList": { "type": "array", "items": { "type": "object", "properties": { "actionName": { "type": "string" }, "discarded": { "type": "boolean" }, "endMillis": { "type": "number" }, "exception": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "skipped": { "type": "boolean" }, "startMillis": { "type": "number" } } } }, "discarded": { "type": "boolean" }, "endMillis": { "type": "number" }, "exception": { "type": "string" }, "filterTest": { "type": "object", "properties": { "endMillis": { "type": "number" }, "exception": { "type": "string" }, "input": { "type": "object" }, "result": { "type": "boolean" }, "startMillis": { "type": "number" } } }, "generalError": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "skipped": { "type": "boolean" }, "startMillis": { "type": "number" }, "status": { "type": "string" } } } } }, "example": { "status": "success", "data": { "actionsTestList": [ { "actionName": "string", "discarded": true, "endMillis": 9, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 6 }, { "actionName": "string", "discarded": false, "endMillis": 9, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 7 } ], "discarded": false, "endMillis": 10, "exception": "string", "filterTest": { "endMillis": 8, "exception": "string", "input": {}, "result": true, "startMillis": 10 }, "generalError": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 7, "status": "FAILED" } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/workflow-actions": { "get": { "tags": [ "WorkflowActions" ], "operationId": "getActions", "description": "The parameters and request body are for method: getActions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "displayName": { "type": "string" }, "name": { "type": "string" }, "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "displayName": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } } } } } }, "workflowTypes": { "type": "array", "items": { "type": "string" } } } } }, "example": [ { "description": "string", "displayName": "string", "name": "string", "schema": { "fields": [ { "description": "string", "displayName": "string", "name": "string", "type": "string" } ] }, "workflowTypes": [ "EVENT", "EVENT" ] }, { "description": "string", "displayName": "string", "name": "string", "schema": { "fields": [ { "description": "string", "displayName": "string", "name": "string", "type": "string" }, { "description": "string", "displayName": "string", "name": "string", "type": "string" }, { "description": "string", "displayName": "string", "name": "string", "type": "string" }, { "description": "string", "displayName": "string", "name": "string", "type": "string" }, { "description": "string", "displayName": "string", "name": "string", "type": "string" }, { "description": "string", "displayName": "string", "name": "string", "type": "string" }, { "description": "string", "displayName": "string", "name": "string", "type": "string" }, { "description": "string", "displayName": "string", "name": "string", "type": "string" } ] }, "workflowTypes": [ "EVENT", "EVENT", "EVENT", "EVENT", "EVENT", "EVENT", "EVENT", "EVENT", "EVENT" ] }, { "description": "string", "displayName": "string", "name": "string", "schema": { "fields": [ { "description": "string", "displayName": "string", "name": "string", "type": "string" }, { "description": "string", "displayName": "string", "name": "string", "type": "string" }, { "description": "string", "displayName": "string", "name": "string", "type": "string" } ] }, "workflowTypes": [ "EVENT", "EVENT", "EVENT", "EVENT", "EVENT" ] }, { "description": "string", "displayName": "string", "name": "string", "schema": { "fields": [ { "description": "string", "displayName": "string", "name": "string", "type": "string" }, { "description": "string", "displayName": "string", "name": "string", "type": "string" }, { "description": "string", "displayName": "string", "name": "string", "type": "string" }, { "description": "string", "displayName": "string", "name": "string", "type": "string" }, { "description": "string", "displayName": "string", "name": "string", "type": "string" }, { "description": "string", "displayName": "string", "name": "string", "type": "string" } ] }, "workflowTypes": [ "EVENT", "EVENT", "EVENT", "EVENT" ] } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/integrations/byoapi/{endpointId}/config/draft": { "get": { "tags": [ "CustomIntegrationConfigs" ], "operationId": "getDraftEndpointConfig", "description": "The parameters and request body are for method: getDraftEndpointConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "batchKey": { "type": "string" }, "mappings": { "type": "array", "items": { "type": "object" } } } } } }, "example": { "status": "success", "data": { "batchKey": "string", "mappings": [ {}, {}, {} ] } } } } } }, "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "title": "endpointId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "CustomIntegrationConfigs" ], "operationId": "updateDraftEndpointConfig", "description": "The parameters and request body are for method: updateDraftEndpointConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "batchKey": { "type": "string" }, "mappings": { "type": "array", "items": { "type": "object" } } } } } }, "example": { "status": "success", "data": { "batchKey": "string", "mappings": [ {}, {} ] } } } } } }, "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "title": "endpointId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/integrations/byoapi/{endpointId}/config/live": { "get": { "tags": [ "CustomIntegrationConfigs" ], "operationId": "getLiveEndpointConfig", "description": "The parameters and request body are for method: getLiveEndpointConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "batchKey": { "type": "string" }, "mappings": { "type": "array", "items": { "type": "object" } } } } } }, "example": { "status": "success", "data": { "batchKey": "string", "mappings": [ {}, {}, {} ] } } } } } }, "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "title": "endpointId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "CustomIntegrationConfigs" ], "operationId": "updateLiveEndpointConfig", "description": "The parameters and request body are for method: updateLiveEndpointConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "batchKey": { "type": "string" }, "mappings": { "type": "array", "items": { "type": "object" } } } } } }, "example": { "status": "success", "data": { "batchKey": "string", "mappings": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ] } } } } } }, "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "title": "endpointId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/integrations/byoapi/{endpointId}/config/test": { "post": { "tags": [ "CustomIntegrationConfigs" ], "operationId": "testEndpointConfig", "description": "The parameters and request body are for method: testEndpointConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "dedupeKeyStatus": { "type": "object" }, "mappingResults": { "type": "array", "items": { "type": "object", "properties": { "dedupeKeyErrors": { "type": "object" }, "errorMessage": { "type": "string" }, "event": { "type": "object", "properties": { "alias": { "type": "string" }, "check": { "type": "string" }, "class": { "type": "string" }, "dedupe_key": { "type": "string" }, "description": { "type": "string" }, "location": { "type": "object" }, "maintenance": { "type": "string" }, "manager": { "type": "string" }, "manager_id": { "type": "string" }, "namespace": { "type": "string" }, "services": { "type": "array", "items": { "type": "string" } }, "severity": { "type": "object" }, "source": { "type": "string" }, "tags": { "type": "object" }, "time": { "type": "string" }, "utc_offset": { "type": "string" } } }, "metric": { "type": "object" }, "payloadProcessingResult": { "type": "string" } } } } } } } }, "example": { "status": "success", "data": { "dedupeKeyStatus": {}, "mappingResults": [ { "dedupeKeyErrors": {}, "errorMessage": "string", "event": { "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "description": "string", "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "services": [ "string", "string", "string", "string", "string" ], "severity": {}, "source": "string", "tags": {}, "time": "string", "utc_offset": "string" }, "metric": {}, "payloadProcessingResult": "string" }, { "dedupeKeyErrors": {}, "errorMessage": "string", "event": { "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "description": "string", "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "services": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "severity": {}, "source": "string", "tags": {}, "time": "string", "utc_offset": "string" }, "metric": {}, "payloadProcessingResult": "string" }, { "dedupeKeyErrors": {}, "errorMessage": "string", "event": { "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "description": "string", "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "services": [ "string" ], "severity": {}, "source": "string", "tags": {}, "time": "string", "utc_offset": "string" }, "metric": {}, "payloadProcessingResult": "string" }, { "dedupeKeyErrors": {}, "errorMessage": "string", "event": { "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "description": "string", "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "services": [ "string", "string", "string", "string", "string" ], "severity": {}, "source": "string", "tags": {}, "time": "string", "utc_offset": "string" }, "metric": {}, "payloadProcessingResult": "string" }, { "dedupeKeyErrors": {}, "errorMessage": "string", "event": { "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "description": "string", "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "services": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "severity": {}, "source": "string", "tags": {}, "time": "string", "utc_offset": "string" }, "metric": {}, "payloadProcessingResult": "string" } ] } } } } } }, "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "title": "endpointId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/byoapi": { "get": { "tags": [ "CustomIntegrationEndpoints" ], "operationId": "getAllEndpoints", "description": "The parameters and request body are for method: getAllEndpoints. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "authRequired": { "type": "boolean" }, "description": { "type": "string" }, "endpointName": { "type": "string" }, "draftConfigV2": { "type": "object", "properties": { "batchKey": { "type": "string" }, "mappings": { "type": "array", "items": { "type": "object" } } } }, "endpointUrl": { "type": "string" }, "id": { "type": "string" }, "liveConfigV2": { "type": "object", "properties": { "batchKey": { "type": "string" }, "mappings": { "type": "array", "items": { "type": "object" } } } }, "status": { "type": "string" }, "type": { "type": "string" } } } }, "example": [ { "authRequired": true, "description": "string", "endpointName": "string", "draftConfigV2": { "batchKey": "string", "mappings": [ {}, {}, {}, {}, {}, {}, {}, {}, {} ] }, "endpointUrl": "string", "id": "string", "liveConfigV2": { "batchKey": "string", "mappings": [ {}, {} ] }, "status": "PROVISIONED", "type": "METRIC" } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "CustomIntegrationEndpoints" ], "operationId": "createCustomEndpoint", "description": "The parameters and request body are for method: createCustomEndpoint. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "authRequired": { "type": "boolean" }, "description": { "type": "string" }, "endpointName": { "type": "string" }, "draftConfigV2": { "type": "object", "properties": { "batchKey": { "type": "string" }, "mappings": { "type": "array", "items": { "type": "object" } } } }, "endpointUrl": { "type": "string" }, "id": { "type": "string" }, "liveConfigV2": { "type": "object", "properties": { "batchKey": { "type": "string" }, "mappings": { "type": "array", "items": { "type": "object" } } } }, "status": { "type": "string" }, "type": { "type": "string" } } } } }, "example": { "status": "success", "data": { "authRequired": false, "description": "string", "endpointName": "string", "draftConfigV2": { "batchKey": "string", "mappings": [ {}, {} ] }, "endpointUrl": "string", "id": "string", "liveConfigV2": { "batchKey": "string", "mappings": [ {}, {} ] }, "status": "ACTIVE", "type": "EVENT" } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/byoapi/{endpointId}": { "get": { "tags": [ "CustomIntegrationEndpoints" ], "operationId": "getCustomEndpoint", "description": "The parameters and request body are for method: getCustomEndpoint. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "authRequired": { "type": "boolean" }, "description": { "type": "string" }, "endpointName": { "type": "string" }, "draftConfigV2": { "type": "object", "properties": { "batchKey": { "type": "string" }, "mappings": { "type": "array", "items": { "type": "object" } } } }, "endpointUrl": { "type": "string" }, "id": { "type": "string" }, "liveConfigV2": { "type": "object", "properties": { "batchKey": { "type": "string" }, "mappings": { "type": "array", "items": { "type": "object" } } } }, "status": { "type": "string" }, "type": { "type": "string" } } } } }, "example": { "status": "success", "data": { "authRequired": false, "description": "string", "endpointName": "string", "draftConfigV2": { "batchKey": "string", "mappings": [ {}, {}, {}, {}, {} ] }, "endpointUrl": "string", "id": "string", "liveConfigV2": { "batchKey": "string", "mappings": [ {}, {}, {}, {}, {} ] }, "status": "ERROR", "type": "METRIC" } } } } } }, "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "title": "endpointId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "CustomIntegrationEndpoints" ], "operationId": "updateCustomEndpoint", "description": "The parameters and request body are for method: updateCustomEndpoint. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "authRequired": { "type": "boolean" }, "description": { "type": "string" }, "endpointName": { "type": "string" }, "draftConfigV2": { "type": "object", "properties": { "batchKey": { "type": "string" }, "mappings": { "type": "array", "items": { "type": "object" } } } }, "endpointUrl": { "type": "string" }, "id": { "type": "string" }, "liveConfigV2": { "type": "object", "properties": { "batchKey": { "type": "string" }, "mappings": { "type": "array", "items": { "type": "object" } } } }, "status": { "type": "string" }, "type": { "type": "string" } } } } }, "example": { "status": "success", "data": { "authRequired": true, "description": "string", "endpointName": "string", "draftConfigV2": { "batchKey": "string", "mappings": [ {}, {}, {}, {}, {}, {}, {}, {} ] }, "endpointUrl": "string", "id": "string", "liveConfigV2": { "batchKey": "string", "mappings": [ {}, {}, {} ] }, "status": "INACTIVE", "type": "EVENT" } } } } } }, "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "title": "endpointId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "CustomIntegrationEndpoints" ], "operationId": "deleteCustomEndpoint", "description": "The parameters and request body are for method: deleteCustomEndpoint. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "title": "endpointId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/integrations/custom/{endpointName}/{uuid}": { "post": { "tags": [ "CustomIntegrationEndpoints" ], "operationId": "postJsonPayload", "description": "The parameters and request body are for method: postJsonPayload. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "endpointName", "in": "path", "required": true, "schema": { "title": "endpointName", "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/byoapi/{endpointId}/traffic/payloads/{id}": { "get": { "tags": [ "CustomIntegrationTraffic" ], "operationId": "getRecentPayload", "description": "The parameters and request body are for method: getRecentPayload. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "errorMessage": { "type": "string" }, "id": { "type": "string" }, "payload": { "type": "array", "items": { "type": "object" } }, "payloadProcessingResult": { "type": "string" }, "_raw": { "type": "string" }, "sourceIp": { "type": "string" }, "timestamp": { "type": "number" }, "traceId": { "type": "string" } } } } }, "example": { "status": "success", "data": { "errorMessage": "string", "id": "string", "payload": [ {}, {}, {}, {}, {}, {}, {} ], "payloadProcessingResult": "string", "_raw": "string", "sourceIp": "string", "timestamp": 6, "traceId": "string" } } } } } }, "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "title": "endpointId", "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/integrations/byoapi/{endpointId}/traffic/summary": { "get": { "tags": [ "CustomIntegrationTraffic" ], "operationId": "getTrafficSummary", "description": "The parameters and request body are for method: getTrafficSummary. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "averagePayloadProcessingTimeMs": { "type": "number" }, "endpointName": { "type": "string" }, "id": { "type": "string" }, "lastUpdateTime": { "type": "number" }, "maxPayloadProcessingTimeMs": { "type": "number" }, "minPayloadProcessingTimeMs": { "type": "number" }, "numPayloadsBadJSON": { "type": "number" }, "numPayloadsFailed": { "type": "number" }, "numPayloadsHandled": { "type": "number" }, "numPayloadsMappingFailed": { "type": "number" }, "numPayloadsNoEndpoint": { "type": "number" }, "numPayloadsNoLiveConfig": { "type": "number" }, "numPayloadsSuccess": { "type": "number" }, "podname": { "type": "string" }, "ratePayloadsHandledPerSecond": { "type": "number" } } } } }, "example": { "status": "success", "data": { "averagePayloadProcessingTimeMs": 5, "endpointName": "string", "id": "string", "lastUpdateTime": 6, "maxPayloadProcessingTimeMs": 9, "minPayloadProcessingTimeMs": 8, "numPayloadsBadJSON": 3, "numPayloadsFailed": 3, "numPayloadsHandled": 5, "numPayloadsMappingFailed": 9, "numPayloadsNoEndpoint": 9, "numPayloadsNoLiveConfig": 9, "numPayloadsSuccess": 4, "podname": "string", "ratePayloadsHandledPerSecond": 6 } } } } } }, "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "title": "endpointId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/integrations/byoapi/{endpointId}/traffic/payloads": { "get": { "tags": [ "CustomIntegrationTraffic" ], "operationId": "getAllRecentPayloads", "description": "The parameters and request body are for method: getAllRecentPayloads. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "errorMessage": { "type": "string" }, "id": { "type": "string" }, "payload": { "type": "array", "items": { "type": "object" } }, "payloadProcessingResult": { "type": "string" }, "_raw": { "type": "string" }, "sourceIp": { "type": "string" }, "timestamp": { "type": "number" }, "traceId": { "type": "string" } } } }, "example": [ { "errorMessage": "string", "id": "string", "payload": [ {}, {}, {}, {}, {} ], "payloadProcessingResult": "string", "_raw": "string", "sourceIp": "string", "timestamp": 2, "traceId": "string" }, { "errorMessage": "string", "id": "string", "payload": [ {}, {} ], "payloadProcessingResult": "string", "_raw": "string", "sourceIp": "string", "timestamp": 6, "traceId": "string" } ] } } } }, "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "title": "endpointId", "type": "string" } }, { "name": "maxResults", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/integrations/byoapi/{endpointId}/config/test": { "post": { "tags": [ "Deprecated" ], "operationId": "posttestEndpointConfig", "description": "The parameters and request body are for method: posttestEndpointConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "dedupeKeyStatus": { "type": "object" }, "mappingResults": { "type": "array", "items": { "type": "object", "properties": { "dedupeKeyErrors": { "type": "object" }, "errorMessage": { "type": "string" }, "event": { "type": "object", "properties": { "alias": { "type": "string" }, "check": { "type": "string" }, "class": { "type": "string" }, "dedupe_key": { "type": "string" }, "description": { "type": "string" }, "location": { "type": "object" }, "maintenance": { "type": "string" }, "manager": { "type": "string" }, "manager_id": { "type": "string" }, "namespace": { "type": "string" }, "services": { "type": "array", "items": { "type": "string" } }, "severity": { "type": "object" }, "source": { "type": "string" }, "tags": { "type": "object" }, "time": { "type": "string" }, "utc_offset": { "type": "string" } } }, "metric": { "type": "object" }, "payloadProcessingResult": { "type": "string" } } } } } } } }, "example": { "status": "success", "data": { "dedupeKeyStatus": {}, "mappingResults": [ { "dedupeKeyErrors": {}, "errorMessage": "string", "event": { "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "description": "string", "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "services": [ "string", "string", "string", "string", "string" ], "severity": {}, "source": "string", "tags": {}, "time": "string", "utc_offset": "string" }, "metric": {}, "payloadProcessingResult": "string" }, { "dedupeKeyErrors": {}, "errorMessage": "string", "event": { "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "description": "string", "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "services": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "severity": {}, "source": "string", "tags": {}, "time": "string", "utc_offset": "string" }, "metric": {}, "payloadProcessingResult": "string" }, { "dedupeKeyErrors": {}, "errorMessage": "string", "event": { "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "description": "string", "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "services": [ "string", "string" ], "severity": {}, "source": "string", "tags": {}, "time": "string", "utc_offset": "string" }, "metric": {}, "payloadProcessingResult": "string" }, { "dedupeKeyErrors": {}, "errorMessage": "string", "event": { "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "description": "string", "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "services": [ "string", "string" ], "severity": {}, "source": "string", "tags": {}, "time": "string", "utc_offset": "string" }, "metric": {}, "payloadProcessingResult": "string" }, { "dedupeKeyErrors": {}, "errorMessage": "string", "event": { "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "description": "string", "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "services": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "severity": {}, "source": "string", "tags": {}, "time": "string", "utc_offset": "string" }, "metric": {}, "payloadProcessingResult": "string" }, { "dedupeKeyErrors": {}, "errorMessage": "string", "event": { "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "description": "string", "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "services": [ "string", "string", "string", "string", "string", "string", "string" ], "severity": {}, "source": "string", "tags": {}, "time": "string", "utc_offset": "string" }, "metric": {}, "payloadProcessingResult": "string" }, { "dedupeKeyErrors": {}, "errorMessage": "string", "event": { "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "description": "string", "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "services": [ "string", "string", "string", "string", "string" ], "severity": {}, "source": "string", "tags": {}, "time": "string", "utc_offset": "string" }, "metric": {}, "payloadProcessingResult": "string" }, { "dedupeKeyErrors": {}, "errorMessage": "string", "event": { "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "description": "string", "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "services": [ "string", "string", "string" ], "severity": {}, "source": "string", "tags": {}, "time": "string", "utc_offset": "string" }, "metric": {}, "payloadProcessingResult": "string" }, { "dedupeKeyErrors": {}, "errorMessage": "string", "event": { "alias": "string", "check": "string", "class": "string", "dedupe_key": "string", "description": "string", "location": {}, "maintenance": "string", "manager": "string", "manager_id": "string", "namespace": "string", "services": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "severity": {}, "source": "string", "tags": {}, "time": "string", "utc_offset": "string" }, "metric": {}, "payloadProcessingResult": "string" } ] } } } } } }, "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "title": "endpointId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/byoapi/{endpointId}/config/live": { "get": { "tags": [ "Deprecated" ], "operationId": "getgetLiveEndpointConfig", "description": "The parameters and request body are for method: getgetLiveEndpointConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } }, "example": { "status": "success", "data": {} } } } } }, "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "title": "endpointId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Deprecated" ], "operationId": "putupdateLiveEndpointConfig", "description": "The parameters and request body are for method: putupdateLiveEndpointConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } }, "example": { "status": "success", "data": {} } } } } }, "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "title": "endpointId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/byoapi/{endpointId}/config/draft": { "get": { "tags": [ "Deprecated" ], "operationId": "getgetDraftEndpointConfig", "description": "The parameters and request body are for method: getgetDraftEndpointConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } }, "example": { "status": "success", "data": {} } } } } }, "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "title": "endpointId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Deprecated" ], "operationId": "putupdateDraftEndpointConfig", "description": "The parameters and request body are for method: putupdateDraftEndpointConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } }, "example": { "status": "success", "data": {} } } } } }, "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "title": "endpointId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/catalog-files": { "post": { "tags": [ "CatalogFiles" ], "operationId": "uploadNewCatalog", "description": "The parameters and request body are for method: uploadNewCatalog. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "required": { "type": "boolean" }, "type": { "type": "string" } } } } } }, "createdBy": { "type": "string" }, "entries": { "type": "number" }, "lastUpdated": { "type": "number" } } } } }, "example": { "status": "success", "data": { "description": "string", "name": "string", "schema": { "fields": [ { "name": "string", "required": true, "type": "JSON_ARRAY" }, { "name": "string", "required": false, "type": "NUMBER" }, { "name": "string", "required": true, "type": "JSON_ARRAY" } ] }, "createdBy": "string", "entries": 9, "lastUpdated": 10 } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/catalogs/{catalogName}/documents/{documentId}": { "delete": { "tags": [ "Catalogs" ], "operationId": "deleteCatalogDocument", "description": "The parameters and request body are for method: deleteCatalogDocument. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "catalogName", "in": "path", "required": true, "schema": { "title": "catalogName", "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "schema": { "title": "documentId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Catalogs" ], "operationId": "modifyCatalogDocument", "description": "The parameters and request body are for method: modifyCatalogDocument. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "catalogName", "in": "path", "required": true, "schema": { "title": "catalogName", "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "schema": { "title": "documentId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/catalogs": { "get": { "tags": [ "Catalogs" ], "operationId": "getCatalogs", "description": "The parameters and request body are for method: getCatalogs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "required": { "type": "boolean" }, "type": { "type": "string" } } } } } }, "createdBy": { "type": "string" }, "entries": { "type": "number" }, "lastUpdated": { "type": "number" } } } }, "example": [ { "description": "string", "name": "string", "schema": { "fields": [ { "name": "string", "required": false, "type": "BOOLEAN" } ] }, "createdBy": "string", "entries": 3, "lastUpdated": 4 } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Catalogs" ], "operationId": "createNewEmptyCatalog", "description": "The parameters and request body are for method: createNewEmptyCatalog. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "required": { "type": "boolean" }, "type": { "type": "string" } } } } } }, "createdBy": { "type": "string" }, "entries": { "type": "number" }, "lastUpdated": { "type": "number" } } } } }, "example": { "status": "success", "data": { "description": "string", "name": "string", "schema": { "fields": [ { "name": "string", "required": false, "type": "JSON_ARRAY" }, { "name": "string", "required": false, "type": "BOOLEAN" }, { "name": "string", "required": true, "type": "BOOLEAN" }, { "name": "string", "required": false, "type": "JSON_ARRAY" }, { "name": "string", "required": false, "type": "STRING" }, { "name": "string", "required": false, "type": "BOOLEAN" }, { "name": "string", "required": false, "type": "STRING" } ] }, "createdBy": "string", "entries": 9, "lastUpdated": 1 } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/catalogs/{catalogName}/batch": { "post": { "tags": [ "Catalogs" ], "operationId": "addCatalogDocuments", "description": "The parameters and request body are for method: addCatalogDocuments. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "string", "string", "string", "string" ] } } } }, "parameters": [ { "name": "catalogName", "in": "path", "required": true, "schema": { "title": "catalogName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string" } } }, "example": { "body": "body" } } } } } }, "/v1/catalogs/{catalogName}": { "get": { "tags": [ "Catalogs" ], "operationId": "getCatalog", "description": "The parameters and request body are for method: getCatalog. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "required": { "type": "boolean" }, "type": { "type": "string" } } } } } }, "createdBy": { "type": "string" }, "entries": { "type": "number" }, "lastUpdated": { "type": "number" } } } } }, "example": { "status": "success", "data": { "description": "string", "name": "string", "schema": { "fields": [ { "name": "string", "required": true, "type": "JSON_ARRAY" }, { "name": "string", "required": true, "type": "BOOLEAN" }, { "name": "string", "required": true, "type": "BOOLEAN" }, { "name": "string", "required": true, "type": "NUMBER" }, { "name": "string", "required": true, "type": "NUMBER" }, { "name": "string", "required": false, "type": "JSON_ARRAY" }, { "name": "string", "required": false, "type": "JSON_ARRAY" } ] }, "createdBy": "string", "entries": 8, "lastUpdated": 1 } } } } } }, "parameters": [ { "name": "catalogName", "in": "path", "required": true, "schema": { "title": "catalogName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Catalogs" ], "operationId": "deleteCatalog", "description": "The parameters and request body are for method: deleteCatalog. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "catalogName", "in": "path", "required": true, "schema": { "title": "catalogName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/catalogs/{catalogName}/documents": { "get": { "tags": [ "Catalogs" ], "operationId": "queryCatalogDocuments", "description": "The parameters and request body are for method: queryCatalogDocuments. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "example": [ {}, {}, {} ] } } } }, "parameters": [ { "name": "catalogName", "in": "path", "required": true, "schema": { "title": "catalogName", "type": "string" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "object" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Catalogs" ], "operationId": "addCatalogDocument", "description": "The parameters and request body are for method: addCatalogDocument. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "catalogName", "in": "path", "required": true, "schema": { "title": "catalogName", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/catalogs/{catalogName}/search": { "post": { "tags": [ "Catalogs" ], "operationId": "searchCatalogDocuments", "description": "The parameters and request body are for method: searchCatalogDocuments. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "example": [ {}, {} ] } } } }, "parameters": [ { "name": "catalogName", "in": "path", "required": true, "schema": { "title": "catalogName", "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/azure/appinsights/{name}": { "get": { "tags": [ "Appinsights" ], "operationId": "getIntegrationByName", "description": "The parameters and request body are for method: getIntegrationByName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "createdBy": { "type": "string" }, "credentialName": { "type": "string" }, "metricCount": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "string" } } } } }, "example": { "status": "success", "data": { "createdBy": "string", "credentialName": "string", "metricCount": 1, "name": "string", "status": "NONE" } } } } } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "title": "name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Appinsights" ], "operationId": "deleteIntegrationByName", "description": "The parameters and request body are for method: deleteIntegrationByName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "title": "name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Appinsights" ], "operationId": "editIntegration", "description": "The parameters and request body are for method: editIntegration. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "createdBy": { "type": "string" }, "credentialName": { "type": "string" }, "metricCount": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "string" } } } } }, "example": { "status": "success", "data": { "createdBy": "string", "credentialName": "string", "metricCount": 4, "name": "string", "status": "NONE" } } } } } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "title": "name", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/azure/appinsights/test": { "post": { "tags": [ "Appinsights" ], "operationId": "testIntegrationCredentials", "description": "The parameters and request body are for method: testIntegrationCredentials. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/azure/appinsights": { "get": { "tags": [ "Appinsights" ], "operationId": "listIntegrations", "description": "The parameters and request body are for method: listIntegrations. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "createdBy": { "type": "string" }, "credentialName": { "type": "string" }, "metricCount": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "string" } } } }, "example": [ { "createdBy": "string", "credentialName": "string", "metricCount": 10, "name": "string", "status": "LIMITED" } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Appinsights" ], "operationId": "createNewIntegration", "description": "The parameters and request body are for method: createNewIntegration. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "createdBy": { "type": "string" }, "credentialName": { "type": "string" }, "metricCount": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "string" } } } } }, "example": { "status": "success", "data": { "createdBy": "string", "credentialName": "string", "metricCount": 2, "name": "string", "status": "STOPPED" } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/aws/{name}/detectors": { "get": { "tags": [ "Cloudwatch" ], "operationId": "getCloudwatchDetectors", "description": "The parameters and request body are for method: getCloudwatchDetectors. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "detector": { "type": "object" }, "fully_qualified_moob": { "type": "string" }, "metric": { "type": "string" }, "uuid": { "type": "string" }, "version": { "type": "string" } } } }, "example": [ { "detector": {}, "fully_qualified_moob": "string", "metric": "string", "uuid": "string", "version": "string" }, { "detector": {}, "fully_qualified_moob": "string", "metric": "string", "uuid": "string", "version": "string" }, { "detector": {}, "fully_qualified_moob": "string", "metric": "string", "uuid": "string", "version": "string" }, { "detector": {}, "fully_qualified_moob": "string", "metric": "string", "uuid": "string", "version": "string" } ] } } } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "title": "name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Cloudwatch" ], "operationId": "updateCloudwatchDetectors", "description": "The parameters and request body are for method: updateCloudwatchDetectors. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "title": "name", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/aws/{name}": { "delete": { "tags": [ "Cloudwatch" ], "operationId": "deleteCloudwatch", "description": "The parameters and request body are for method: deleteCloudwatch. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "title": "name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Cloudwatch" ], "operationId": "updateCloudwatch", "description": "The parameters and request body are for method: updateCloudwatch. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "title": "name", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/aws/{name}/status": { "get": { "tags": [ "Cloudwatch" ], "operationId": "getCloudwatchStatus", "description": "The parameters and request body are for method: getCloudwatchStatus. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "name": { "type": "string" }, "regions": { "type": "object" } } } } }, "example": { "status": "success", "data": { "name": "string", "regions": {} } } } } } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "title": "name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/integrations/aws/account": { "get": { "tags": [ "Cloudwatch" ], "operationId": "cloudwatchAccountId", "description": "The parameters and request body are for method: cloudwatchAccountId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "accountId": { "type": "string" } } } } }, "example": { "status": "success", "data": { "accountId": "string" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/integrations/aws/credentials/test": { "post": { "tags": [ "Cloudwatch" ], "operationId": "testCloudwatch", "description": "The parameters and request body are for method: testCloudwatch. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "err": { "type": "object", "properties": { "msg": { "type": "string" }, "regions": { "type": "array", "items": { "type": "object", "properties": { "exists": { "type": "boolean" }, "msg": { "type": "string" }, "region": { "type": "string" } } } } } }, "success": { "type": "boolean" }, "validationResult": { "type": "object" }, "warning": { "type": "string" } } } } }, "example": { "status": "success", "data": { "err": { "msg": "string", "regions": [ { "exists": false, "msg": "string", "region": "string" }, { "exists": true, "msg": "string", "region": "string" }, { "exists": false, "msg": "string", "region": "string" }, { "exists": false, "msg": "string", "region": "string" }, { "exists": false, "msg": "string", "region": "string" }, { "exists": true, "msg": "string", "region": "string" }, { "exists": true, "msg": "string", "region": "string" }, { "exists": false, "msg": "string", "region": "string" } ] }, "success": true, "validationResult": {}, "warning": "string" } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/aws": { "get": { "tags": [ "Cloudwatch" ], "operationId": "listCloudwatch", "description": "The parameters and request body are for method: listCloudwatch. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "aws_credential_name": { "type": "string" }, "cw_custom_metrics": { "type": "boolean" }, "cw_alarms": { "type": "boolean" }, "cw_source_prepend": { "type": "boolean" }, "name": { "type": "string" }, "aws_regions": { "type": "array", "items": { "type": "string" } }, "service_list": { "type": "array", "items": { "type": "string" } }, "customMetric": { "type": "boolean" }, "cwAlarm": { "type": "boolean" }, "sourcePrepend": { "type": "boolean" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "status": { "type": "string" } } } }, "example": [ { "aws_credential_name": "string", "cw_custom_metrics": true, "cw_alarms": true, "cw_source_prepend": true, "name": "string", "aws_regions": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "service_list": [ "MEDIA_TAILOR", "KINESIS_ANALYTICS", "WORK_SPACES", "CLOUD_H_S_M", "TRANSIT_GATEWAY", "CASSANDRA", "DOC_D_B", "BILLING", "CHATBOT" ], "customMetric": false, "cwAlarm": false, "sourcePrepend": true, "id": { "counter": 6, "randomValue1": 1, "randomValue2": 2, "timestamp": 2, "date": "string" }, "status": "string" }, { "aws_credential_name": "string", "cw_custom_metrics": true, "cw_alarms": false, "cw_source_prepend": false, "name": "string", "aws_regions": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "service_list": [ "V_P_N", "CODE_BUILD", "CLOUD_FRONT", "TRANSIT_GATEWAY", "CONNECT", "F_SX" ], "customMetric": true, "cwAlarm": false, "sourcePrepend": true, "id": { "counter": 10, "randomValue1": 10, "randomValue2": 1, "timestamp": 5, "date": "string" }, "status": "string" }, { "aws_credential_name": "string", "cw_custom_metrics": true, "cw_alarms": true, "cw_source_prepend": false, "name": "string", "aws_regions": [ "string" ], "service_list": [ "CLOUD_FRONT", "S_D_K_METRICS", "POLLY", "NETWORK_E_L_B", "CLOUD_SEARCH", "SERVICE_CATALOG" ], "customMetric": false, "cwAlarm": true, "sourcePrepend": false, "id": { "counter": 5, "randomValue1": 6, "randomValue2": 10, "timestamp": 7, "date": "string" }, "status": "string" }, { "aws_credential_name": "string", "cw_custom_metrics": false, "cw_alarms": false, "cw_source_prepend": true, "name": "string", "aws_regions": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "service_list": [ "SERVICE_CATALOG", "GROUND_STATION", "KINESIS_VIDEO", "LEX", "TRANSIT_GATEWAY", "APPLICATION_E_L_B", "LOGS", "MEDIA_CONVERT" ], "customMetric": true, "cwAlarm": false, "sourcePrepend": true, "id": { "counter": 10, "randomValue1": 9, "randomValue2": 2, "timestamp": 9, "date": "string" }, "status": "string" } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Cloudwatch" ], "operationId": "createCloudwatch", "description": "The parameters and request body are for method: createCloudwatch. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/collector-installer/curl": { "get": { "tags": [ "CollectorInstaller" ], "operationId": "getInstallCommand", "description": "The parameters and request body are for method: getInstallCommand. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "platform", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/collector-installer/download": { "get": { "tags": [ "CollectorInstaller" ], "operationId": "download", "description": "The parameters and request body are for method: download. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "arch", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/collector-installer/latest-version": { "get": { "tags": [ "CollectorInstaller" ], "operationId": "latestVersion", "description": "The parameters and request body are for method: latestVersion. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "arch", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/collector-installer/script": { "get": { "tags": [ "CollectorInstaller" ], "operationId": "getInstallScript", "description": "The parameters and request body are for method: getInstallScript. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "platform", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/collectors": { "get": { "tags": [ "Collectors" ], "operationId": "getCollectors", "description": "The parameters and request body are for method: getCollectors. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "host": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "last_updated": { "type": "object", "properties": { "nanos": { "type": "number" }, "seconds": { "type": "number" }, "epochSecond": { "type": "number" }, "nano": { "type": "number" } } }, "uptime": { "type": "number" }, "version": { "type": "string" } } } }, "example": [ { "host": "string", "id": { "counter": 5, "randomValue1": 1, "randomValue2": 1, "timestamp": 2, "date": "string" }, "last_updated": { "nanos": 3, "seconds": 8, "epochSecond": 8, "nano": 8 }, "uptime": 5, "version": "string" }, { "host": "string", "id": { "counter": 2, "randomValue1": 10, "randomValue2": 4, "timestamp": 3, "date": "string" }, "last_updated": { "nanos": 10, "seconds": 1, "epochSecond": 3, "nano": 10 }, "uptime": 6, "version": "string" } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Collectors" ], "operationId": "registerCollector", "description": "The parameters and request body are for method: registerCollector. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "host": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "last_updated": { "type": "object", "properties": { "nanos": { "type": "number" }, "seconds": { "type": "number" }, "epochSecond": { "type": "number" }, "nano": { "type": "number" } } }, "uptime": { "type": "number" }, "version": { "type": "string" } } } } }, "example": { "status": "success", "data": { "host": "string", "id": { "counter": 5, "randomValue1": 6, "randomValue2": 7, "timestamp": 7, "date": "string" }, "last_updated": { "nanos": 3, "seconds": 3, "epochSecond": 4, "nano": 9 }, "uptime": 4, "version": "string" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string" } } }, "example": { "body": "body" } } } } } }, "/v2/collectors/{id}": { "delete": { "tags": [ "Collectors" ], "operationId": "deleteCollector", "description": "The parameters and request body are for method: deleteCollector. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/collectors/{id}/heartbeats": { "post": { "tags": [ "Collectors" ], "operationId": "processHeartbeats", "description": "The parameters and request body are for method: processHeartbeats. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string" } } }, "example": { "body": "body" } } } } } }, "/v2/collectors/{id}/logs": { "get": { "tags": [ "Collectors" ], "operationId": "getLogs", "description": "The parameters and request body are for method: getLogs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "component": { "type": "string" }, "level": { "type": "string" }, "message": { "type": "string" }, "timestamp": { "type": "object", "properties": { "nanos": { "type": "number" }, "seconds": { "type": "number" }, "epochSecond": { "type": "number" }, "nano": { "type": "number" } } } } } }, "example": [ { "component": "string", "level": "ERROR", "message": "string", "timestamp": { "nanos": 2, "seconds": 3, "epochSecond": 9, "nano": 4 } }, { "component": "string", "level": "INFO", "message": "string", "timestamp": { "nanos": 4, "seconds": 4, "epochSecond": 4, "nano": 2 } } ] } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Collectors" ], "operationId": "saveLogs", "description": "The parameters and request body are for method: saveLogs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string" } } }, "example": { "body": "body" } } } } } }, "/v2/collectors/{id}/messages": { "get": { "tags": [ "Collectors" ], "operationId": "getAndClearMessages", "description": "The parameters and request body are for method: getAndClearMessages. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "collector_action": { "type": "string" }, "collector_id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } } } } }, "example": [ { "collector_action": "UPDATE_CONFIG", "collector_id": { "counter": 8, "randomValue1": 7, "randomValue2": 10, "timestamp": 10, "date": "string" }, "id": { "counter": 6, "randomValue1": 3, "randomValue2": 5, "timestamp": 7, "date": "string" } }, { "collector_action": "UPDATE_CONFIG", "collector_id": { "counter": 6, "randomValue1": 9, "randomValue2": 7, "timestamp": 4, "date": "string" }, "id": { "counter": 1, "randomValue1": 9, "randomValue2": 1, "timestamp": 10, "date": "string" } } ] } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/collectors/{id}/topology": { "get": { "tags": [ "Collectors" ], "operationId": "generateTopology", "description": "The parameters and request body are for method: generateTopology. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/plugin-config": { "get": { "tags": [ "PluginConfig" ], "operationId": "findPluginConfig", "description": "The parameters and request body are for method: findPluginConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "collector_id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "collector_version": { "type": "string" }, "configuration": { "type": "object" }, "enabled": { "type": "boolean" }, "plugin_name": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } } } } }, "example": [ { "collector_id": { "counter": 10, "randomValue1": 8, "randomValue2": 8, "timestamp": 1, "date": "string" }, "collector_version": "string", "configuration": {}, "enabled": false, "plugin_name": "string", "id": { "counter": 8, "randomValue1": 8, "randomValue2": 10, "timestamp": 1, "date": "string" } } ] } } } }, "parameters": [ { "name": "collectorId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pluginName", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "PluginConfig" ], "operationId": "createPluginConfig", "description": "The parameters and request body are for method: createPluginConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "collector_id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "collector_version": { "type": "string" }, "configuration": { "type": "object" }, "enabled": { "type": "boolean" }, "plugin_name": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } } } } } }, "example": { "status": "success", "data": { "collector_id": { "counter": 4, "randomValue1": 3, "randomValue2": 10, "timestamp": 6, "date": "string" }, "collector_version": "string", "configuration": {}, "enabled": false, "plugin_name": "string", "id": { "counter": 5, "randomValue1": 8, "randomValue2": 1, "timestamp": 4, "date": "string" } } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "PluginConfig" ], "operationId": "deleteMatchingPluginConfig", "description": "The parameters and request body are for method: deleteMatchingPluginConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "collectorId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/plugin-config/{id}": { "get": { "tags": [ "PluginConfig" ], "operationId": "getPluginConfig", "description": "The parameters and request body are for method: getPluginConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "collector_id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "collector_version": { "type": "string" }, "configuration": { "type": "object" }, "enabled": { "type": "boolean" }, "plugin_name": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } } } } } }, "example": { "status": "success", "data": { "collector_id": { "counter": 4, "randomValue1": 8, "randomValue2": 1, "timestamp": 6, "date": "string" }, "collector_version": "string", "configuration": {}, "enabled": false, "plugin_name": "string", "id": { "counter": 10, "randomValue1": 10, "randomValue2": 9, "timestamp": 3, "date": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "PluginConfig" ], "operationId": "deletePluginConfig", "description": "The parameters and request body are for method: deletePluginConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "PluginConfig" ], "operationId": "updatePluginConfig", "description": "The parameters and request body are for method: updatePluginConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "collector_id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "collector_version": { "type": "string" }, "configuration": { "type": "object" }, "enabled": { "type": "boolean" }, "plugin_name": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } } } } } }, "example": { "status": "success", "data": { "collector_id": { "counter": 5, "randomValue1": 3, "randomValue2": 5, "timestamp": 2, "date": "string" }, "collector_version": "string", "configuration": {}, "enabled": false, "plugin_name": "string", "id": { "counter": 10, "randomValue1": 10, "randomValue2": 2, "timestamp": 10, "date": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/plugins": { "get": { "tags": [ "Plugins" ], "operationId": "getPlugins", "description": "The parameters and request body are for method: getPlugins. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "collector_version": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" }, "template": { "type": "string" } } } }, "example": [ { "collector_version": "string", "name": "string", "parameters": {}, "template": "string" }, { "collector_version": "string", "name": "string", "parameters": {}, "template": "string" }, { "collector_version": "string", "name": "string", "parameters": {}, "template": "string" } ] } } } }, "parameters": [ { "name": "collectorVersion", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/collectors/install": { "get": { "tags": [ "Collector" ], "operationId": "unixInstaller", "description": "The parameters and request body are for method: unixInstaller. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/collectors/{uuid}/discovery": { "post": { "tags": [ "Collector" ], "operationId": "postCollectorsDiscovery", "description": "The parameters and request body are for method: postCollectorsDiscovery. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/collectors/curl": { "get": { "tags": [ "Collector" ], "operationId": "getCurlCommand", "description": "The parameters and request body are for method: getCurlCommand. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "command": { "type": "string" } } } } }, "example": { "status": "success", "data": { "command": "string" } } } } } }, "parameters": [ { "name": "collectOnStartup", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "instance", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/collectors/install/windows": { "get": { "tags": [ "Collector" ], "operationId": "windowsInstaller", "description": "The parameters and request body are for method: windowsInstaller. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/collectors/{uuid}/actions": { "post": { "tags": [ "Collector" ], "operationId": "action", "description": "The parameters and request body are for method: action. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/collectors/{uuid}/restart": { "post": { "tags": [ "Collector" ], "operationId": "restartCollector", "description": "The parameters and request body are for method: restartCollector. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/collectors/{uuid}/metrics": { "get": { "tags": [ "Collector" ], "operationId": "getCollectorMetrics", "description": "The parameters and request body are for method: getCollectorMetrics. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "detector": { "type": "object" }, "fully_qualified_moob": { "type": "string" }, "metric": { "type": "string" }, "uuid": { "type": "string" }, "version": { "type": "string" } } } } } }, "example": { "status": "success", "data": [ { "detector": {}, "fully_qualified_moob": "string", "metric": "string", "uuid": "string", "version": "string" }, { "detector": {}, "fully_qualified_moob": "string", "metric": "string", "uuid": "string", "version": "string" }, { "detector": {}, "fully_qualified_moob": "string", "metric": "string", "uuid": "string", "version": "string" }, { "detector": {}, "fully_qualified_moob": "string", "metric": "string", "uuid": "string", "version": "string" }, { "detector": {}, "fully_qualified_moob": "string", "metric": "string", "uuid": "string", "version": "string" }, { "detector": {}, "fully_qualified_moob": "string", "metric": "string", "uuid": "string", "version": "string" }, { "detector": {}, "fully_qualified_moob": "string", "metric": "string", "uuid": "string", "version": "string" } ] } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } }, { "name": "fullyQualifiedMoob", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "metric", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Collector" ], "operationId": "postCollectorMetrics", "description": "The parameters and request body are for method: postCollectorMetrics. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/collectors/datums": { "post": { "tags": [ "Datums" ], "operationId": "getDatums", "description": "The parameters and request body are for method: getDatums. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/collectors/metrics": { "get": { "tags": [ "Collectors" ], "operationId": "oldMetricsEndpoint", "description": "The parameters and request body are for method: oldMetricsEndpoint. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/collectors/latest/{arch}/{platform}": { "get": { "tags": [ "Collectors" ], "operationId": "getLatestVersion", "description": "The parameters and request body are for method: getLatestVersion. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "arch", "in": "path", "required": true, "schema": { "title": "arch", "type": "string" } }, { "name": "platform", "in": "path", "required": true, "schema": { "title": "platform", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/collectors/tar/{arch}/{platform}": { "get": { "tags": [ "Collectors" ], "operationId": "fetchTar", "description": "The parameters and request body are for method: fetchTar. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "arch", "in": "path", "required": true, "schema": { "title": "arch", "type": "string" } }, { "name": "platform", "in": "path", "required": true, "schema": { "title": "platform", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/config": { "get": { "tags": [ "Config" ], "operationId": "getConfig", "description": "The parameters and request body are for method: getConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "attributes", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "component", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "encrypt", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "includeParent", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "owner", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "tenant", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Config" ], "operationId": "setConfig", "description": "The parameters and request body are for method: setConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Config" ], "operationId": "deleteConfig", "description": "The parameters and request body are for method: deleteConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "attributes", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "component", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "encrypt", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "fuzzy", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "owner", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "tenant", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Config" ], "operationId": "patchConfig", "description": "The parameters and request body are for method: patchConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/config/batch": { "delete": { "tags": [ "Config" ], "operationId": "bulkDeleteConfig", "description": "The parameters and request body are for method: bulkDeleteConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string" } } }, "example": { "body": "body" } } } } } }, "/v1/config/search": { "get": { "tags": [ "Config" ], "operationId": "searchConfig", "description": "The parameters and request body are for method: searchConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object" } } } }, "example": { "status": "success", "data": [ {}, {}, {}, {}, {}, {}, {}, {} ] } } } } }, "parameters": [ { "name": "attributes", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "component", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "encrypt", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "fuzzy", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "owner", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "tenant", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/correlation-definitions/{definitionName}": { "delete": { "tags": [ "CorrelationDefinitions" ], "operationId": "deleteCorrDefWithName", "description": "The parameters and request body are for method: deleteCorrDefWithName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "definitionName", "in": "path", "required": true, "schema": { "title": "definitionName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "CorrelationDefinitions" ], "operationId": "patchCorrDefWithName", "description": "The parameters and request body are for method: patchCorrDefWithName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "definitionName", "in": "path", "required": true, "schema": { "title": "definitionName", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/correlation-definitions/id/{uuid}": { "delete": { "tags": [ "CorrelationDefinitions" ], "operationId": "deleteCorrDef", "description": "The parameters and request body are for method: deleteCorrDef. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "CorrelationDefinitions" ], "operationId": "patchCorrDef", "description": "The parameters and request body are for method: patchCorrDef. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/correlation-definitions": { "get": { "tags": [ "CorrelationDefinitions" ], "operationId": "getCorrDef", "description": "The parameters and request body are for method: getCorrDef. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "correlation_time_period": { "type": "number" }, "fields_to_correlate": { "type": "object" }, "incident_description": { "type": "string" }, "name": { "type": "string" }, "scope": { "type": "string" }, "uuid": { "type": "string" } } } } } }, "example": { "status": "success", "data": [ { "correlation_time_period": 900, "fields_to_correlate": {}, "incident_description": "unique_count(source) Source: unique(source,3) Affected unique(service,3) unique(class,3)", "name": "Similar Sources", "scope": "class = \"External\" AND \"event count\" > 2", "uuid": "string" }, { "correlation_time_period": 900, "fields_to_correlate": {}, "incident_description": "unique_count(source) Source: unique(source,3) Affected unique(service,3) unique(class,3)", "name": "Similar Sources", "scope": "class = \"External\" AND \"event count\" > 2", "uuid": "string" }, { "correlation_time_period": 900, "fields_to_correlate": {}, "incident_description": "unique_count(source) Source: unique(source,3) Affected unique(service,3) unique(class,3)", "name": "Similar Sources", "scope": "class = \"External\" AND \"event count\" > 2", "uuid": "string" }, { "correlation_time_period": 900, "fields_to_correlate": {}, "incident_description": "unique_count(source) Source: unique(source,3) Affected unique(service,3) unique(class,3)", "name": "Similar Sources", "scope": "class = \"External\" AND \"event count\" > 2", "uuid": "string" }, { "correlation_time_period": 900, "fields_to_correlate": {}, "incident_description": "unique_count(source) Source: unique(source,3) Affected unique(service,3) unique(class,3)", "name": "Similar Sources", "scope": "class = \"External\" AND \"event count\" > 2", "uuid": "string" }, { "correlation_time_period": 900, "fields_to_correlate": {}, "incident_description": "unique_count(source) Source: unique(source,3) Affected unique(service,3) unique(class,3)", "name": "Similar Sources", "scope": "class = \"External\" AND \"event count\" > 2", "uuid": "string" }, { "correlation_time_period": 900, "fields_to_correlate": {}, "incident_description": "unique_count(source) Source: unique(source,3) Affected unique(service,3) unique(class,3)", "name": "Similar Sources", "scope": "class = \"External\" AND \"event count\" > 2", "uuid": "string" }, { "correlation_time_period": 900, "fields_to_correlate": {}, "incident_description": "unique_count(source) Source: unique(source,3) Affected unique(service,3) unique(class,3)", "name": "Similar Sources", "scope": "class = \"External\" AND \"event count\" > 2", "uuid": "string" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "CorrelationDefinitions" ], "operationId": "createCorrDef", "description": "The parameters and request body are for method: createCorrDef. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/tracking-data": { "get": { "tags": [ "TrackingData" ], "operationId": "get", "description": "The parameters and request body are for method: get. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "alertCount": { "type": "number" }, "alertCountTimeMillis": { "type": "number" }, "anomalyCount": { "type": "number" }, "anomalyCountTimeMillis": { "type": "number" }, "anomalyDetected": { "type": "boolean" }, "anomalyDetectedTimeMillis": { "type": "number" }, "correlationModified": { "type": "boolean" }, "correlationModifiedTimeMillis": { "type": "number" }, "datumCount": { "type": "number" }, "datumCountTimeMillis": { "type": "number" }, "eventCount": { "type": "number" }, "eventCountTimeMillis": { "type": "number" }, "eventsIngested": { "type": "boolean" }, "eventsIngestedTimeMillis": { "type": "number" }, "incidentCount": { "type": "number" }, "incidentCountTimeMillis": { "type": "number" }, "instanceOwner": { "type": "string" }, "lastUpdatedTimeMillis": { "type": "number" }, "metricsIngested": { "type": "boolean" }, "metricsIngestedTimeMillis": { "type": "number" }, "multiAlertIncidentCreated": { "type": "boolean" }, "multiAlertIncidentCreatedTimeMillis": { "type": "number" }, "userLoggedIn": { "type": "boolean" }, "userLoggedInTimeMillis": { "type": "number" }, "version": { "type": "string" } } } } }, "example": { "status": "success", "data": { "alertCount": 4, "alertCountTimeMillis": 6, "anomalyCount": 3, "anomalyCountTimeMillis": 7, "anomalyDetected": true, "anomalyDetectedTimeMillis": 8, "correlationModified": true, "correlationModifiedTimeMillis": 10, "datumCount": 9, "datumCountTimeMillis": 9, "eventCount": 2, "eventCountTimeMillis": 10, "eventsIngested": true, "eventsIngestedTimeMillis": 5, "incidentCount": 5, "incidentCountTimeMillis": 10, "instanceOwner": "string", "lastUpdatedTimeMillis": 8, "metricsIngested": true, "metricsIngestedTimeMillis": 10, "multiAlertIncidentCreated": false, "multiAlertIncidentCreatedTimeMillis": 4, "userLoggedIn": false, "userLoggedInTimeMillis": 10, "version": "string" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/integrations/datadog/{name}": { "get": { "tags": [ "Datadog" ], "operationId": "getDatadogIntegration", "description": "The parameters and request body are for method: getDatadogIntegration. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "credentialName": { "type": "string" }, "name": { "type": "string" }, "types": { "type": "array", "items": { "type": "string" } }, "eventCount": { "type": "number" }, "metricCount": { "type": "number" }, "status": { "type": "string" } } } } }, "example": { "status": "success", "data": { "credentialName": "string", "name": "string", "types": [ "string", "string", "string", "string", "string", "string", "string" ], "eventCount": 9, "metricCount": 3, "status": "LIMITED" } } } } } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "title": "name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Datadog" ], "operationId": "deleteDatadogIntegration", "description": "The parameters and request body are for method: deleteDatadogIntegration. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "title": "name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Datadog" ], "operationId": "updateDatadogIntegration", "description": "The parameters and request body are for method: updateDatadogIntegration. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "title": "name", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/datadog/credentials/test": { "post": { "tags": [ "Datadog" ], "operationId": "testDatadogCredentials", "description": "The parameters and request body are for method: testDatadogCredentials. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/datadog": { "get": { "tags": [ "Datadog" ], "operationId": "getAllDatadogIntegrations", "description": "The parameters and request body are for method: getAllDatadogIntegrations. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "credentialName": { "type": "string" }, "name": { "type": "string" }, "types": { "type": "array", "items": { "type": "string" } }, "eventCount": { "type": "number" }, "metricCount": { "type": "number" }, "status": { "type": "string" } } } }, "example": [ { "credentialName": "string", "name": "string", "types": [ "string", "string", "string", "string", "string" ], "eventCount": 2, "metricCount": 9, "status": "LIMITED" } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Datadog" ], "operationId": "postDatadogIntegration", "description": "The parameters and request body are for method: postDatadogIntegration. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "credentialName": { "type": "string" }, "name": { "type": "string" }, "types": { "type": "array", "items": { "type": "string" } }, "eventCount": { "type": "number" }, "metricCount": { "type": "number" }, "status": { "type": "string" } } } } }, "example": { "status": "success", "data": { "credentialName": "string", "name": "string", "types": [ "string", "string" ], "eventCount": 2, "metricCount": 7, "status": "STARTING" } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/events-columns": { "get": { "tags": [ "EventColumns" ], "operationId": "getColumns", "description": "The parameters and request body are for method: getColumns. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "object", "properties": { "internalName": { "type": "string" }, "type": { "type": "string" }, "uiName": { "type": "string" } } } } } }, "status": { "type": "string" } } }, "example": { "data": { "fields": [ { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" } ] }, "status": "success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/integrations/events": { "post": { "tags": [ "EventsIntegration" ], "operationId": "postEvents", "description": "The parameters and request body are for method: postEvents. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" } } }, "example": { "status": "success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string" } } }, "example": { "body": "body" } } } } } }, "/v1/index/reindex": { "post": { "tags": [ "Reindex" ], "operationId": "reindex", "description": "The parameters and request body are for method: reindex. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/index/reindex-status": { "get": { "tags": [ "Reindex" ], "operationId": "getReindexStatus", "description": "The parameters and request body are for method: getReindexStatus. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "previousRun": { "type": "string" }, "running": { "type": "boolean" }, "type": { "type": "string" } } } } }, "example": { "status": "success", "data": { "previousRun": "string", "running": false, "type": "string" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/incidents-columns": { "get": { "tags": [ "IncidentColumnsResource" ], "operationId": "incidentDtoColumnNames", "description": "The parameters and request body are for method: incidentDtoColumnNames. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "object", "properties": { "internalName": { "type": "string" }, "type": { "type": "string" }, "uiName": { "type": "string" } } } } } }, "status": { "type": "string" } } }, "example": { "data": { "fields": [ { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" }, { "internalName": "string", "type": "string", "uiName": "string" } ] }, "status": "success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/incidents/count": { "get": { "tags": [ "IncidentResource" ], "operationId": "incidentsCount", "description": "The parameters and request body are for method: incidentsCount. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "utcOffset", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/incidents": { "get": { "tags": [ "IncidentResource" ], "operationId": "listIncidents", "description": "The parameters and request body are for method: listIncidents. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "properties": { "assignee": { "type": "string" }, "description": { "type": "string" }, "first_event_time": { "type": "number" }, "last_event_time": { "type": "number" }, "severity": { "type": "string" }, "status": { "type": "string" }, "classes": { "type": "array", "items": { "type": "string" } }, "closed_on": { "type": "number" }, "created_at": { "type": "number" }, "in_progress_on": { "type": "number" }, "incident_id": { "type": "number" }, "last_state_change": { "type": "number" }, "resolved_on": { "type": "number" }, "services": { "type": "array", "items": { "type": "string" } }, "superseded_by": { "type": "number" }, "tags": { "type": "object" }, "total_alerts": { "type": "number" }, "types": { "type": "array", "items": { "type": "string" } } } } } } } } }, "example": { "status": "success", "data": { "result": [ { "assignee": "test@moogsoft.com", "description": "1 Source: www.your-source.com Affected retail, support\n", "first_event_time": 1607985505, "last_event_time": 1607985505, "severity": "major", "status": "open", "classes": [ "string", "string", "string", "string", "string", "string", "string" ], "closed_on": 1607985505, "created_at": 1607985505, "in_progress_on": 1607985505, "incident_id": 101, "last_state_change": 1607985505, "resolved_on": 1607985505, "services": [ "string", "string", "string", "string" ], "superseded_by": 33, "tags": {}, "total_alerts": 30, "types": [ "string", "string", "string" ] }, { "assignee": "test@moogsoft.com", "description": "1 Source: www.your-source.com Affected retail, support\n", "first_event_time": 1607985505, "last_event_time": 1607985505, "severity": "major", "status": "closed", "classes": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "closed_on": 1607985505, "created_at": 1607985505, "in_progress_on": 1607985505, "incident_id": 101, "last_state_change": 1607985505, "resolved_on": 1607985505, "services": [ "string", "string", "string", "string" ], "superseded_by": 33, "tags": {}, "total_alerts": 30, "types": [ "string", "string", "string", "string", "string" ] } ] } } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "utcOffset", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "IncidentResource" ], "operationId": "updateIncidents", "description": "The parameters and request body are for method: updateIncidents. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/incidents/{incidentId}": { "patch": { "tags": [ "IncidentResource" ], "operationId": "updateIncident", "description": "The parameters and request body are for method: updateIncident. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "incidentId", "in": "path", "required": true, "schema": { "title": "incidentId", "type": "number" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/incidents-summaries": { "get": { "tags": [ "IncidentSummariesResource" ], "operationId": "getIncidentSummaries", "description": "The parameters and request body are for method: getIncidentSummaries. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "begin": { "type": "number" }, "bin_size": { "type": "number" }, "bins": { "type": "array", "items": { "type": "array", "items": { "type": "object" } } }, "end": { "type": "number" }, "num_bins": { "type": "number" }, "prev_avg": { "type": "number" } } } } }, "example": { "status": "success", "data": { "begin": 9, "bin_size": 7, "bins": [ [ {}, {}, {}, {}, {}, {}, {}, {}, {} ] ], "end": 4, "num_bins": 1, "prev_avg": 8 } } } } } }, "parameters": [ { "name": "begin", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "buckets", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/incident-tags-config": { "get": { "tags": [ "IncidentTagsConfig" ], "operationId": "getIncidentTagsConfig", "description": "The parameters and request body are for method: getIncidentTagsConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "tagsPropagation": { "type": "boolean" } } } } }, "example": { "status": "success", "data": { "tags": [ "string", "string", "string", "string", "string" ], "tagsPropagation": false } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "IncidentTagsConfig" ], "operationId": "patchIncidentTagsConfig", "description": "The parameters and request body are for method: patchIncidentTagsConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integration-logs": { "get": { "tags": [ "IntegrationLogs" ], "operationId": "getIntegrationLogs", "description": "The parameters and request body are for method: getIntegrationLogs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "component": { "type": "string" }, "integration_id": { "type": "string" }, "level": { "type": "string" }, "message": { "type": "string" }, "service": { "type": "string" }, "tenant": { "type": "string" }, "timestamp": { "type": "object", "properties": { "nanos": { "type": "number" }, "seconds": { "type": "number" }, "epochSecond": { "type": "number" }, "nano": { "type": "number" } } } } } } } }, "example": { "status": "success", "data": [ { "component": "string", "integration_id": "string", "level": "DEBUG", "message": "string", "service": "string", "tenant": "string", "timestamp": { "nanos": 2, "seconds": 1, "epochSecond": 5, "nano": 10 } }, { "component": "string", "integration_id": "string", "level": "INFO", "message": "string", "service": "string", "tenant": "string", "timestamp": { "nanos": 5, "seconds": 2, "epochSecond": 10, "nano": 1 } }, { "component": "string", "integration_id": "string", "level": "WARN", "message": "string", "service": "string", "tenant": "string", "timestamp": { "nanos": 5, "seconds": 10, "epochSecond": 2, "nano": 10 } }, { "component": "string", "integration_id": "string", "level": "ERROR", "message": "string", "service": "string", "tenant": "string", "timestamp": { "nanos": 10, "seconds": 3, "epochSecond": 8, "nano": 5 } }, { "component": "string", "integration_id": "string", "level": "TRACE", "message": "string", "service": "string", "tenant": "string", "timestamp": { "nanos": 2, "seconds": 7, "epochSecond": 2, "nano": 10 } }, { "component": "string", "integration_id": "string", "level": "DEBUG", "message": "string", "service": "string", "tenant": "string", "timestamp": { "nanos": 1, "seconds": 10, "epochSecond": 9, "nano": 10 } }, { "component": "string", "integration_id": "string", "level": "INFO", "message": "string", "service": "string", "tenant": "string", "timestamp": { "nanos": 5, "seconds": 9, "epochSecond": 1, "nano": 3 } }, { "component": "string", "integration_id": "string", "level": "TRACE", "message": "string", "service": "string", "tenant": "string", "timestamp": { "nanos": 2, "seconds": 6, "epochSecond": 2, "nano": 6 } }, { "component": "string", "integration_id": "string", "level": "INFO", "message": "string", "service": "string", "tenant": "string", "timestamp": { "nanos": 1, "seconds": 6, "epochSecond": 5, "nano": 8 } }, { "component": "string", "integration_id": "string", "level": "DEBUG", "message": "string", "service": "string", "tenant": "string", "timestamp": { "nanos": 9, "seconds": 3, "epochSecond": 6, "nano": 4 } } ] } } } } }, "parameters": [ { "name": "filterNames", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filterValues", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "IntegrationLogs" ], "operationId": "postIntegrationLogs", "description": "The parameters and request body are for method: postIntegrationLogs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string" } } }, "example": { "body": "body" } } } } } }, "/v1/mars/{file}/{mar}/{namespace}": { "get": { "tags": [ "Mars" ], "operationId": "downloadMarFile", "description": "The parameters and request body are for method: downloadMarFile. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "file", "in": "path", "required": true, "schema": { "title": "file", "type": "string" } }, { "name": "mar", "in": "path", "required": true, "schema": { "title": "mar", "type": "string" } }, { "name": "namespace", "in": "path", "required": true, "schema": { "title": "namespace", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/mars": { "get": { "tags": [ "Mars" ], "operationId": "getAvailableMars", "description": "The parameters and request body are for method: getAvailableMars. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "mars": { "type": "object" } } }, "example": { "mars": {} } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/mars/{file}/{mar}/{namespace}/checksum": { "get": { "tags": [ "Mars" ], "operationId": "getgetMarFileChecksum", "description": "The parameters and request body are for method: getgetMarFileChecksum. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "file", "in": "path", "required": true, "schema": { "title": "file", "type": "string" } }, { "name": "mar", "in": "path", "required": true, "schema": { "title": "mar", "type": "string" } }, { "name": "namespace", "in": "path", "required": true, "schema": { "title": "namespace", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/mars-config": { "get": { "tags": [ "MarsConfig" ], "operationId": "getMarConfig", "description": "The parameters and request body are for method: getMarConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "config": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } } } }, "example": { "config": { "status": "success", "data": {} } } } } } }, "parameters": [ { "name": "theNameOfTheConfig", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "component", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "MarsConfig" ], "operationId": "postMarConfig", "description": "The parameters and request body are for method: postMarConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/mars-config/{uuid}": { "post": { "tags": [ "MarsConfig" ], "operationId": "associateMarConfig", "description": "The parameters and request body are for method: associateMarConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/mars-config/{mar}/{namespace}/{uuid}": { "get": { "tags": [ "MarsConfig" ], "operationId": "getMarCollectorConfig", "description": "The parameters and request body are for method: getMarCollectorConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "component": { "type": "string" }, "name": { "type": "string" } } }, "example": { "component": "string", "name": "string" } } } } }, "parameters": [ { "name": "mar", "in": "path", "required": true, "schema": { "title": "mar", "type": "string" } }, { "name": "namespace", "in": "path", "required": true, "schema": { "title": "namespace", "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "MarsConfig" ], "operationId": "disassociateMarConfig1", "description": "The parameters and request body are for method: disassociateMarConfig1. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mar", "in": "path", "required": true, "schema": { "title": "mar", "type": "string" } }, { "name": "namespace", "in": "path", "required": true, "schema": { "title": "namespace", "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/collectors/mars/definitions/all": { "get": { "tags": [ "Collectors" ], "operationId": "getAllDefinitions", "description": "The parameters and request body are for method: getAllDefinitions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } }, "example": { "status": "success", "data": {} } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/collectors/mars/{mar}/config/{namespace}/{uuid}": { "delete": { "tags": [ "Collectors" ], "operationId": "disassociateMarConfig", "description": "The parameters and request body are for method: disassociateMarConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mar", "in": "path", "required": true, "schema": { "title": "mar", "type": "string" } }, { "name": "namespace", "in": "path", "required": true, "schema": { "title": "namespace", "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/collectors/mars/{mar}/{namespace}/{uuid}": { "get": { "tags": [ "Collectors" ], "operationId": "getMarCollectorCredentials", "description": "The parameters and request body are for method: getMarCollectorCredentials. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "component": { "type": "string" }, "name": { "type": "string" } } }, "example": { "component": "string", "name": "string" } } } } }, "parameters": [ { "name": "mar", "in": "path", "required": true, "schema": { "title": "mar", "type": "string" } }, { "name": "namespace", "in": "path", "required": true, "schema": { "title": "namespace", "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Collectors" ], "operationId": "disassociateMarCredentials", "description": "The parameters and request body are for method: disassociateMarCredentials. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mar", "in": "path", "required": true, "schema": { "title": "mar", "type": "string" } }, { "name": "namespace", "in": "path", "required": true, "schema": { "title": "namespace", "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/collectors/mars/{uuid}": { "post": { "tags": [ "Collectors" ], "operationId": "associateMarCredentials", "description": "The parameters and request body are for method: associateMarCredentials. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/collectors/mars/credentials": { "get": { "tags": [ "Collectors" ], "operationId": "getMarCredentials", "description": "The parameters and request body are for method: getMarCredentials. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "credentials": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } } } } } }, "example": { "status": "success", "data": { "credentials": { "status": "success", "data": {} } } } } } } }, "parameters": [ { "name": "component", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/collectors/mars/definitions": { "get": { "tags": [ "Collectors" ], "operationId": "getDefinition", "description": "The parameters and request body are for method: getDefinition. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "config": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } }, "credentials": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } } } } } }, "example": { "status": "success", "data": { "config": { "status": "success", "data": {} }, "credentials": { "status": "success", "data": {} } } } } } } }, "parameters": [ { "name": "mar", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/collectors/mars/file": { "get": { "tags": [ "Collectors" ], "operationId": "getdownloadMarFile", "description": "The parameters and request body are for method: getdownloadMarFile. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "file", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/collectors/mars/{uuid}/credentials": { "get": { "tags": [ "Collectors" ], "operationId": "getMarCollectorCredentialsRedirect", "description": "The parameters and request body are for method: getMarCollectorCredentialsRedirect. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } }, "example": { "status": "success", "data": {} } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } }, { "name": "mar", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Collectors" ], "operationId": "associateMarCredentials2", "description": "The parameters and request body are for method: associateMarCredentials2. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/collectors/mars/checksum": { "get": { "tags": [ "Collectors" ], "operationId": "getMarFileChecksum", "description": "The parameters and request body are for method: getMarFileChecksum. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "file", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/collectors/mars/{uuid}/config": { "get": { "tags": [ "Collectors" ], "operationId": "getMarCollectorConfigRedirect", "description": "The parameters and request body are for method: getMarCollectorConfigRedirect. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } }, "example": { "status": "success", "data": {} } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } }, { "name": "mar", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Collectors" ], "operationId": "associateMarConfig1", "description": "The parameters and request body are for method: associateMarConfig1. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/collectors/mars/{mar}/credentials/{namespace}/{uuid}": { "delete": { "tags": [ "Collectors" ], "operationId": "disassociateMarCredentials2", "description": "The parameters and request body are for method: disassociateMarCredentials2. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mar", "in": "path", "required": true, "schema": { "title": "mar", "type": "string" } }, { "name": "namespace", "in": "path", "required": true, "schema": { "title": "namespace", "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/collectors/{uuid}/moobs/config": { "get": { "tags": [ "Collectors" ], "operationId": "getMoobConfig1", "description": "The parameters and request body are for method: getMoobConfig1. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } }, "example": { "status": "success", "data": {} } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } }, { "name": "fullyQualifiedMoob", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Collectors" ], "operationId": "postMoobConfig", "description": "The parameters and request body are for method: postMoobConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/collectors/mars": { "get": { "tags": [ "Collectors" ], "operationId": "getgetAvailableMars", "description": "The parameters and request body are for method: getgetAvailableMars. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "mars": { "type": "object" } } } } }, "example": { "status": "success", "data": { "mars": {} } } } } } }, "parameters": [ { "name": "theNameOfTheConfig", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "component", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Collectors" ], "operationId": "postMarConfig1", "description": "The parameters and request body are for method: postMarConfig1. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/collectors/mars/config": { "get": { "tags": [ "Collectors" ], "operationId": "getgetMarConfig", "description": "The parameters and request body are for method: getgetMarConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "config": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } } } } } }, "example": { "status": "success", "data": { "config": { "status": "success", "data": {} } } } } } } }, "parameters": [ { "name": "component", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Collectors" ], "operationId": "postMarConfig2", "description": "The parameters and request body are for method: postMarConfig2. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/collectors/mars/moobs": { "get": { "tags": [ "Collectors" ], "operationId": "getMoob1", "description": "The parameters and request body are for method: getMoob1. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "class": { "type": "string" }, "collector": { "type": "object", "properties": { "scheduled": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } } }, "streaming": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } } } }, "description": { "type": "string" }, "detectors": { "type": "array", "items": { "type": "object", "properties": { "default": { "type": "boolean" }, "metrics": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" } } } }, "local-defaults": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } }, "name": { "type": "string" }, "post-processors": { "type": "array", "items": { "type": "object", "properties": { "metrics": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "type": { "type": "string" } } } }, "pre-processors": { "type": "array", "items": { "type": "object", "properties": { "metrics": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" } } } } } } } }, "example": { "status": "success", "data": { "class": "string", "collector": { "scheduled": [ { "status": "success", "data": {} }, { "status": "success", "data": {} }, { "status": "success", "data": {} }, { "status": "success", "data": {} }, { "status": "success", "data": {} }, { "status": "success", "data": {} } ], "streaming": { "status": "success", "data": {} } }, "description": "string", "detectors": [ { "default": true, "metrics": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "type": "string" }, { "default": false, "metrics": [ "string", "string", "string" ], "type": "string" }, { "default": false, "metrics": [ "string", "string", "string" ], "type": "string" }, { "default": true, "metrics": [ "string", "string", "string", "string", "string" ], "type": "string" }, { "default": false, "metrics": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "type": "string" }, { "default": false, "metrics": [ "string", "string", "string", "string" ], "type": "string" }, { "default": true, "metrics": [ "string", "string", "string", "string", "string", "string" ], "type": "string" }, { "default": false, "metrics": [ "string", "string", "string", "string", "string", "string", "string" ], "type": "string" }, { "default": true, "metrics": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "type": "string" } ], "local-defaults": { "status": "success", "data": {} }, "name": "string", "post-processors": [ { "metrics": [ "string", "string", "string" ], "name": "string", "type": "string" }, { "metrics": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "name": "string", "type": "string" }, { "metrics": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "name": "string", "type": "string" }, { "metrics": [ "string", "string", "string", "string" ], "name": "string", "type": "string" } ], "pre-processors": [ { "metrics": [ "string", "string", "string", "string" ], "type": "string" } ] } } } } } }, "parameters": [ { "name": "fullyQualifiedMoob", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/moobs/{uuid}/config": { "get": { "tags": [ "Moobs" ], "operationId": "getMoobConfig", "description": "The parameters and request body are for method: getMoobConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } }, { "name": "fullyQualifiedMoob", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Moobs" ], "operationId": "createMoobConfig", "description": "The parameters and request body are for method: createMoobConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/moobs": { "get": { "tags": [ "Moobs" ], "operationId": "getMoob", "description": "The parameters and request body are for method: getMoob. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "class": { "type": "string" }, "collector": { "type": "object", "properties": { "scheduled": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } } }, "streaming": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } } } }, "description": { "type": "string" }, "detectors": { "type": "array", "items": { "type": "object", "properties": { "default": { "type": "boolean" }, "metrics": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" } } } }, "local-defaults": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } }, "name": { "type": "string" }, "post-processors": { "type": "array", "items": { "type": "object", "properties": { "metrics": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "type": { "type": "string" } } } }, "pre-processors": { "type": "array", "items": { "type": "object", "properties": { "metrics": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" } } } } } }, "example": { "class": "string", "collector": { "scheduled": [ { "status": "success", "data": {} }, { "status": "success", "data": {} }, { "status": "success", "data": {} } ], "streaming": { "status": "success", "data": {} } }, "description": "string", "detectors": [ { "default": false, "metrics": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "type": "string" }, { "default": false, "metrics": [ "string", "string", "string", "string", "string" ], "type": "string" }, { "default": true, "metrics": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "type": "string" } ], "local-defaults": { "status": "success", "data": {} }, "name": "string", "post-processors": [ { "metrics": [ "string", "string", "string", "string", "string" ], "name": "string", "type": "string" }, { "metrics": [ "string", "string", "string", "string", "string" ], "name": "string", "type": "string" }, { "metrics": [ "string", "string", "string", "string", "string" ], "name": "string", "type": "string" }, { "metrics": [ "string", "string", "string", "string", "string", "string", "string" ], "name": "string", "type": "string" }, { "metrics": [ "string", "string", "string", "string" ], "name": "string", "type": "string" }, { "metrics": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "name": "string", "type": "string" } ], "pre-processors": [ { "metrics": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "type": "string" }, { "metrics": [ "string", "string", "string", "string", "string", "string", "string" ], "type": "string" }, { "metrics": [ "string", "string", "string" ], "type": "string" }, { "metrics": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "type": "string" }, { "metrics": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "type": "string" }, { "metrics": [ "string", "string", "string", "string" ], "type": "string" }, { "metrics": [ "string", "string" ], "type": "string" }, { "metrics": [ "string" ], "type": "string" }, { "metrics": [ "string", "string", "string", "string", "string" ], "type": "string" }, { "metrics": [ "string", "string", "string" ], "type": "string" } ] } } } } }, "parameters": [ { "name": "fullyQualifiedMoob", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/mars-credentials/{uuid}": { "post": { "tags": [ "MarsCredentials" ], "operationId": "associateMarCredentials1", "description": "The parameters and request body are for method: associateMarCredentials1. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/mars-credentials/{mar}/{namespace}/{uuid}": { "get": { "tags": [ "MarsCredentials" ], "operationId": "getMarCollectorCredentials1", "description": "The parameters and request body are for method: getMarCollectorCredentials1. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "component": { "type": "string" }, "name": { "type": "string" } } }, "example": { "component": "string", "name": "string" } } } } }, "parameters": [ { "name": "mar", "in": "path", "required": true, "schema": { "title": "mar", "type": "string" } }, { "name": "namespace", "in": "path", "required": true, "schema": { "title": "namespace", "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "MarsCredentials" ], "operationId": "disassociateMarCredentials1", "description": "The parameters and request body are for method: disassociateMarCredentials1. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mar", "in": "path", "required": true, "schema": { "title": "mar", "type": "string" } }, { "name": "namespace", "in": "path", "required": true, "schema": { "title": "namespace", "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/mars-credentials": { "get": { "tags": [ "MarsCredentials" ], "operationId": "getMarCredentials1", "description": "The parameters and request body are for method: getMarCredentials1. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "credentials": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } } } }, "example": { "credentials": { "status": "success", "data": {} } } } } } }, "parameters": [ { "name": "component", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/mars-definitions": { "get": { "tags": [ "MarsDefinitions" ], "operationId": "getAllDefinitions1", "description": "The parameters and request body are for method: getAllDefinitions1. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "config": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } }, "credentials": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } } } }, "example": { "config": { "status": "success", "data": {} }, "credentials": { "status": "success", "data": {} } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/mars-definitions/{mar}/{namespace}": { "get": { "tags": [ "MarsDefinitions" ], "operationId": "getDefinition1", "description": "The parameters and request body are for method: getDefinition1. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "config": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } }, "credentials": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object" } } } } }, "example": { "config": { "status": "success", "data": {} }, "credentials": { "status": "success", "data": {} } } } } } }, "parameters": [ { "name": "mar", "in": "path", "required": true, "schema": { "title": "mar", "type": "string" } }, { "name": "namespace", "in": "path", "required": true, "schema": { "title": "namespace", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/integrations/metrics/config": { "get": { "tags": [ "Config" ], "operationId": "getAllMetrics", "description": "The parameters and request body are for method: getAllMetrics. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "traceID": { "type": "string" }, "config": { "type": "object" }, "detector": { "type": "string" }, "fqm": { "type": "string" }, "metric": { "type": "string" }, "uuid": { "type": "string" } } } }, "example": [ { "traceID": "string", "config": {}, "detector": "string", "fqm": "string", "metric": "string", "uuid": "string" }, { "traceID": "string", "config": {}, "detector": "string", "fqm": "string", "metric": "string", "uuid": "string" } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Config" ], "operationId": "updateConfig", "description": "The parameters and request body are for method: updateConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "status": { "type": "string" } } }, "example": { "data": {}, "status": "success" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/metrics": { "post": { "tags": [ "Metrics" ], "operationId": "postMetric", "description": "The parameters and request body are for method: postMetric. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "status": { "type": "string" } } }, "example": { "data": {}, "status": "success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string" } } }, "example": { "body": "body" } } } } } }, "/v1/integrations/pagerduty": { "get": { "tags": [ "Pagerduty" ], "operationId": "listPagerDutyIntegration", "description": "The parameters and request body are for method: listPagerDutyIntegration. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "alertFilter": { "type": "string" }, "credentialName": { "type": "string" }, "incidentFilter": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "utcOffset": { "type": "string" }, "id": { "type": "string" } } } }, "example": [ { "alertFilter": "id > 10", "credentialName": "valid credential", "incidentFilter": "string", "name": "test integration", "type": "ALERT", "utcOffset": "GMT-8", "id": "string" }, { "alertFilter": "id > 10", "credentialName": "valid credential", "incidentFilter": "string", "name": "test integration", "type": "ALERT", "utcOffset": "GMT-8", "id": "string" } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Pagerduty" ], "operationId": "postPagerDutyIntegration", "description": "The parameters and request body are for method: postPagerDutyIntegration. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "alertFilter": { "type": "string" }, "credentialName": { "type": "string" }, "incidentFilter": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "utcOffset": { "type": "string" }, "id": { "type": "string" } } } } }, "example": { "status": "success", "data": { "alertFilter": "id > 10", "credentialName": "valid credential", "incidentFilter": "string", "name": "test integration", "type": "INCIDENT", "utcOffset": "GMT-8", "id": "string" } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/pagerduty/{id}": { "get": { "tags": [ "Pagerduty" ], "operationId": "getPagerDutyIntegrationById", "description": "The parameters and request body are for method: getPagerDutyIntegrationById. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "alertFilter": { "type": "string" }, "credentialName": { "type": "string" }, "incidentFilter": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "utcOffset": { "type": "string" }, "id": { "type": "string" } } } } }, "example": { "status": "success", "data": { "alertFilter": "id > 10", "credentialName": "valid credential", "incidentFilter": "string", "name": "test integration", "type": "INCIDENT", "utcOffset": "GMT-8", "id": "string" } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Pagerduty" ], "operationId": "deletePagerDutyIntegration", "description": "The parameters and request body are for method: deletePagerDutyIntegration. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Pagerduty" ], "operationId": "updatePagerDutyIntegation", "description": "The parameters and request body are for method: updatePagerDutyIntegation. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/integrations/pagerduty-test": { "post": { "tags": [ "PagerdutyTest" ], "operationId": "testPagerDutyIntegration", "description": "The parameters and request body are for method: testPagerDutyIntegration. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "dedup_key": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } } } } }, "example": { "status": "success", "data": { "dedup_key": "string", "message": "string", "status": "string" } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/quarkus/http/hello": { "post": { "tags": [ "Quarkus" ], "operationId": "hello", "description": "The parameters and request body are for method: hello. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "everythingFine": { "type": "boolean" }, "instantTime": { "type": "object", "properties": { "nanos": { "type": "number" }, "seconds": { "type": "number" }, "epochSecond": { "type": "number" }, "nano": { "type": "number" } } }, "myNumber": { "type": "number" }, "name": { "type": "string" } } } } }, "example": { "status": "success", "data": { "everythingFine": false, "instantTime": { "nanos": 7, "seconds": 3, "epochSecond": 5, "nano": 6 }, "myNumber": 4, "name": "string" } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/rollups": { "get": { "tags": [ "Rollups" ], "operationId": "getRollups", "description": "The parameters and request body are for method: getRollups. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "comparisons": { "type": "array", "items": { "type": "object", "properties": { "mongo_high": { "type": "number" }, "mongo_low": { "type": "number" }, "mongo_median": { "type": "number" }, "mongo_quartile1": { "type": "number" }, "mongo_quartile3": { "type": "number" }, "prom_high": { "type": "number" }, "prom_low": { "type": "number" }, "prom_median": { "type": "number" }, "prom_quartile1": { "type": "number" }, "prom_quartile3": { "type": "number" }, "timedAtMs": { "type": "number" }, "matched": { "type": "boolean" } } } }, "fully_qualified_moob": { "type": "string" }, "granularity": { "type": "string" }, "interleveDebug": { "type": "string" }, "key": { "type": "string" }, "lastTimeThereWasData": { "type": "number" }, "lastTimestamp": { "type": "string" }, "metric": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "number" }, "datasource": { "type": "string" }, "high": { "type": "number" }, "low": { "type": "number" }, "mean": { "type": "number" }, "median": { "type": "number" }, "median_absolute_deviation": { "type": "number" }, "quartile_1": { "type": "number" }, "quartile_3": { "type": "number" }, "sigma": { "type": "number" }, "timed_at_ms": { "type": "number" } } } }, "source": { "type": "string" }, "total": { "type": "number" } } } } }, "example": { "status": "success", "data": { "comparisons": [ { "mongo_high": 8, "mongo_low": 9, "mongo_median": 6, "mongo_quartile1": 7, "mongo_quartile3": 7, "prom_high": 8, "prom_low": 8, "prom_median": 7, "prom_quartile1": 6, "prom_quartile3": 5, "timedAtMs": 6, "matched": true }, { "mongo_high": 4, "mongo_low": 2, "mongo_median": 1, "mongo_quartile1": 8, "mongo_quartile3": 7, "prom_high": 8, "prom_low": 10, "prom_median": 5, "prom_quartile1": 4, "prom_quartile3": 5, "timedAtMs": 10, "matched": true }, { "mongo_high": 6, "mongo_low": 1, "mongo_median": 6, "mongo_quartile1": 2, "mongo_quartile3": 3, "prom_high": 2, "prom_low": 8, "prom_median": 4, "prom_quartile1": 7, "prom_quartile3": 10, "timedAtMs": 2, "matched": false }, { "mongo_high": 8, "mongo_low": 6, "mongo_median": 5, "mongo_quartile1": 10, "mongo_quartile3": 6, "prom_high": 5, "prom_low": 8, "prom_median": 7, "prom_quartile1": 2, "prom_quartile3": 10, "timedAtMs": 1, "matched": false }, { "mongo_high": 9, "mongo_low": 2, "mongo_median": 7, "mongo_quartile1": 10, "mongo_quartile3": 3, "prom_high": 10, "prom_low": 4, "prom_median": 10, "prom_quartile1": 8, "prom_quartile3": 1, "timedAtMs": 3, "matched": false }, { "mongo_high": 4, "mongo_low": 3, "mongo_median": 5, "mongo_quartile1": 1, "mongo_quartile3": 9, "prom_high": 5, "prom_low": 6, "prom_median": 9, "prom_quartile1": 5, "prom_quartile3": 8, "timedAtMs": 5, "matched": true }, { "mongo_high": 6, "mongo_low": 5, "mongo_median": 10, "mongo_quartile1": 7, "mongo_quartile3": 9, "prom_high": 10, "prom_low": 10, "prom_median": 10, "prom_quartile1": 7, "prom_quartile3": 1, "timedAtMs": 8, "matched": true }, { "mongo_high": 1, "mongo_low": 2, "mongo_median": 7, "mongo_quartile1": 10, "mongo_quartile3": 9, "prom_high": 2, "prom_low": 5, "prom_median": 6, "prom_quartile1": 3, "prom_quartile3": 6, "timedAtMs": 10, "matched": true }, { "mongo_high": 1, "mongo_low": 2, "mongo_median": 10, "mongo_quartile1": 6, "mongo_quartile3": 1, "prom_high": 2, "prom_low": 3, "prom_median": 4, "prom_quartile1": 10, "prom_quartile3": 3, "timedAtMs": 5, "matched": true }, { "mongo_high": 7, "mongo_low": 1, "mongo_median": 1, "mongo_quartile1": 10, "mongo_quartile3": 9, "prom_high": 4, "prom_low": 8, "prom_median": 2, "prom_quartile1": 2, "prom_quartile3": 3, "timedAtMs": 8, "matched": true } ], "fully_qualified_moob": "string", "granularity": "HOUR", "interleveDebug": "string", "key": "string", "lastTimeThereWasData": 3, "lastTimestamp": "string", "metric": "string", "results": [ { "count": 5, "datasource": "string", "high": 10, "low": 4, "mean": 2, "median": 6, "median_absolute_deviation": 4, "quartile_1": 7, "quartile_3": 3, "sigma": 10, "timed_at_ms": 9 }, { "count": 9, "datasource": "string", "high": 4, "low": 2, "mean": 1, "median": 8, "median_absolute_deviation": 2, "quartile_1": 3, "quartile_3": 8, "sigma": 3, "timed_at_ms": 2 }, { "count": 7, "datasource": "string", "high": 10, "low": 5, "mean": 6, "median": 10, "median_absolute_deviation": 1, "quartile_1": 5, "quartile_3": 4, "sigma": 7, "timed_at_ms": 10 }, { "count": 4, "datasource": "string", "high": 8, "low": 7, "mean": 3, "median": 7, "median_absolute_deviation": 1, "quartile_1": 10, "quartile_3": 6, "sigma": 2, "timed_at_ms": 1 }, { "count": 8, "datasource": "string", "high": 10, "low": 8, "mean": 8, "median": 9, "median_absolute_deviation": 6, "quartile_1": 8, "quartile_3": 3, "sigma": 10, "timed_at_ms": 8 }, { "count": 5, "datasource": "string", "high": 4, "low": 1, "mean": 10, "median": 1, "median_absolute_deviation": 9, "quartile_1": 6, "quartile_3": 6, "sigma": 2, "timed_at_ms": 4 } ], "source": "string", "total": 3 } } } } } }, "parameters": [ { "name": "endTime", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "fullyQualifiedMoob", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "metric", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/datum-index-suggestions": { "get": { "tags": [ "DatumIndexSuggestions" ], "operationId": "getSuggestions", "description": "The parameters and request body are for method: getSuggestions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "string", "string", "string", "string" ] } } } }, "parameters": [ { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/datums/details": { "get": { "tags": [ "Datums" ], "operationId": "getDetailedDatums", "description": "The parameters and request body are for method: getDetailedDatums. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "alternateResults": { "type": "array", "items": { "type": "object", "properties": { "additional_data": { "type": "object" }, "data": { "type": "object" }, "datasource": { "type": "string" }, "engine": { "type": "object", "properties": { "confidence": { "type": "number" }, "DETECTOR_CLASS": { "type": "string" }, "highSigma": { "type": "number" }, "highThreshold": { "type": "number" }, "holdfor": { "type": "number" }, "learning": { "type": "boolean" }, "lowSigma": { "type": "number" }, "lowThreshold": { "type": "number" }, "median": { "type": "number" }, "severity": { "type": "number" }, "sigma": { "type": "number" }, "stateful": { "type": "boolean" }, "vector": { "type": "number" } } }, "instance": { "type": "string" }, "tags": { "type": "object" }, "timed_at_ms": { "type": "number" }, "unit": { "type": "string" }, "uuid": { "type": "string" } } } }, "alternateSource": { "type": "string" }, "comparisons": { "type": "array", "items": { "type": "object", "properties": { "mongo_value": { "type": "number" }, "prom_value": { "type": "number" }, "timedAtMs": { "type": "number" }, "matched": { "type": "boolean" } } } }, "interleveDebug": { "type": "string" }, "lastTimeThereWasData": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "properties": { "additional_data": { "type": "object" }, "data": { "type": "object" }, "datasource": { "type": "string" }, "engine": { "type": "object", "properties": { "confidence": { "type": "number" }, "DETECTOR_CLASS": { "type": "string" }, "highSigma": { "type": "number" }, "highThreshold": { "type": "number" }, "holdfor": { "type": "number" }, "learning": { "type": "boolean" }, "lowSigma": { "type": "number" }, "lowThreshold": { "type": "number" }, "median": { "type": "number" }, "severity": { "type": "number" }, "sigma": { "type": "number" }, "stateful": { "type": "boolean" }, "vector": { "type": "number" } } }, "instance": { "type": "string" }, "tags": { "type": "object" }, "timed_at_ms": { "type": "number" }, "unit": { "type": "string" }, "uuid": { "type": "string" } } } }, "total": { "type": "number" } } } } }, "example": { "status": "success", "data": { "alternateResults": [ { "additional_data": {}, "data": {}, "datasource": "string", "engine": { "confidence": 4, "DETECTOR_CLASS": "string", "highSigma": 5, "highThreshold": 7, "holdfor": 1, "learning": true, "lowSigma": 8, "lowThreshold": 2, "median": 6, "severity": 7, "sigma": 3, "stateful": false, "vector": 9 }, "instance": "string", "tags": {}, "timed_at_ms": 5, "unit": "string", "uuid": "string" }, { "additional_data": {}, "data": {}, "datasource": "string", "engine": { "confidence": 5, "DETECTOR_CLASS": "string", "highSigma": 8, "highThreshold": 6, "holdfor": 2, "learning": true, "lowSigma": 2, "lowThreshold": 1, "median": 5, "severity": 6, "sigma": 6, "stateful": false, "vector": 1 }, "instance": "string", "tags": {}, "timed_at_ms": 1, "unit": "string", "uuid": "string" } ], "alternateSource": "string", "comparisons": [ { "mongo_value": 5, "prom_value": 3, "timedAtMs": 5, "matched": false }, { "mongo_value": 5, "prom_value": 4, "timedAtMs": 10, "matched": false }, { "mongo_value": 1, "prom_value": 4, "timedAtMs": 10, "matched": false } ], "interleveDebug": "string", "lastTimeThereWasData": 3, "results": [ { "additional_data": {}, "data": {}, "datasource": "string", "engine": { "confidence": 3, "DETECTOR_CLASS": "string", "highSigma": 5, "highThreshold": 6, "holdfor": 9, "learning": true, "lowSigma": 2, "lowThreshold": 5, "median": 8, "severity": 6, "sigma": 3, "stateful": true, "vector": 4 }, "instance": "string", "tags": {}, "timed_at_ms": 7, "unit": "string", "uuid": "string" }, { "additional_data": {}, "data": {}, "datasource": "string", "engine": { "confidence": 2, "DETECTOR_CLASS": "string", "highSigma": 4, "highThreshold": 4, "holdfor": 3, "learning": true, "lowSigma": 4, "lowThreshold": 7, "median": 7, "severity": 6, "sigma": 2, "stateful": false, "vector": 7 }, "instance": "string", "tags": {}, "timed_at_ms": 2, "unit": "string", "uuid": "string" }, { "additional_data": {}, "data": {}, "datasource": "string", "engine": { "confidence": 3, "DETECTOR_CLASS": "string", "highSigma": 1, "highThreshold": 5, "holdfor": 1, "learning": true, "lowSigma": 7, "lowThreshold": 9, "median": 1, "severity": 4, "sigma": 2, "stateful": false, "vector": 4 }, "instance": "string", "tags": {}, "timed_at_ms": 7, "unit": "string", "uuid": "string" } ], "total": 3 } } } } } }, "parameters": [ { "name": "endTime", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "fullyQualifiedMoob", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "metric", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/datums-data-points": { "get": { "tags": [ "DatumsDataPoints" ], "operationId": "getDatumsDataPoints", "description": "The parameters and request body are for method: getDatumsDataPoints. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "number" } }, "example": [ 4, 4, 7, 9 ] } } } }, "parameters": [ { "name": "fullyQualifiedMoob", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "metric", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/datum-indexes": { "get": { "tags": [ "DatumIndexes" ], "operationId": "getDatumIndexes", "description": "The parameters and request body are for method: getDatumIndexes. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "direction", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "DatumIndexes" ], "operationId": "postGetDatumIndexes", "description": "The parameters and request body are for method: postGetDatumIndexes. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/rollup-strategy": { "get": { "tags": [ "RollupStrategy" ], "operationId": "getRollupStrategy", "description": "The parameters and request body are for method: getRollupStrategy. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "string" } } }, "example": { "status": "success", "data": "ZERO" } } } } }, "parameters": [ { "name": "fullyQualifiedMoob", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "metric", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "RollupStrategy" ], "operationId": "setRollupStrategy", "description": "The parameters and request body are for method: setRollupStrategy. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/keys": { "get": { "tags": [ "Apikeys" ], "operationId": "getAllApiKeys", "description": "The parameters and request body are for method: getAllApiKeys. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "userEmail": { "type": "string" }, "userId": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } } } } }, "example": [ { "description": "string", "name": "string", "createdAt": "string", "id": { "counter": 7, "randomValue1": 5, "randomValue2": 2, "timestamp": 10, "date": "string" }, "userEmail": "string", "userId": { "counter": 4, "randomValue1": 5, "randomValue2": 7, "timestamp": 8, "date": "string" } }, { "description": "string", "name": "string", "createdAt": "string", "id": { "counter": 10, "randomValue1": 4, "randomValue2": 3, "timestamp": 10, "date": "string" }, "userEmail": "string", "userId": { "counter": 2, "randomValue1": 8, "randomValue2": 8, "timestamp": 4, "date": "string" } }, { "description": "string", "name": "string", "createdAt": "string", "id": { "counter": 2, "randomValue1": 6, "randomValue2": 9, "timestamp": 9, "date": "string" }, "userEmail": "string", "userId": { "counter": 3, "randomValue1": 3, "randomValue2": 7, "timestamp": 3, "date": "string" } }, { "description": "string", "name": "string", "createdAt": "string", "id": { "counter": 10, "randomValue1": 6, "randomValue2": 4, "timestamp": 7, "date": "string" }, "userEmail": "string", "userId": { "counter": 7, "randomValue1": 3, "randomValue2": 6, "timestamp": 3, "date": "string" } } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Apikeys" ], "operationId": "deleteMultipleApiKeys", "description": "The parameters and request body are for method: deleteMultipleApiKeys. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/users/{userId}/keys": { "get": { "tags": [ "ApikeysUsers" ], "operationId": "getUserApiKeys", "description": "The parameters and request body are for method: getUserApiKeys. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "userEmail": { "type": "string" }, "userId": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } } } } }, "example": [ { "description": "string", "name": "string", "createdAt": "string", "id": { "counter": 1, "randomValue1": 2, "randomValue2": 3, "timestamp": 7, "date": "string" }, "userEmail": "string", "userId": { "counter": 6, "randomValue1": 6, "randomValue2": 7, "timestamp": 7, "date": "string" } }, { "description": "string", "name": "string", "createdAt": "string", "id": { "counter": 6, "randomValue1": 3, "randomValue2": 6, "timestamp": 5, "date": "string" }, "userEmail": "string", "userId": { "counter": 6, "randomValue1": 9, "randomValue2": 4, "timestamp": 8, "date": "string" } }, { "description": "string", "name": "string", "createdAt": "string", "id": { "counter": 10, "randomValue1": 2, "randomValue2": 9, "timestamp": 7, "date": "string" }, "userEmail": "string", "userId": { "counter": 9, "randomValue1": 7, "randomValue2": 2, "timestamp": 3, "date": "string" } }, { "description": "string", "name": "string", "createdAt": "string", "id": { "counter": 1, "randomValue1": 4, "randomValue2": 6, "timestamp": 3, "date": "string" }, "userEmail": "string", "userId": { "counter": 5, "randomValue1": 8, "randomValue2": 2, "timestamp": 2, "date": "string" } } ] } } } }, "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "title": "userId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "ApikeysUsers" ], "operationId": "createApiKey", "description": "The parameters and request body are for method: createApiKey. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "title": "userId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/users/{keyId}/keys/{userId}": { "get": { "tags": [ "ApikeysUsers" ], "operationId": "getApiKey", "description": "The parameters and request body are for method: getApiKey. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "userEmail": { "type": "string" }, "userId": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } } } } } }, "example": { "status": "success", "data": { "description": "string", "name": "string", "createdAt": "string", "id": { "counter": 4, "randomValue1": 5, "randomValue2": 8, "timestamp": 2, "date": "string" }, "userEmail": "string", "userId": { "counter": 1, "randomValue1": 8, "randomValue2": 5, "timestamp": 4, "date": "string" } } } } } } }, "parameters": [ { "name": "keyId", "in": "path", "required": true, "schema": { "title": "keyId", "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "title": "userId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "ApikeysUsers" ], "operationId": "deleteApiKey", "description": "The parameters and request body are for method: deleteApiKey. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "keyId", "in": "path", "required": true, "schema": { "title": "keyId", "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "title": "userId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/roles": { "get": { "tags": [ "Roles" ], "operationId": "getRoles", "description": "The parameters and request body are for method: getRoles. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "name": { "type": "string" }, "permissionsAsString": { "type": "array", "items": { "type": "string" } } } } }, "example": [ { "id": { "counter": 10, "randomValue1": 9, "randomValue2": 8, "timestamp": 3, "date": "string" }, "name": "string", "permissionsAsString": [ "string", "string", "string", "string" ] }, { "id": { "counter": 8, "randomValue1": 10, "randomValue2": 2, "timestamp": 6, "date": "string" }, "name": "string", "permissionsAsString": [ "string" ] }, { "id": { "counter": 9, "randomValue1": 3, "randomValue2": 3, "timestamp": 6, "date": "string" }, "name": "string", "permissionsAsString": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ] }, { "id": { "counter": 8, "randomValue1": 2, "randomValue2": 8, "timestamp": 3, "date": "string" }, "name": "string", "permissionsAsString": [ "string" ] } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/users": { "get": { "tags": [ "User" ], "operationId": "getUsers", "description": "The parameters and request body are for method: getUsers. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "excludeUserDeletion": { "type": "boolean" }, "familyName": { "type": "string" }, "givenName": { "type": "string" }, "role": { "type": "string" }, "tenantName": { "type": "string" }, "blocked": { "type": "boolean" }, "createdAt": { "type": "string" }, "emailVerified": { "type": "boolean" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "jwtPermissions": { "type": "array", "items": { "type": "string" } }, "lastLogin": { "type": "string" }, "loginCount": { "type": "number" }, "name": { "type": "string" }, "numericId": { "type": "number" }, "permissions": { "type": "array", "items": { "type": "string" } }, "picture": { "type": "string" }, "status": { "type": "string" }, "tenants": { "type": "array", "items": { "type": "string" } }, "writtenAt": { "type": "object", "properties": { "nanos": { "type": "number" }, "seconds": { "type": "number" }, "epochSecond": { "type": "number" }, "nano": { "type": "number" } } } } } }, "example": [ { "email": "string", "excludeUserDeletion": true, "familyName": "string", "givenName": "string", "role": "string", "tenantName": "string", "blocked": false, "createdAt": "string", "emailVerified": false, "id": { "counter": 2, "randomValue1": 3, "randomValue2": 8, "timestamp": 4, "date": "string" }, "jwtPermissions": [ "string", "string", "string", "string" ], "lastLogin": "string", "loginCount": 5, "name": "string", "numericId": 6, "permissions": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "picture": "string", "status": "DELETED", "tenants": [ "string", "string", "string", "string" ], "writtenAt": { "nanos": 9, "seconds": 1, "epochSecond": 7, "nano": 6 } }, { "email": "string", "excludeUserDeletion": true, "familyName": "string", "givenName": "string", "role": "string", "tenantName": "string", "blocked": false, "createdAt": "string", "emailVerified": false, "id": { "counter": 1, "randomValue1": 7, "randomValue2": 5, "timestamp": 2, "date": "string" }, "jwtPermissions": [ "string", "string", "string", "string" ], "lastLogin": "string", "loginCount": 10, "name": "string", "numericId": 9, "permissions": [ "string", "string" ], "picture": "string", "status": "DELETED", "tenants": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "writtenAt": { "nanos": 8, "seconds": 6, "epochSecond": 4, "nano": 6 } }, { "email": "string", "excludeUserDeletion": true, "familyName": "string", "givenName": "string", "role": "string", "tenantName": "string", "blocked": true, "createdAt": "string", "emailVerified": false, "id": { "counter": 2, "randomValue1": 1, "randomValue2": 6, "timestamp": 2, "date": "string" }, "jwtPermissions": [ "string", "string", "string", "string" ], "lastLogin": "string", "loginCount": 8, "name": "string", "numericId": 9, "permissions": [ "string", "string", "string" ], "picture": "string", "status": "ACTIVE", "tenants": [ "string", "string", "string", "string", "string", "string" ], "writtenAt": { "nanos": 7, "seconds": 7, "epochSecond": 9, "nano": 9 } }, { "email": "string", "excludeUserDeletion": false, "familyName": "string", "givenName": "string", "role": "string", "tenantName": "string", "blocked": true, "createdAt": "string", "emailVerified": true, "id": { "counter": 5, "randomValue1": 3, "randomValue2": 6, "timestamp": 2, "date": "string" }, "jwtPermissions": [ "string", "string", "string", "string", "string", "string" ], "lastLogin": "string", "loginCount": 3, "name": "string", "numericId": 8, "permissions": [ "string", "string" ], "picture": "string", "status": "INVITED", "tenants": [ "string" ], "writtenAt": { "nanos": 2, "seconds": 4, "epochSecond": 4, "nano": 6 } } ] } } } }, "parameters": [ { "name": "showDeleted", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "User" ], "operationId": "createUser", "description": "The parameters and request body are for method: createUser. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/users/{id}": { "get": { "tags": [ "User" ], "operationId": "getUserDetails", "description": "The parameters and request body are for method: getUserDetails. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "email": { "type": "string" }, "excludeUserDeletion": { "type": "boolean" }, "familyName": { "type": "string" }, "givenName": { "type": "string" }, "role": { "type": "string" }, "tenantName": { "type": "string" }, "blocked": { "type": "boolean" }, "createdAt": { "type": "string" }, "emailVerified": { "type": "boolean" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "jwtPermissions": { "type": "array", "items": { "type": "string" } }, "lastLogin": { "type": "string" }, "loginCount": { "type": "number" }, "name": { "type": "string" }, "numericId": { "type": "number" }, "permissions": { "type": "array", "items": { "type": "string" } }, "picture": { "type": "string" }, "status": { "type": "string" }, "tenants": { "type": "array", "items": { "type": "string" } }, "writtenAt": { "type": "object", "properties": { "nanos": { "type": "number" }, "seconds": { "type": "number" }, "epochSecond": { "type": "number" }, "nano": { "type": "number" } } } } } } }, "example": { "status": "success", "data": { "email": "string", "excludeUserDeletion": false, "familyName": "string", "givenName": "string", "role": "string", "tenantName": "string", "blocked": false, "createdAt": "string", "emailVerified": true, "id": { "counter": 3, "randomValue1": 5, "randomValue2": 6, "timestamp": 10, "date": "string" }, "jwtPermissions": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "lastLogin": "string", "loginCount": 10, "name": "string", "numericId": 7, "permissions": [ "string", "string", "string" ], "picture": "string", "status": "ACTIVE", "tenants": [ "string", "string", "string", "string" ], "writtenAt": { "nanos": 5, "seconds": 9, "epochSecond": 5, "nano": 9 } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "User" ], "operationId": "deleteUser", "description": "The parameters and request body are for method: deleteUser. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "User" ], "operationId": "editUser", "description": "The parameters and request body are for method: editUser. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/webhooks/{id}": { "get": { "tags": [ "Webhooks" ], "operationId": "getWebhook", "description": "The parameters and request body are for method: getWebhook. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "filter": { "type": "string" }, "headers": { "type": "object" }, "name": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" }, "body": { "type": "object" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "status": { "type": "string" } } } } }, "example": { "status": "success", "data": { "filter": "string", "headers": {}, "name": "string", "type": "INCIDENT", "url": "string", "body": {}, "id": { "counter": 7, "randomValue1": 4, "randomValue2": 3, "timestamp": 3, "date": "string" }, "status": "MOOG_ERROR" } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Webhooks" ], "operationId": "deleteWebhook", "description": "The parameters and request body are for method: deleteWebhook. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Webhooks" ], "operationId": "modifyWebhook", "description": "The parameters and request body are for method: modifyWebhook. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "filter": { "type": "string" }, "headers": { "type": "object" }, "name": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" }, "body": { "type": "object" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "status": { "type": "string" } } } } }, "example": { "status": "success", "data": { "filter": "string", "headers": {}, "name": "string", "type": "INCIDENT", "url": "string", "body": {}, "id": { "counter": 10, "randomValue1": 2, "randomValue2": 3, "timestamp": 1, "date": "string" }, "status": "INVALID_URL" } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/webhook-test": { "post": { "tags": [ "Webhooks" ], "operationId": "testWebhooksConfig", "description": "The parameters and request body are for method: testWebhooksConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "requestBody": { "type": "string" }, "requestHeaders": { "type": "object" }, "responseBody": { "type": "string" }, "responseCode": { "type": "number" }, "responseCodeReason": { "type": "string" }, "status": { "type": "string" }, "url": { "type": "string" } } } } }, "example": { "status": "success", "data": { "requestBody": "string", "requestHeaders": {}, "responseBody": "string", "responseCode": 5, "responseCodeReason": "string", "status": "INITIALISED", "url": "string" } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/integrations/webhooks": { "get": { "tags": [ "Webhooks" ], "operationId": "getWebhooksConfig", "description": "The parameters and request body are for method: getWebhooksConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "filter": { "type": "string" }, "headers": { "type": "object" }, "name": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" }, "body": { "type": "object" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "status": { "type": "string" } } } }, "example": [ { "filter": "string", "headers": {}, "name": "string", "type": "ALERT", "url": "string", "body": {}, "id": { "counter": 5, "randomValue1": 5, "randomValue2": 7, "timestamp": 2, "date": "string" }, "status": "BAD_AUTH" }, { "filter": "string", "headers": {}, "name": "string", "type": "INCIDENT", "url": "string", "body": {}, "id": { "counter": 9, "randomValue1": 6, "randomValue2": 7, "timestamp": 9, "date": "string" }, "status": "MOOG_ERROR" } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Webhooks" ], "operationId": "postWebhookConfig", "description": "The parameters and request body are for method: postWebhookConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "filter": { "type": "string" }, "headers": { "type": "object" }, "name": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" }, "body": { "type": "object" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "status": { "type": "string" } } } } }, "example": { "status": "success", "data": { "filter": "string", "headers": {}, "name": "string", "type": "INCIDENT", "url": "string", "body": {}, "id": { "counter": 5, "randomValue1": 4, "randomValue2": 2, "timestamp": 2, "date": "string" }, "status": "BAD_AUTH" } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/integrations/webhooks/items": { "get": { "tags": [ "WebhooksV2" ], "operationId": "getgetWebhooksConfig", "description": "The parameters and request body are for method: getgetWebhooksConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "createBody": { "type": "string" }, "credentials": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } } }, "enabled": { "type": "boolean" }, "filter": { "type": "string" }, "headers": { "type": "object" }, "integration": { "type": "object", "properties": { "ticketIdRegex": { "type": "string" }, "type": { "type": "string" } } }, "name": { "type": "string" }, "timeFormat": { "type": "object", "properties": { "format": { "type": "string" }, "type": { "type": "string" } } }, "triggers": { "type": "object", "properties": { "assigneeChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "classChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "created": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "descriptionChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "serviceChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "severityChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "statusChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "tagsChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "typeChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } } } }, "type": { "type": "string" }, "updateBody": { "type": "string" }, "updatesEnabled": { "type": "boolean" }, "urls": { "type": "object", "properties": { "close": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } }, "create": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } }, "update": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } } } }, "createdBy": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "lastError": { "type": "object", "properties": { "additionalInfo": { "type": "object" }, "data": { "type": "object" }, "request": { "type": "object", "properties": { "body": { "type": "string" }, "headers": { "type": "object" }, "url": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } } } }, "response": { "type": "object", "properties": { "body": { "type": "string" }, "code": { "type": "number" }, "codeReason": { "type": "string" } } }, "status": { "type": "string" }, "timestamp": { "type": "number" } } }, "lastUpdated": { "type": "object", "properties": { "nanos": { "type": "number" }, "seconds": { "type": "number" }, "epochSecond": { "type": "number" }, "nano": { "type": "number" } } }, "status": { "type": "string" } } } }, "example": [ { "createBody": "string", "credentials": { "name": "string", "type": "BEARER" }, "enabled": true, "filter": "string", "headers": {}, "integration": { "ticketIdRegex": "string", "type": "DATADOG" }, "name": "string", "timeFormat": { "format": "YYYY-MM-DD'T'HH:mm:ss'Z'", "type": "FORMATTED" }, "triggers": { "assigneeChange": { "enabled": true }, "classChange": { "enabled": true }, "created": { "enabled": true }, "descriptionChange": { "enabled": false }, "serviceChange": { "enabled": true }, "severityChange": { "enabled": false }, "statusChange": { "enabled": true }, "tagsChange": { "enabled": false }, "typeChange": { "enabled": false } }, "type": "INCIDENT", "updateBody": "string", "updatesEnabled": true, "urls": { "close": { "url": "string", "verb": "PUT" }, "create": { "url": "string", "verb": "PUT" }, "update": { "url": "string", "verb": "PATCH" } }, "createdBy": "string", "id": { "counter": 6, "randomValue1": 1, "randomValue2": 3, "timestamp": 3, "date": "string" }, "lastError": { "additionalInfo": {}, "data": {}, "request": { "body": "string", "headers": {}, "url": { "url": "string", "verb": "PATCH" } }, "response": { "body": "string", "code": 5, "codeReason": "string" }, "status": "INITIALISED", "timestamp": 9 }, "lastUpdated": { "nanos": 1, "seconds": 9, "epochSecond": 1, "nano": 6 }, "status": "DISABLED" }, { "createBody": "string", "credentials": { "name": "string", "type": "BASIC" }, "enabled": true, "filter": "string", "headers": {}, "integration": { "ticketIdRegex": "string", "type": "SERVICENOW" }, "name": "string", "timeFormat": { "format": "YYYY-MM-DD'T'HH:mm:ss'Z'", "type": "FORMATTED" }, "triggers": { "assigneeChange": { "enabled": true }, "classChange": { "enabled": false }, "created": { "enabled": true }, "descriptionChange": { "enabled": true }, "serviceChange": { "enabled": false }, "severityChange": { "enabled": false }, "statusChange": { "enabled": true }, "tagsChange": { "enabled": false }, "typeChange": { "enabled": false } }, "type": "ALERT", "updateBody": "string", "updatesEnabled": true, "urls": { "close": { "url": "string", "verb": "DELETE" }, "create": { "url": "string", "verb": "PATCH" }, "update": { "url": "string", "verb": "DELETE" } }, "createdBy": "string", "id": { "counter": 6, "randomValue1": 10, "randomValue2": 9, "timestamp": 1, "date": "string" }, "lastError": { "additionalInfo": {}, "data": {}, "request": { "body": "string", "headers": {}, "url": { "url": "string", "verb": "DELETE" } }, "response": { "body": "string", "code": 4, "codeReason": "string" }, "status": "DISABLED", "timestamp": 1 }, "lastUpdated": { "nanos": 4, "seconds": 5, "epochSecond": 9, "nano": 1 }, "status": "DISABLED" } ] } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "WebhooksV2" ], "operationId": "postpostWebhookConfig", "description": "The parameters and request body are for method: postpostWebhookConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "createBody": { "type": "string" }, "credentials": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } } }, "enabled": { "type": "boolean" }, "filter": { "type": "string" }, "headers": { "type": "object" }, "integration": { "type": "object", "properties": { "ticketIdRegex": { "type": "string" }, "type": { "type": "string" } } }, "name": { "type": "string" }, "timeFormat": { "type": "object", "properties": { "format": { "type": "string" }, "type": { "type": "string" } } }, "triggers": { "type": "object", "properties": { "assigneeChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "classChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "created": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "descriptionChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "serviceChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "severityChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "statusChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "tagsChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "typeChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } } } }, "type": { "type": "string" }, "updateBody": { "type": "string" }, "updatesEnabled": { "type": "boolean" }, "urls": { "type": "object", "properties": { "close": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } }, "create": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } }, "update": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } } } }, "createdBy": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "lastError": { "type": "object", "properties": { "additionalInfo": { "type": "object" }, "data": { "type": "object" }, "request": { "type": "object", "properties": { "body": { "type": "string" }, "headers": { "type": "object" }, "url": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } } } }, "response": { "type": "object", "properties": { "body": { "type": "string" }, "code": { "type": "number" }, "codeReason": { "type": "string" } } }, "status": { "type": "string" }, "timestamp": { "type": "number" } } }, "lastUpdated": { "type": "object", "properties": { "nanos": { "type": "number" }, "seconds": { "type": "number" }, "epochSecond": { "type": "number" }, "nano": { "type": "number" } } }, "status": { "type": "string" } } } } }, "example": { "status": "success", "data": { "createBody": "string", "credentials": { "name": "string", "type": "BEARER" }, "enabled": true, "filter": "string", "headers": {}, "integration": { "ticketIdRegex": "string", "type": "DATADOG" }, "name": "string", "timeFormat": { "format": "YYYY-MM-DD'T'HH:mm:ss'Z'", "type": "NUMERIC" }, "triggers": { "assigneeChange": { "enabled": true }, "classChange": { "enabled": false }, "created": { "enabled": false }, "descriptionChange": { "enabled": false }, "serviceChange": { "enabled": true }, "severityChange": { "enabled": true }, "statusChange": { "enabled": true }, "tagsChange": { "enabled": true }, "typeChange": { "enabled": false } }, "type": "ALERT", "updateBody": "string", "updatesEnabled": true, "urls": { "close": { "url": "string", "verb": "DELETE" }, "create": { "url": "string", "verb": "PATCH" }, "update": { "url": "string", "verb": "PUT" } }, "createdBy": "string", "id": { "counter": 5, "randomValue1": 2, "randomValue2": 8, "timestamp": 9, "date": "string" }, "lastError": { "additionalInfo": {}, "data": {}, "request": { "body": "string", "headers": {}, "url": { "url": "string", "verb": "PATCH" } }, "response": { "body": "string", "code": 1, "codeReason": "string" }, "status": "MOOG_ERROR", "timestamp": 7 }, "lastUpdated": { "nanos": 1, "seconds": 1, "epochSecond": 7, "nano": 5 }, "status": "PAGE_NOT_FOUND" } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/integrations/webhooks/items/{id}": { "get": { "tags": [ "WebhooksV2" ], "operationId": "getgetWebhook", "description": "The parameters and request body are for method: getgetWebhook. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "createBody": { "type": "string" }, "credentials": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } } }, "enabled": { "type": "boolean" }, "filter": { "type": "string" }, "headers": { "type": "object" }, "integration": { "type": "object", "properties": { "ticketIdRegex": { "type": "string" }, "type": { "type": "string" } } }, "name": { "type": "string" }, "timeFormat": { "type": "object", "properties": { "format": { "type": "string" }, "type": { "type": "string" } } }, "triggers": { "type": "object", "properties": { "assigneeChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "classChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "created": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "descriptionChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "serviceChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "severityChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "statusChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "tagsChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "typeChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } } } }, "type": { "type": "string" }, "updateBody": { "type": "string" }, "updatesEnabled": { "type": "boolean" }, "urls": { "type": "object", "properties": { "close": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } }, "create": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } }, "update": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } } } }, "createdBy": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "lastError": { "type": "object", "properties": { "additionalInfo": { "type": "object" }, "data": { "type": "object" }, "request": { "type": "object", "properties": { "body": { "type": "string" }, "headers": { "type": "object" }, "url": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } } } }, "response": { "type": "object", "properties": { "body": { "type": "string" }, "code": { "type": "number" }, "codeReason": { "type": "string" } } }, "status": { "type": "string" }, "timestamp": { "type": "number" } } }, "lastUpdated": { "type": "object", "properties": { "nanos": { "type": "number" }, "seconds": { "type": "number" }, "epochSecond": { "type": "number" }, "nano": { "type": "number" } } }, "status": { "type": "string" } } } } }, "example": { "status": "success", "data": { "createBody": "string", "credentials": { "name": "string", "type": "BASIC" }, "enabled": false, "filter": "string", "headers": {}, "integration": { "ticketIdRegex": "string", "type": "SLACK" }, "name": "string", "timeFormat": { "format": "YYYY-MM-DD'T'HH:mm:ss'Z'", "type": "FORMATTED" }, "triggers": { "assigneeChange": { "enabled": true }, "classChange": { "enabled": true }, "created": { "enabled": false }, "descriptionChange": { "enabled": true }, "serviceChange": { "enabled": false }, "severityChange": { "enabled": false }, "statusChange": { "enabled": false }, "tagsChange": { "enabled": false }, "typeChange": { "enabled": false } }, "type": "INCIDENT", "updateBody": "string", "updatesEnabled": true, "urls": { "close": { "url": "string", "verb": "PATCH" }, "create": { "url": "string", "verb": "POST" }, "update": { "url": "string", "verb": "PATCH" } }, "createdBy": "string", "id": { "counter": 6, "randomValue1": 9, "randomValue2": 8, "timestamp": 4, "date": "string" }, "lastError": { "additionalInfo": {}, "data": {}, "request": { "body": "string", "headers": {}, "url": { "url": "string", "verb": "DELETE" } }, "response": { "body": "string", "code": 7, "codeReason": "string" }, "status": "INITIALISED", "timestamp": 6 }, "lastUpdated": { "nanos": 2, "seconds": 8, "epochSecond": 5, "nano": 4 }, "status": "MOOG_ERROR" } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "WebhooksV2" ], "operationId": "deletedeleteWebhook", "description": "The parameters and request body are for method: deletedeleteWebhook. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "WebhooksV2" ], "operationId": "patchmodifyWebhook", "description": "The parameters and request body are for method: patchmodifyWebhook. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "createBody": { "type": "string" }, "credentials": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } } }, "enabled": { "type": "boolean" }, "filter": { "type": "string" }, "headers": { "type": "object" }, "integration": { "type": "object", "properties": { "ticketIdRegex": { "type": "string" }, "type": { "type": "string" } } }, "name": { "type": "string" }, "timeFormat": { "type": "object", "properties": { "format": { "type": "string" }, "type": { "type": "string" } } }, "triggers": { "type": "object", "properties": { "assigneeChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "classChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "created": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "descriptionChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "serviceChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "severityChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "statusChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "tagsChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "typeChange": { "type": "object", "properties": { "enabled": { "type": "boolean" } } } } }, "type": { "type": "string" }, "updateBody": { "type": "string" }, "updatesEnabled": { "type": "boolean" }, "urls": { "type": "object", "properties": { "close": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } }, "create": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } }, "update": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } } } }, "createdBy": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "lastError": { "type": "object", "properties": { "additionalInfo": { "type": "object" }, "data": { "type": "object" }, "request": { "type": "object", "properties": { "body": { "type": "string" }, "headers": { "type": "object" }, "url": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } } } }, "response": { "type": "object", "properties": { "body": { "type": "string" }, "code": { "type": "number" }, "codeReason": { "type": "string" } } }, "status": { "type": "string" }, "timestamp": { "type": "number" } } }, "lastUpdated": { "type": "object", "properties": { "nanos": { "type": "number" }, "seconds": { "type": "number" }, "epochSecond": { "type": "number" }, "nano": { "type": "number" } } }, "status": { "type": "string" } } } } }, "example": { "status": "success", "data": { "createBody": "string", "credentials": { "name": "string", "type": "BEARER" }, "enabled": false, "filter": "string", "headers": {}, "integration": { "ticketIdRegex": "string", "type": "SLACK" }, "name": "string", "timeFormat": { "format": "YYYY-MM-DD'T'HH:mm:ss'Z'", "type": "NUMERIC" }, "triggers": { "assigneeChange": { "enabled": true }, "classChange": { "enabled": false }, "created": { "enabled": false }, "descriptionChange": { "enabled": false }, "serviceChange": { "enabled": true }, "severityChange": { "enabled": false }, "statusChange": { "enabled": false }, "tagsChange": { "enabled": false }, "typeChange": { "enabled": true } }, "type": "INCIDENT", "updateBody": "string", "updatesEnabled": true, "urls": { "close": { "url": "string", "verb": "POST" }, "create": { "url": "string", "verb": "POST" }, "update": { "url": "string", "verb": "PUT" } }, "createdBy": "string", "id": { "counter": 5, "randomValue1": 5, "randomValue2": 1, "timestamp": 8, "date": "string" }, "lastError": { "additionalInfo": {}, "data": {}, "request": { "body": "string", "headers": {}, "url": { "url": "string", "verb": "PATCH" } }, "response": { "body": "string", "code": 4, "codeReason": "string" }, "status": "PAGE_NOT_FOUND", "timestamp": 9 }, "lastUpdated": { "nanos": 6, "seconds": 6, "epochSecond": 8, "nano": 9 }, "status": "PAGE_NOT_FOUND" } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/integrations/webhooks/preview": { "post": { "tags": [ "WebhooksV2" ], "operationId": "previewWebhook", "description": "The parameters and request body are for method: previewWebhook. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "additionalInfo": { "type": "object" }, "data": { "type": "object" }, "request": { "type": "object", "properties": { "body": { "type": "string" }, "headers": { "type": "object" }, "url": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } } } }, "response": { "type": "object", "properties": { "body": { "type": "string" }, "code": { "type": "number" }, "codeReason": { "type": "string" } } }, "status": { "type": "string" }, "timestamp": { "type": "number" } } } }, "example": [ { "additionalInfo": {}, "data": {}, "request": { "body": "string", "headers": {}, "url": { "url": "string", "verb": "PATCH" } }, "response": { "body": "string", "code": 2, "codeReason": "string" }, "status": "DISABLED", "timestamp": 10 }, { "additionalInfo": {}, "data": {}, "request": { "body": "string", "headers": {}, "url": { "url": "string", "verb": "POST" } }, "response": { "body": "string", "code": 6, "codeReason": "string" }, "status": "DISABLED", "timestamp": 8 }, { "additionalInfo": {}, "data": {}, "request": { "body": "string", "headers": {}, "url": { "url": "string", "verb": "DELETE" } }, "response": { "body": "string", "code": 1, "codeReason": "string" }, "status": "DISABLED", "timestamp": 10 } ] } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/integrations/webhooks/test": { "post": { "tags": [ "WebhooksV2" ], "operationId": "posttestWebhooksConfig", "description": "The parameters and request body are for method: posttestWebhooksConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "additionalInfo": { "type": "object" }, "data": { "type": "object" }, "request": { "type": "object", "properties": { "body": { "type": "string" }, "headers": { "type": "object" }, "url": { "type": "object", "properties": { "url": { "type": "string" }, "verb": { "type": "string" } } } } }, "response": { "type": "object", "properties": { "body": { "type": "string" }, "code": { "type": "number" }, "codeReason": { "type": "string" } } }, "status": { "type": "string" }, "timestamp": { "type": "number" } } } }, "example": [ { "additionalInfo": {}, "data": {}, "request": { "body": "string", "headers": {}, "url": { "url": "string", "verb": "POST" } }, "response": { "body": "string", "code": 2, "codeReason": "string" }, "status": "DISABLED", "timestamp": 9 } ] } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/workflow-template-actions": { "get": { "tags": [ "WorkflowTemplateActions" ], "operationId": "getTemplatedActions", "description": "The parameters and request body are for method: getTemplatedActions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "actionName": { "type": "string" }, "configuration": { "type": "object" }, "description": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } } } } }, "example": [ { "actionName": "string", "configuration": {}, "description": "string", "id": { "counter": 7, "randomValue1": 4, "randomValue2": 8, "timestamp": 6, "date": "string" } }, { "actionName": "string", "configuration": {}, "description": "string", "id": { "counter": 3, "randomValue1": 5, "randomValue2": 4, "timestamp": 10, "date": "string" } } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "WorkflowTemplateActions" ], "operationId": "createTemplateAction", "description": "The parameters and request body are for method: createTemplateAction. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "actionName": { "type": "string" }, "configuration": { "type": "object" }, "description": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } } } } } }, "example": { "status": "success", "data": { "actionName": "string", "configuration": {}, "description": "string", "id": { "counter": 2, "randomValue1": 2, "randomValue2": 4, "timestamp": 2, "date": "string" } } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/workflow-template-actions/{id}": { "delete": { "tags": [ "WorkflowTemplateActions" ], "operationId": "deleteTemplateAction", "description": "The parameters and request body are for method: deleteTemplateAction. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "WorkflowTemplateActions" ], "operationId": "modifyTemplateAction", "description": "The parameters and request body are for method: modifyTemplateAction. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "actionName": { "type": "string" }, "configuration": { "type": "object" }, "description": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } } } } } }, "example": { "status": "success", "data": { "actionName": "string", "configuration": {}, "description": "string", "id": { "counter": 7, "randomValue1": 8, "randomValue2": 9, "timestamp": 4, "date": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/workflows/{id}/metrics/exceptions": { "get": { "tags": [ "Workflows" ], "operationId": "getWorkflowMetricsExceptions", "description": "The parameters and request body are for method: getWorkflowMetricsExceptions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "generalError": { "type": "string" }, "generalErrorMillis": { "type": "number" }, "lastException": { "type": "string" }, "lastExceptionMillis": { "type": "number" } } } } }, "example": { "status": "success", "data": { "generalError": "string", "generalErrorMillis": 4, "lastException": "string", "lastExceptionMillis": 7 } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Workflows" ], "operationId": "deleteWorkflowMetricsExceptions", "description": "The parameters and request body are for method: deleteWorkflowMetricsExceptions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/workflows/{id}/test": { "get": { "tags": [ "Workflows" ], "operationId": "getWorkflowTest", "description": "The parameters and request body are for method: getWorkflowTest. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "actionsTestList": { "type": "array", "items": { "type": "object", "properties": { "actionName": { "type": "string" }, "discarded": { "type": "boolean" }, "endMillis": { "type": "number" }, "exception": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "skipped": { "type": "boolean" }, "startMillis": { "type": "number" } } } }, "discarded": { "type": "boolean" }, "endMillis": { "type": "number" }, "exception": { "type": "string" }, "filterTest": { "type": "object", "properties": { "endMillis": { "type": "number" }, "exception": { "type": "string" }, "input": { "type": "object" }, "result": { "type": "boolean" }, "startMillis": { "type": "number" } } }, "generalError": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "skipped": { "type": "boolean" }, "startMillis": { "type": "number" }, "status": { "type": "string" } } } } }, "example": { "status": "success", "data": { "actionsTestList": [ { "actionName": "string", "discarded": false, "endMillis": 1, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 8 } ], "discarded": false, "endMillis": 1, "exception": "string", "filterTest": { "endMillis": 5, "exception": "string", "input": {}, "result": true, "startMillis": 7 }, "generalError": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 3, "status": "FAILED" } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/workflows-bulk": { "patch": { "tags": [ "Workflows" ], "operationId": "modifyWorkflows", "description": "The parameters and request body are for method: modifyWorkflows. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "priority": { "type": "number" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "actionName": { "type": "string" }, "configuration": { "type": "object" }, "description": { "type": "string" } } } }, "trigger": { "type": "object", "properties": { "entryFilter": { "type": "string" }, "type": { "type": "string" } } }, "type": { "type": "string" }, "createdBy": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "lastUpdated": { "type": "object", "properties": { "nanos": { "type": "number" }, "seconds": { "type": "number" }, "epochSecond": { "type": "number" }, "nano": { "type": "number" } } }, "metrics": { "type": "object", "properties": { "actionMetricsMap": { "type": "object" }, "averageProcessingDurationMillis": { "type": "number" }, "discarded": { "type": "number" }, "errors": { "type": "number" }, "filterMetrics": { "type": "object", "properties": { "averageProcessingDurationMillis": { "type": "number" }, "errors": { "type": "number" }, "excluded": { "type": "number" }, "highWatermarkProcessingDurationMillis": { "type": "number" }, "included": { "type": "number" }, "lowWatermarkProcessingDurationMillis": { "type": "number" }, "processed": { "type": "number" } } }, "generalError": { "type": "string" }, "generalErrorMillis": { "type": "number" }, "highWatermarkProcessingDurationMillis": { "type": "number" }, "lastException": { "type": "string" }, "lastExceptionMillis": { "type": "number" }, "lowWatermarkProcessingDurationMillis": { "type": "number" }, "processed": { "type": "number" }, "skipped": { "type": "number" } } }, "status": { "type": "string" }, "test": { "type": "object", "properties": { "actionsTestList": { "type": "array", "items": { "type": "object", "properties": { "actionName": { "type": "string" }, "discarded": { "type": "boolean" }, "endMillis": { "type": "number" }, "exception": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "skipped": { "type": "boolean" }, "startMillis": { "type": "number" } } } }, "discarded": { "type": "boolean" }, "endMillis": { "type": "number" }, "exception": { "type": "string" }, "filterTest": { "type": "object", "properties": { "endMillis": { "type": "number" }, "exception": { "type": "string" }, "input": { "type": "object" }, "result": { "type": "boolean" }, "startMillis": { "type": "number" } } }, "generalError": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "skipped": { "type": "boolean" }, "startMillis": { "type": "number" }, "status": { "type": "string" } } } } } }, "example": [ { "description": "string", "name": "string", "priority": 3, "steps": [ { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" } ], "trigger": { "entryFilter": "string", "type": "EVENT_CREATED" }, "type": "EVENT", "createdBy": "string", "id": { "counter": 6, "randomValue1": 8, "randomValue2": 4, "timestamp": 9, "date": "string" }, "lastUpdated": { "nanos": 9, "seconds": 2, "epochSecond": 10, "nano": 6 }, "metrics": { "actionMetricsMap": {}, "averageProcessingDurationMillis": 4, "discarded": 6, "errors": 1, "filterMetrics": { "averageProcessingDurationMillis": 5, "errors": 4, "excluded": 7, "highWatermarkProcessingDurationMillis": 10, "included": 2, "lowWatermarkProcessingDurationMillis": 4, "processed": 8 }, "generalError": "string", "generalErrorMillis": 2, "highWatermarkProcessingDurationMillis": 7, "lastException": "string", "lastExceptionMillis": 1, "lowWatermarkProcessingDurationMillis": 9, "processed": 4, "skipped": 10 }, "status": "NOT_RUNNING", "test": { "actionsTestList": [ { "actionName": "string", "discarded": false, "endMillis": 2, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 8 }, { "actionName": "string", "discarded": false, "endMillis": 3, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 6 } ], "discarded": false, "endMillis": 3, "exception": "string", "filterTest": { "endMillis": 9, "exception": "string", "input": {}, "result": false, "startMillis": 4 }, "generalError": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 7, "status": "SUCCESS" } } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string" } } }, "example": { "body": "body" } } } } } }, "/v1/workflows/{id}": { "get": { "tags": [ "Workflows" ], "operationId": "getWorkflow", "description": "The parameters and request body are for method: getWorkflow. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "priority": { "type": "number" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "actionName": { "type": "string" }, "configuration": { "type": "object" }, "description": { "type": "string" } } } }, "trigger": { "type": "object", "properties": { "entryFilter": { "type": "string" }, "type": { "type": "string" } } }, "type": { "type": "string" }, "createdBy": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "lastUpdated": { "type": "object", "properties": { "nanos": { "type": "number" }, "seconds": { "type": "number" }, "epochSecond": { "type": "number" }, "nano": { "type": "number" } } }, "metrics": { "type": "object", "properties": { "actionMetricsMap": { "type": "object" }, "averageProcessingDurationMillis": { "type": "number" }, "discarded": { "type": "number" }, "errors": { "type": "number" }, "filterMetrics": { "type": "object", "properties": { "averageProcessingDurationMillis": { "type": "number" }, "errors": { "type": "number" }, "excluded": { "type": "number" }, "highWatermarkProcessingDurationMillis": { "type": "number" }, "included": { "type": "number" }, "lowWatermarkProcessingDurationMillis": { "type": "number" }, "processed": { "type": "number" } } }, "generalError": { "type": "string" }, "generalErrorMillis": { "type": "number" }, "highWatermarkProcessingDurationMillis": { "type": "number" }, "lastException": { "type": "string" }, "lastExceptionMillis": { "type": "number" }, "lowWatermarkProcessingDurationMillis": { "type": "number" }, "processed": { "type": "number" }, "skipped": { "type": "number" } } }, "status": { "type": "string" }, "test": { "type": "object", "properties": { "actionsTestList": { "type": "array", "items": { "type": "object", "properties": { "actionName": { "type": "string" }, "discarded": { "type": "boolean" }, "endMillis": { "type": "number" }, "exception": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "skipped": { "type": "boolean" }, "startMillis": { "type": "number" } } } }, "discarded": { "type": "boolean" }, "endMillis": { "type": "number" }, "exception": { "type": "string" }, "filterTest": { "type": "object", "properties": { "endMillis": { "type": "number" }, "exception": { "type": "string" }, "input": { "type": "object" }, "result": { "type": "boolean" }, "startMillis": { "type": "number" } } }, "generalError": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "skipped": { "type": "boolean" }, "startMillis": { "type": "number" }, "status": { "type": "string" } } } } } } }, "example": { "status": "success", "data": { "description": "string", "name": "string", "priority": 10, "steps": [ { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" } ], "trigger": { "entryFilter": "string", "type": "EVENT_CREATED" }, "type": "EVENT", "createdBy": "string", "id": { "counter": 1, "randomValue1": 7, "randomValue2": 7, "timestamp": 10, "date": "string" }, "lastUpdated": { "nanos": 8, "seconds": 3, "epochSecond": 7, "nano": 5 }, "metrics": { "actionMetricsMap": {}, "averageProcessingDurationMillis": 1, "discarded": 6, "errors": 8, "filterMetrics": { "averageProcessingDurationMillis": 9, "errors": 3, "excluded": 2, "highWatermarkProcessingDurationMillis": 3, "included": 9, "lowWatermarkProcessingDurationMillis": 10, "processed": 6 }, "generalError": "string", "generalErrorMillis": 10, "highWatermarkProcessingDurationMillis": 4, "lastException": "string", "lastExceptionMillis": 6, "lowWatermarkProcessingDurationMillis": 6, "processed": 3, "skipped": 2 }, "status": "NOT_RUNNING", "test": { "actionsTestList": [ { "actionName": "string", "discarded": true, "endMillis": 6, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 7 }, { "actionName": "string", "discarded": true, "endMillis": 1, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 6 }, { "actionName": "string", "discarded": true, "endMillis": 3, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 7 }, { "actionName": "string", "discarded": true, "endMillis": 5, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 6 }, { "actionName": "string", "discarded": false, "endMillis": 5, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 8 }, { "actionName": "string", "discarded": false, "endMillis": 9, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 3 }, { "actionName": "string", "discarded": false, "endMillis": 9, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 8 }, { "actionName": "string", "discarded": false, "endMillis": 1, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 7 }, { "actionName": "string", "discarded": false, "endMillis": 1, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 1 } ], "discarded": true, "endMillis": 6, "exception": "string", "filterTest": { "endMillis": 2, "exception": "string", "input": {}, "result": false, "startMillis": 8 }, "generalError": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 8, "status": "RUNNING" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Workflows" ], "operationId": "deleteWorkflow", "description": "The parameters and request body are for method: deleteWorkflow. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Workflows" ], "operationId": "modifyWorkflow", "description": "The parameters and request body are for method: modifyWorkflow. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "priority": { "type": "number" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "actionName": { "type": "string" }, "configuration": { "type": "object" }, "description": { "type": "string" } } } }, "trigger": { "type": "object", "properties": { "entryFilter": { "type": "string" }, "type": { "type": "string" } } }, "type": { "type": "string" }, "createdBy": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "lastUpdated": { "type": "object", "properties": { "nanos": { "type": "number" }, "seconds": { "type": "number" }, "epochSecond": { "type": "number" }, "nano": { "type": "number" } } }, "metrics": { "type": "object", "properties": { "actionMetricsMap": { "type": "object" }, "averageProcessingDurationMillis": { "type": "number" }, "discarded": { "type": "number" }, "errors": { "type": "number" }, "filterMetrics": { "type": "object", "properties": { "averageProcessingDurationMillis": { "type": "number" }, "errors": { "type": "number" }, "excluded": { "type": "number" }, "highWatermarkProcessingDurationMillis": { "type": "number" }, "included": { "type": "number" }, "lowWatermarkProcessingDurationMillis": { "type": "number" }, "processed": { "type": "number" } } }, "generalError": { "type": "string" }, "generalErrorMillis": { "type": "number" }, "highWatermarkProcessingDurationMillis": { "type": "number" }, "lastException": { "type": "string" }, "lastExceptionMillis": { "type": "number" }, "lowWatermarkProcessingDurationMillis": { "type": "number" }, "processed": { "type": "number" }, "skipped": { "type": "number" } } }, "status": { "type": "string" }, "test": { "type": "object", "properties": { "actionsTestList": { "type": "array", "items": { "type": "object", "properties": { "actionName": { "type": "string" }, "discarded": { "type": "boolean" }, "endMillis": { "type": "number" }, "exception": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "skipped": { "type": "boolean" }, "startMillis": { "type": "number" } } } }, "discarded": { "type": "boolean" }, "endMillis": { "type": "number" }, "exception": { "type": "string" }, "filterTest": { "type": "object", "properties": { "endMillis": { "type": "number" }, "exception": { "type": "string" }, "input": { "type": "object" }, "result": { "type": "boolean" }, "startMillis": { "type": "number" } } }, "generalError": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "skipped": { "type": "boolean" }, "startMillis": { "type": "number" }, "status": { "type": "string" } } } } } } }, "example": { "status": "success", "data": { "description": "string", "name": "string", "priority": 5, "steps": [ { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" } ], "trigger": { "entryFilter": "string", "type": "EVENT_CREATED" }, "type": "EVENT", "createdBy": "string", "id": { "counter": 5, "randomValue1": 6, "randomValue2": 3, "timestamp": 8, "date": "string" }, "lastUpdated": { "nanos": 4, "seconds": 5, "epochSecond": 8, "nano": 9 }, "metrics": { "actionMetricsMap": {}, "averageProcessingDurationMillis": 9, "discarded": 4, "errors": 7, "filterMetrics": { "averageProcessingDurationMillis": 2, "errors": 3, "excluded": 5, "highWatermarkProcessingDurationMillis": 8, "included": 4, "lowWatermarkProcessingDurationMillis": 8, "processed": 2 }, "generalError": "string", "generalErrorMillis": 6, "highWatermarkProcessingDurationMillis": 10, "lastException": "string", "lastExceptionMillis": 8, "lowWatermarkProcessingDurationMillis": 5, "processed": 8, "skipped": 10 }, "status": "NOT_RUNNING", "test": { "actionsTestList": [ { "actionName": "string", "discarded": true, "endMillis": 4, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 6 }, { "actionName": "string", "discarded": false, "endMillis": 8, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 8 }, { "actionName": "string", "discarded": false, "endMillis": 5, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 9 }, { "actionName": "string", "discarded": true, "endMillis": 3, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 8 }, { "actionName": "string", "discarded": false, "endMillis": 10, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 1 }, { "actionName": "string", "discarded": false, "endMillis": 5, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 1 }, { "actionName": "string", "discarded": true, "endMillis": 4, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 8 }, { "actionName": "string", "discarded": false, "endMillis": 7, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 2 }, { "actionName": "string", "discarded": false, "endMillis": 4, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 2 } ], "discarded": true, "endMillis": 5, "exception": "string", "filterTest": { "endMillis": 4, "exception": "string", "input": {}, "result": false, "startMillis": 1 }, "generalError": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 9, "status": "FAILED" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/workflows/{id}/status": { "get": { "tags": [ "Workflows" ], "operationId": "getWorkflowStatus", "description": "The parameters and request body are for method: getWorkflowStatus. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "status": { "type": "string" } } } } }, "example": { "status": "success", "data": { "status": "RUNNING" } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Workflows" ], "operationId": "setWorkflowStatus", "description": "The parameters and request body are for method: setWorkflowStatus. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "priority": { "type": "number" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "actionName": { "type": "string" }, "configuration": { "type": "object" }, "description": { "type": "string" } } } }, "trigger": { "type": "object", "properties": { "entryFilter": { "type": "string" }, "type": { "type": "string" } } }, "type": { "type": "string" }, "createdBy": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "lastUpdated": { "type": "object", "properties": { "nanos": { "type": "number" }, "seconds": { "type": "number" }, "epochSecond": { "type": "number" }, "nano": { "type": "number" } } }, "metrics": { "type": "object", "properties": { "actionMetricsMap": { "type": "object" }, "averageProcessingDurationMillis": { "type": "number" }, "discarded": { "type": "number" }, "errors": { "type": "number" }, "filterMetrics": { "type": "object", "properties": { "averageProcessingDurationMillis": { "type": "number" }, "errors": { "type": "number" }, "excluded": { "type": "number" }, "highWatermarkProcessingDurationMillis": { "type": "number" }, "included": { "type": "number" }, "lowWatermarkProcessingDurationMillis": { "type": "number" }, "processed": { "type": "number" } } }, "generalError": { "type": "string" }, "generalErrorMillis": { "type": "number" }, "highWatermarkProcessingDurationMillis": { "type": "number" }, "lastException": { "type": "string" }, "lastExceptionMillis": { "type": "number" }, "lowWatermarkProcessingDurationMillis": { "type": "number" }, "processed": { "type": "number" }, "skipped": { "type": "number" } } }, "status": { "type": "string" }, "test": { "type": "object", "properties": { "actionsTestList": { "type": "array", "items": { "type": "object", "properties": { "actionName": { "type": "string" }, "discarded": { "type": "boolean" }, "endMillis": { "type": "number" }, "exception": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "skipped": { "type": "boolean" }, "startMillis": { "type": "number" } } } }, "discarded": { "type": "boolean" }, "endMillis": { "type": "number" }, "exception": { "type": "string" }, "filterTest": { "type": "object", "properties": { "endMillis": { "type": "number" }, "exception": { "type": "string" }, "input": { "type": "object" }, "result": { "type": "boolean" }, "startMillis": { "type": "number" } } }, "generalError": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "skipped": { "type": "boolean" }, "startMillis": { "type": "number" }, "status": { "type": "string" } } } } } } }, "example": { "status": "success", "data": { "description": "string", "name": "string", "priority": 2, "steps": [ { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" } ], "trigger": { "entryFilter": "string", "type": "EVENT_CREATED" }, "type": "EVENT", "createdBy": "string", "id": { "counter": 9, "randomValue1": 10, "randomValue2": 1, "timestamp": 9, "date": "string" }, "lastUpdated": { "nanos": 5, "seconds": 5, "epochSecond": 10, "nano": 9 }, "metrics": { "actionMetricsMap": {}, "averageProcessingDurationMillis": 9, "discarded": 8, "errors": 7, "filterMetrics": { "averageProcessingDurationMillis": 6, "errors": 4, "excluded": 4, "highWatermarkProcessingDurationMillis": 3, "included": 7, "lowWatermarkProcessingDurationMillis": 6, "processed": 2 }, "generalError": "string", "generalErrorMillis": 9, "highWatermarkProcessingDurationMillis": 10, "lastException": "string", "lastExceptionMillis": 2, "lowWatermarkProcessingDurationMillis": 1, "processed": 4, "skipped": 4 }, "status": "RUNNING", "test": { "actionsTestList": [ { "actionName": "string", "discarded": true, "endMillis": 8, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 6 }, { "actionName": "string", "discarded": true, "endMillis": 10, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 1 }, { "actionName": "string", "discarded": true, "endMillis": 5, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 8 }, { "actionName": "string", "discarded": true, "endMillis": 2, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 10 } ], "discarded": true, "endMillis": 10, "exception": "string", "filterTest": { "endMillis": 8, "exception": "string", "input": {}, "result": true, "startMillis": 5 }, "generalError": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 7, "status": "SUCCESS" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/workflows-bulk/priority": { "patch": { "tags": [ "Workflows" ], "operationId": "setWorkflowPriorities", "description": "The parameters and request body are for method: setWorkflowPriorities. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string" } } }, "example": { "body": "body" } } } } } }, "/v1/workflows/{id}/metrics": { "get": { "tags": [ "Workflows" ], "operationId": "getWorkflowMetrics", "description": "The parameters and request body are for method: getWorkflowMetrics. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "actionMetricsMap": { "type": "object" }, "averageProcessingDurationMillis": { "type": "number" }, "discarded": { "type": "number" }, "errors": { "type": "number" }, "filterMetrics": { "type": "object", "properties": { "averageProcessingDurationMillis": { "type": "number" }, "errors": { "type": "number" }, "excluded": { "type": "number" }, "highWatermarkProcessingDurationMillis": { "type": "number" }, "included": { "type": "number" }, "lowWatermarkProcessingDurationMillis": { "type": "number" }, "processed": { "type": "number" } } }, "generalError": { "type": "string" }, "generalErrorMillis": { "type": "number" }, "highWatermarkProcessingDurationMillis": { "type": "number" }, "lastException": { "type": "string" }, "lastExceptionMillis": { "type": "number" }, "lowWatermarkProcessingDurationMillis": { "type": "number" }, "processed": { "type": "number" }, "skipped": { "type": "number" } } } } }, "example": { "status": "success", "data": { "actionMetricsMap": {}, "averageProcessingDurationMillis": 10, "discarded": 8, "errors": 6, "filterMetrics": { "averageProcessingDurationMillis": 8, "errors": 8, "excluded": 4, "highWatermarkProcessingDurationMillis": 1, "included": 10, "lowWatermarkProcessingDurationMillis": 10, "processed": 3 }, "generalError": "string", "generalErrorMillis": 4, "highWatermarkProcessingDurationMillis": 9, "lastException": "string", "lastExceptionMillis": 8, "lowWatermarkProcessingDurationMillis": 1, "processed": 3, "skipped": 10 } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/workflows": { "get": { "tags": [ "Workflows" ], "operationId": "getWorkflows", "description": "The parameters and request body are for method: getWorkflows. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "priority": { "type": "number" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "actionName": { "type": "string" }, "configuration": { "type": "object" }, "description": { "type": "string" } } } }, "trigger": { "type": "object", "properties": { "entryFilter": { "type": "string" }, "type": { "type": "string" } } }, "type": { "type": "string" }, "createdBy": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "lastUpdated": { "type": "object", "properties": { "nanos": { "type": "number" }, "seconds": { "type": "number" }, "epochSecond": { "type": "number" }, "nano": { "type": "number" } } }, "metrics": { "type": "object", "properties": { "actionMetricsMap": { "type": "object" }, "averageProcessingDurationMillis": { "type": "number" }, "discarded": { "type": "number" }, "errors": { "type": "number" }, "filterMetrics": { "type": "object", "properties": { "averageProcessingDurationMillis": { "type": "number" }, "errors": { "type": "number" }, "excluded": { "type": "number" }, "highWatermarkProcessingDurationMillis": { "type": "number" }, "included": { "type": "number" }, "lowWatermarkProcessingDurationMillis": { "type": "number" }, "processed": { "type": "number" } } }, "generalError": { "type": "string" }, "generalErrorMillis": { "type": "number" }, "highWatermarkProcessingDurationMillis": { "type": "number" }, "lastException": { "type": "string" }, "lastExceptionMillis": { "type": "number" }, "lowWatermarkProcessingDurationMillis": { "type": "number" }, "processed": { "type": "number" }, "skipped": { "type": "number" } } }, "status": { "type": "string" }, "test": { "type": "object", "properties": { "actionsTestList": { "type": "array", "items": { "type": "object", "properties": { "actionName": { "type": "string" }, "discarded": { "type": "boolean" }, "endMillis": { "type": "number" }, "exception": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "skipped": { "type": "boolean" }, "startMillis": { "type": "number" } } } }, "discarded": { "type": "boolean" }, "endMillis": { "type": "number" }, "exception": { "type": "string" }, "filterTest": { "type": "object", "properties": { "endMillis": { "type": "number" }, "exception": { "type": "string" }, "input": { "type": "object" }, "result": { "type": "boolean" }, "startMillis": { "type": "number" } } }, "generalError": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "skipped": { "type": "boolean" }, "startMillis": { "type": "number" }, "status": { "type": "string" } } } } } }, "example": [ { "description": "string", "name": "string", "priority": 4, "steps": [ { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" } ], "trigger": { "entryFilter": "string", "type": "EVENT_CREATED" }, "type": "EVENT", "createdBy": "string", "id": { "counter": 9, "randomValue1": 8, "randomValue2": 9, "timestamp": 3, "date": "string" }, "lastUpdated": { "nanos": 5, "seconds": 10, "epochSecond": 3, "nano": 4 }, "metrics": { "actionMetricsMap": {}, "averageProcessingDurationMillis": 2, "discarded": 6, "errors": 5, "filterMetrics": { "averageProcessingDurationMillis": 10, "errors": 8, "excluded": 6, "highWatermarkProcessingDurationMillis": 7, "included": 3, "lowWatermarkProcessingDurationMillis": 8, "processed": 9 }, "generalError": "string", "generalErrorMillis": 8, "highWatermarkProcessingDurationMillis": 5, "lastException": "string", "lastExceptionMillis": 2, "lowWatermarkProcessingDurationMillis": 8, "processed": 6, "skipped": 5 }, "status": "NOT_RUNNING", "test": { "actionsTestList": [ { "actionName": "string", "discarded": false, "endMillis": 3, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 5 }, { "actionName": "string", "discarded": true, "endMillis": 7, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 5 }, { "actionName": "string", "discarded": true, "endMillis": 3, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 2 }, { "actionName": "string", "discarded": false, "endMillis": 9, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 7 }, { "actionName": "string", "discarded": true, "endMillis": 8, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 9 }, { "actionName": "string", "discarded": false, "endMillis": 2, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 6 }, { "actionName": "string", "discarded": false, "endMillis": 1, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 1 }, { "actionName": "string", "discarded": true, "endMillis": 6, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 1 }, { "actionName": "string", "discarded": true, "endMillis": 9, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 6 } ], "discarded": true, "endMillis": 6, "exception": "string", "filterTest": { "endMillis": 4, "exception": "string", "input": {}, "result": false, "startMillis": 3 }, "generalError": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 3, "status": "RUNNING" } }, { "description": "string", "name": "string", "priority": 6, "steps": [ { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" } ], "trigger": { "entryFilter": "string", "type": "EVENT_CREATED" }, "type": "EVENT", "createdBy": "string", "id": { "counter": 3, "randomValue1": 4, "randomValue2": 1, "timestamp": 4, "date": "string" }, "lastUpdated": { "nanos": 3, "seconds": 4, "epochSecond": 6, "nano": 2 }, "metrics": { "actionMetricsMap": {}, "averageProcessingDurationMillis": 10, "discarded": 2, "errors": 2, "filterMetrics": { "averageProcessingDurationMillis": 7, "errors": 1, "excluded": 8, "highWatermarkProcessingDurationMillis": 2, "included": 1, "lowWatermarkProcessingDurationMillis": 10, "processed": 5 }, "generalError": "string", "generalErrorMillis": 9, "highWatermarkProcessingDurationMillis": 8, "lastException": "string", "lastExceptionMillis": 8, "lowWatermarkProcessingDurationMillis": 9, "processed": 2, "skipped": 1 }, "status": "RUNNING", "test": { "actionsTestList": [ { "actionName": "string", "discarded": true, "endMillis": 5, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 3 }, { "actionName": "string", "discarded": false, "endMillis": 6, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 6 }, { "actionName": "string", "discarded": false, "endMillis": 9, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 4 }, { "actionName": "string", "discarded": false, "endMillis": 10, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 1 } ], "discarded": false, "endMillis": 4, "exception": "string", "filterTest": { "endMillis": 7, "exception": "string", "input": {}, "result": false, "startMillis": 7 }, "generalError": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 5, "status": "FAILED" } }, { "description": "string", "name": "string", "priority": 7, "steps": [ { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" } ], "trigger": { "entryFilter": "string", "type": "EVENT_CREATED" }, "type": "EVENT", "createdBy": "string", "id": { "counter": 8, "randomValue1": 1, "randomValue2": 6, "timestamp": 4, "date": "string" }, "lastUpdated": { "nanos": 8, "seconds": 4, "epochSecond": 7, "nano": 4 }, "metrics": { "actionMetricsMap": {}, "averageProcessingDurationMillis": 5, "discarded": 1, "errors": 8, "filterMetrics": { "averageProcessingDurationMillis": 10, "errors": 1, "excluded": 10, "highWatermarkProcessingDurationMillis": 3, "included": 3, "lowWatermarkProcessingDurationMillis": 5, "processed": 10 }, "generalError": "string", "generalErrorMillis": 4, "highWatermarkProcessingDurationMillis": 7, "lastException": "string", "lastExceptionMillis": 7, "lowWatermarkProcessingDurationMillis": 8, "processed": 10, "skipped": 9 }, "status": "DELETED", "test": { "actionsTestList": [ { "actionName": "string", "discarded": false, "endMillis": 1, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 1 }, { "actionName": "string", "discarded": true, "endMillis": 10, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 9 }, { "actionName": "string", "discarded": true, "endMillis": 8, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 9 }, { "actionName": "string", "discarded": false, "endMillis": 4, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 10 } ], "discarded": false, "endMillis": 9, "exception": "string", "filterTest": { "endMillis": 3, "exception": "string", "input": {}, "result": true, "startMillis": 2 }, "generalError": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 6, "status": "FAILED" } }, { "description": "string", "name": "string", "priority": 2, "steps": [ { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" } ], "trigger": { "entryFilter": "string", "type": "EVENT_CREATED" }, "type": "EVENT", "createdBy": "string", "id": { "counter": 9, "randomValue1": 8, "randomValue2": 8, "timestamp": 2, "date": "string" }, "lastUpdated": { "nanos": 10, "seconds": 7, "epochSecond": 10, "nano": 8 }, "metrics": { "actionMetricsMap": {}, "averageProcessingDurationMillis": 5, "discarded": 9, "errors": 2, "filterMetrics": { "averageProcessingDurationMillis": 8, "errors": 2, "excluded": 5, "highWatermarkProcessingDurationMillis": 2, "included": 10, "lowWatermarkProcessingDurationMillis": 9, "processed": 6 }, "generalError": "string", "generalErrorMillis": 7, "highWatermarkProcessingDurationMillis": 1, "lastException": "string", "lastExceptionMillis": 3, "lowWatermarkProcessingDurationMillis": 9, "processed": 9, "skipped": 3 }, "status": "NOT_RUNNING", "test": { "actionsTestList": [ { "actionName": "string", "discarded": true, "endMillis": 4, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 4 }, { "actionName": "string", "discarded": false, "endMillis": 6, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 2 } ], "discarded": false, "endMillis": 3, "exception": "string", "filterTest": { "endMillis": 6, "exception": "string", "input": {}, "result": false, "startMillis": 7 }, "generalError": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 9, "status": "FAILED" } } ] } } } }, "parameters": [ { "name": "status", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Workflows" ], "operationId": "createWorkflow", "description": "The parameters and request body are for method: createWorkflow. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "priority": { "type": "number" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "actionName": { "type": "string" }, "configuration": { "type": "object" }, "description": { "type": "string" } } } }, "trigger": { "type": "object", "properties": { "entryFilter": { "type": "string" }, "type": { "type": "string" } } }, "type": { "type": "string" }, "createdBy": { "type": "string" }, "id": { "type": "object", "properties": { "counter": { "type": "number" }, "randomValue1": { "type": "number" }, "randomValue2": { "type": "number" }, "timestamp": { "type": "number" }, "date": { "type": "string" } } }, "lastUpdated": { "type": "object", "properties": { "nanos": { "type": "number" }, "seconds": { "type": "number" }, "epochSecond": { "type": "number" }, "nano": { "type": "number" } } }, "metrics": { "type": "object", "properties": { "actionMetricsMap": { "type": "object" }, "averageProcessingDurationMillis": { "type": "number" }, "discarded": { "type": "number" }, "errors": { "type": "number" }, "filterMetrics": { "type": "object", "properties": { "averageProcessingDurationMillis": { "type": "number" }, "errors": { "type": "number" }, "excluded": { "type": "number" }, "highWatermarkProcessingDurationMillis": { "type": "number" }, "included": { "type": "number" }, "lowWatermarkProcessingDurationMillis": { "type": "number" }, "processed": { "type": "number" } } }, "generalError": { "type": "string" }, "generalErrorMillis": { "type": "number" }, "highWatermarkProcessingDurationMillis": { "type": "number" }, "lastException": { "type": "string" }, "lastExceptionMillis": { "type": "number" }, "lowWatermarkProcessingDurationMillis": { "type": "number" }, "processed": { "type": "number" }, "skipped": { "type": "number" } } }, "status": { "type": "string" }, "test": { "type": "object", "properties": { "actionsTestList": { "type": "array", "items": { "type": "object", "properties": { "actionName": { "type": "string" }, "discarded": { "type": "boolean" }, "endMillis": { "type": "number" }, "exception": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "skipped": { "type": "boolean" }, "startMillis": { "type": "number" } } } }, "discarded": { "type": "boolean" }, "endMillis": { "type": "number" }, "exception": { "type": "string" }, "filterTest": { "type": "object", "properties": { "endMillis": { "type": "number" }, "exception": { "type": "string" }, "input": { "type": "object" }, "result": { "type": "boolean" }, "startMillis": { "type": "number" } } }, "generalError": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "skipped": { "type": "boolean" }, "startMillis": { "type": "number" }, "status": { "type": "string" } } } } } } }, "example": { "status": "success", "data": { "description": "string", "name": "string", "priority": 4, "steps": [ { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" }, { "actionName": "string", "configuration": {}, "description": "string" } ], "trigger": { "entryFilter": "string", "type": "EVENT_CREATED" }, "type": "EVENT", "createdBy": "string", "id": { "counter": 3, "randomValue1": 8, "randomValue2": 4, "timestamp": 2, "date": "string" }, "lastUpdated": { "nanos": 9, "seconds": 7, "epochSecond": 10, "nano": 4 }, "metrics": { "actionMetricsMap": {}, "averageProcessingDurationMillis": 1, "discarded": 9, "errors": 10, "filterMetrics": { "averageProcessingDurationMillis": 5, "errors": 8, "excluded": 2, "highWatermarkProcessingDurationMillis": 9, "included": 6, "lowWatermarkProcessingDurationMillis": 7, "processed": 1 }, "generalError": "string", "generalErrorMillis": 8, "highWatermarkProcessingDurationMillis": 1, "lastException": "string", "lastExceptionMillis": 5, "lowWatermarkProcessingDurationMillis": 5, "processed": 5, "skipped": 2 }, "status": "DELETED", "test": { "actionsTestList": [ { "actionName": "string", "discarded": false, "endMillis": 2, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 7 }, { "actionName": "string", "discarded": false, "endMillis": 7, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 4 }, { "actionName": "string", "discarded": true, "endMillis": 8, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 2 }, { "actionName": "string", "discarded": true, "endMillis": 2, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 3 }, { "actionName": "string", "discarded": true, "endMillis": 7, "exception": "string", "input": {}, "output": {}, "skipped": true, "startMillis": 8 }, { "actionName": "string", "discarded": true, "endMillis": 8, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 6 }, { "actionName": "string", "discarded": true, "endMillis": 3, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 8 }, { "actionName": "string", "discarded": false, "endMillis": 3, "exception": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 5 } ], "discarded": true, "endMillis": 5, "exception": "string", "filterTest": { "endMillis": 7, "exception": "string", "input": {}, "result": true, "startMillis": 5 }, "generalError": "string", "input": {}, "output": {}, "skipped": false, "startMillis": 4, "status": "SUCCESS" } } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "components": { "schemas": {} } }