diff --git a/openapi.json b/openapi.json index 089c2fe..d5394c8 100644 --- a/openapi.json +++ b/openapi.json @@ -8,7 +8,7 @@ }, "termsOfService": "https://www.instana.com/terms-of-use/", "title": "Introduction to Instana public APIs", - "version": "1.267.840", + "version": "1.268.807", "x-logo": { "altText": "instana logo", "backgroundColor": "#FAFBFC", @@ -2294,8 +2294,277 @@ "description": "Update an existing Application Perspective.\n\n## Deprecated Parameters\n**matchSpecification:** A binary tree sturcture of match expression connected with binary operator AND or OR. It is replaced by **tagFilterExpression** which is also used in Application Analyze API endpoints." } }, + "/api/application-monitoring/settings/endpoint": { + "get": { + "operationId": "getEndpointConfigs", + "responses": { + "default": { + "content": { + "application/json": { + "example": [ + { + "serviceId": "d0cedae516f2182ede16f57f67476dd4c7dab9cd", + "endpointCase": "LOWER", + "endpointNameByFirstPathSegmentRuleEnabled": false, + "endpointNameByCollectedPathTemplateRuleEnabled": false, + "rules": null + }, + { + "serviceId": "d0cedae516f2182ede16f57f67476dd4c7dab9cd", + "endpointCase": "UPPER", + "endpointNameByFirstPathSegmentRuleEnabled": false, + "endpointNameByCollectedPathTemplateRuleEnabled": false, + "rules": null + } + ], + "schema": { + "type": "array", + "example": null, + "items": { + "$ref": "#/components/schemas/EndpointConfig" + } + } + } + } + } + }, + "security": [ + { + "ApiKeyAuth": [ + "ConfigureServiceMapping" + ] + } + ], + "summary": "All Endpoint configurations", + "tags": [ + "Application Settings" + ] + }, + "post": { + "operationId": "createEndpointConfig", + "requestBody": { + "content": { + "application/json": { + "example": { + "serviceId": "d0cedae516f2182ede16f57f67476dd4c7dab9cd", + "endpointCase": "LOWER", + "endpointNameByFirstPathSegmentRuleEnabled": false, + "endpointNameByCollectedPathTemplateRuleEnabled": false, + "rules": null + }, + "schema": { + "$ref": "#/components/schemas/EndpointConfig" + } + } + }, + "required": true + }, + "responses": { + "default": { + "content": { + "application/json": { + "example": { + "serviceId": "d0cedae516f2182ede16f57f67476dd4c7dab9cd", + "endpointCase": "LOWER", + "endpointNameByFirstPathSegmentRuleEnabled": false, + "endpointNameByCollectedPathTemplateRuleEnabled": false, + "rules": null + }, + "schema": { + "$ref": "#/components/schemas/EndpointConfig" + } + } + } + } + }, + "security": [ + { + "ApiKeyAuth": [ + "ConfigureServiceMapping" + ] + } + ], + "summary": "Create endpoint configuration", + "tags": [ + "Application Settings" + ] + } + }, + "/api/application-monitoring/settings/endpoint/{id}": { + "delete": { + "operationId": "deleteEndpointConfig", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string", + "example": null + } + } + ], + "responses": { + "default": { + "content": { + "application/json": {} + }, + "description": "default response" + } + }, + "security": [ + { + "ApiKeyAuth": [ + "ConfigureServiceMapping" + ] + } + ], + "summary": "Delete endpoint configuration", + "tags": [ + "Application Settings" + ] + }, + "get": { + "operationId": "getEndpointConfig", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string", + "example": null + } + } + ], + "responses": { + "default": { + "content": { + "application/json": { + "example": { + "serviceId": "d0cedae516f2182ede16f57f67476dd4c7dab9cd", + "endpointCase": "LOWER", + "endpointNameByFirstPathSegmentRuleEnabled": false, + "endpointNameByCollectedPathTemplateRuleEnabled": false, + "rules": null + }, + "schema": { + "$ref": "#/components/schemas/EndpointConfig" + } + } + } + } + }, + "security": [ + { + "ApiKeyAuth": [ + "ConfigureServiceMapping" + ] + } + ], + "summary": "Endpoint configuration", + "tags": [ + "Application Settings" + ] + }, + "put": { + "operationId": "updateEndpointConfig", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string", + "example": null + } + } + ], + "requestBody": { + "content": { + "application/json": { + "example": { + "serviceId": "20ba31821b079e7d845a08096124880db3eeeb40", + "endpointNameByCollectedPathTemplateRuleEnabled": true, + "endpointNameByFirstPathSegmentRuleEnabled": true, + "rules": [ + { + "enabled": true, + "pathSegments": [ + { + "name": "api", + "type": "FIXED" + }, + { + "name": "version", + "type": "PARAMETER" + } + ], + "testCases": [ + "/api/v2/users" + ] + } + ], + "endpointCase": "UPPER" + }, + "schema": { + "$ref": "#/components/schemas/EndpointConfig" + } + } + }, + "required": true + }, + "responses": { + "default": { + "content": { + "application/json": { + "example": { + "serviceId": "20ba31821b079e7d845a08096124880db3eeeb40", + "endpointNameByCollectedPathTemplateRuleEnabled": true, + "endpointNameByFirstPathSegmentRuleEnabled": true, + "rules": [ + { + "enabled": true, + "pathSegments": [ + { + "name": "api", + "type": "FIXED" + }, + { + "name": "version", + "type": "PARAMETER" + } + ], + "testCases": [ + "/api/v2/users" + ] + } + ], + "endpointCase": "UPPER" + }, + "schema": { + "$ref": "#/components/schemas/EndpointConfig" + } + } + } + } + }, + "security": [ + { + "ApiKeyAuth": [ + "ConfigureServiceMapping" + ] + } + ], + "summary": "Update endpoint configuration", + "tags": [ + "Application Settings" + ] + } + }, "/api/application-monitoring/settings/http-endpoint": { "get": { + "deprecated": true, "operationId": "getHttpEndpointConfigs", "responses": { "default": { @@ -2345,12 +2614,13 @@ ] } ], - "summary": "All Endpoint configurations", + "summary": "All HTTP endpoint configurations", "tags": [ "Application Settings" ] }, "post": { + "deprecated": true, "operationId": "createHttpEndpointConfig", "requestBody": { "content": { @@ -2416,7 +2686,7 @@ ] } ], - "summary": "Create endpoint configuration", + "summary": "Create HTTP endpoint configuration", "tags": [ "Application Settings" ] @@ -2424,6 +2694,7 @@ }, "/api/application-monitoring/settings/http-endpoint/{id}": { "delete": { + "deprecated": true, "operationId": "deleteHttpEndpointConfig", "parameters": [ { @@ -2451,12 +2722,13 @@ ] } ], - "summary": "Delete endpoint configuration", + "summary": "Delete HTTP endpoint configuration", "tags": [ "Application Settings" ] }, "get": { + "deprecated": true, "operationId": "getHttpEndpointConfig", "parameters": [ { @@ -2513,12 +2785,13 @@ ] } ], - "summary": "Endpoint configuration", + "summary": "HTTP Endpoint configuration", "tags": [ "Application Settings" ] }, "put": { + "deprecated": true, "operationId": "updateHttpEndpointConfig", "parameters": [ { @@ -2611,7 +2884,7 @@ ] } ], - "summary": "Update endpoint configuration", + "summary": "Update HTTP endpoint configuration", "tags": [ "Application Settings" ] @@ -3483,42 +3756,161 @@ "example": { "items": [ { - "id": "daa9141549aea210", - "timestamp": 1688544599223, - "parentId": null, - "foreignParentId": null, - "name": "GET /api/shipping/cities/dk", - "duration": 30, - "minSelfTime": 1, - "networkTime": null, - "callCount": 1, + "id": "daa9141549aea210", + "timestamp": 1688544599223, + "parentId": null, + "foreignParentId": null, + "name": "GET /api/shipping/cities/dk", + "duration": 30, + "minSelfTime": 1, + "networkTime": null, + "callCount": 1, + "errorCount": 0, + "destination": { + "service": { + "id": "ce4b152bac7b99744d8314838e49b799afd6dd96", + "label": "nginx-web" + }, + "endpoint": { + "id": "wAS2omB44e0EK4xqL7f-e-wt4C4", + "label": "upstream shipping", + "type": "HTTP" + }, + "technologies": [] + }, + "cursor": { + "@class": ".IngestionOffsetCursor", + "ingestionTime": 1688547327000, + "offset": 1 + } + } + ], + "canLoadMore": false, + "totalHits": 3, + "totalRepresentedItemCount": 3, + "totalRetainedItemCount": 3 + }, + "schema": { + "$ref": "#/components/schemas/TraceDownloadResult" + } + } + } + } + }, + "security": [ + { + "ApiKeyAuth": [ + "Default" + ] + } + ], + "summary": "Get trace detail", + "tags": [ + "Application Analyze" + ] + } + }, + "/api/application-monitoring/v2/analyze/traces/{traceId}/calls/{callId}/details": { + "get": { + "operationId": "getCallDetails", + "parameters": [ + { + "in": "path", + "name": "traceId", + "required": true, + "schema": { + "type": "string", + "example": null + } + }, + { + "in": "path", + "name": "callId", + "required": true, + "schema": { + "type": "string", + "example": null + } + } + ], + "responses": { + "default": { + "content": { + "application/json": { + "example": { + "id": "14219b3deb6a6bc5", + "label": "GET /api/shipping/cities/bg", + "start": 1707295859759, + "duration": 3597, + "minSelfTime": 2, + "networkTime": null, + "errorCount": 0, + "batchSize": 1, + "batchSelfTime": 3597, + "source": { + "applications": [], + "service": { + "id": "ROOT", + "label": "" + }, + "endpoint": { + "id": "XCjGvnwuiak0m3ISke3naE-NrGA", + "label": "Unspecified", + "type": "UNDEFINED" + }, + "physicalContext": {} + }, + "destination": { + "applications": [], + "service": { + "id": "ce4b152bac7b99744d8314838e49b799afd6dd96", + "label": "nginx-web" + }, + "endpoint": { + "id": "wAS2omB44e0EK4xqL7f-e-wt4C4", + "label": "upstream shipping", + "type": "HTTP" + }, + "physicalContext": { + "process": { + "id": "jXvrnXHuBqfhlZQTux-ck1PYd6Y", + "time": 1707258023000, + "label": "Node @30303", + "plugin": "nginx", + "data": null + } + } + }, + "spans": [ + { + "id": "14219b3deb6a6bc5", + "parentId": "", + "name": "sdk.http.entry", + "kind": "ENTRY", + "foreignParentId": "", + "start": 1707295859759, + "duration": 3597, "errorCount": 0, - "destination": { - "service": { - "id": "ce4b152bac7b99744d8314838e49b799afd6dd96", - "label": "nginx-web" - }, - "endpoint": { - "id": "wAS2omB44e0EK4xqL7f-e-wt4C4", - "label": "upstream shipping", - "type": "HTTP" - }, - "technologies": [] - }, - "cursor": { - "@class": ".IngestionOffsetCursor", - "ingestionTime": 1688547327000, - "offset": 1 + "stackTrace": [], + "data": { + "service": "nginx-web", + "http": { + "path": "/api/shipping/cities/bg", + "protocol": "http", + "route_id": "upstream shipping", + "method": "GET", + "host": "web:8080", + "url": "http://web:8080//api/shipping/cities/bg", + "status": 200 + } } } ], - "canLoadMore": false, - "totalHits": 3, - "totalRepresentedItemCount": 3, - "totalRetainedItemCount": 3 + "logs": [], + "synthetic": false }, "schema": { - "$ref": "#/components/schemas/TraceDownloadResult" + "$ref": "#/components/schemas/TraceActivityTreeNodeDetails" } } } @@ -3531,7 +3923,7 @@ ] } ], - "summary": "Get trace detail", + "summary": "Get call detail", "tags": [ "Application Analyze" ] @@ -4639,6 +5031,8 @@ "operationId": "findActiveApplicationAlertConfigs", "parameters": [ { + "description": "Application Id", + "example": "IYS1XOEcTNiT1eOD8pxgXg", "in": "query", "name": "applicationId", "schema": { @@ -4647,6 +5041,11 @@ } }, { + "description": "Alert Ids", + "example": [ + "5GJXiK9aciVaBPnu", + "lXQ3rSSWVAl0VhBM" + ], "in": "query", "name": "alertIds", "schema": { @@ -4663,9 +5062,58 @@ } ], "responses": { - "default": { + "200": { "content": { "application/json": { + "example": [ + { + "name": "Erroneous call rate is higher than normal", + "description": "The erroneous call rate is higher or equal to 4%.", + "boundaryScope": "ALL", + "applicationId": "IYS1XOEcTNiT1eOD8pxgXg", + "applications": { + "IYS1XOEcTNiT1eOD8pxgXg": { + "applicationId": "IYS1XOEcTNiT1eOD8pxgXg", + "inclusive": true, + "services": {} + } + }, + "severity": 5, + "triggering": false, + "tagFilterExpression": { + "type": "EXPRESSION", + "logicalOperator": "AND", + "elements": [] + }, + "includeInternal": false, + "includeSynthetic": false, + "rule": { + "alertType": "errors", + "metricName": "errors", + "aggregation": "MEAN" + }, + "threshold": { + "type": "staticThreshold", + "operator": ">=", + "value": 0.04, + "lastUpdated": 0 + }, + "alertChannelIds": [], + "granularity": 600000, + "timeThreshold": { + "type": "violationsInSequence", + "timeWindow": 600000 + }, + "evaluationType": "PER_AP", + "customPayloadFields": [], + "id": "A5VvSXR_SVG6z7YbnIHiHQ", + "created": 1707751873882, + "initialCreated": 1707751873882, + "readOnly": false, + "enabled": true, + "derivedFromGlobalAlert": false + } + ], "schema": { "type": "array", "example": null, @@ -4674,7 +5122,8 @@ } } } - } + }, + "description": "OK" } }, "security": [ @@ -4765,6 +5214,8 @@ "operationId": "findApplicationAlertConfig", "parameters": [ { + "description": "Application Alert Config ID", + "example": "DKp0JArJRAiQIav9CoKSWQ", "in": "path", "name": "id", "required": true, @@ -4774,6 +5225,8 @@ } }, { + "description": "Timestamp for each Id", + "example": 1706617456952, "in": "query", "name": "validOn", "schema": { @@ -4784,14 +5237,81 @@ } ], "responses": { - "default": { + "200": { "content": { "application/json": { + "example": { + "name": "Calls are slower than usual", + "description": "Calls are slower or equal to the expectation based on latency (90th).", + "boundaryScope": "INBOUND", + "applicationId": "ZOi0te_ERE-mRm-9zsbwdg", + "applications": { + "ZOi0te_ERE-mRm-9zsbwdg": { + "applicationId": "ZOi0te_ERE-mRm-9zsbwdg", + "inclusive": true, + "services": {} + } + }, + "severity": 5, + "triggering": false, + "tagFilterExpression": { + "type": "TAG_FILTER", + "name": "endpoint.name", + "stringValue": null, + "numberValue": null, + "booleanValue": null, + "key": null, + "value": null, + "operator": "NOT_EMPTY", + "entity": "DESTINATION" + }, + "includeInternal": false, + "includeSynthetic": false, + "rule": { + "alertType": "slowness", + "aggregation": "P90", + "metricName": "latency" + }, + "threshold": { + "type": "historicBaseline", + "operator": ">=", + "seasonality": "DAILY", + "baseline": [ + [ + 0, + 1, + 3 + ], + [ + 600000, + 1, + 3 + ] + ], + "deviationFactor": 3, + "lastUpdated": 0 + }, + "alertChannelIds": [], + "granularity": 600000, + "timeThreshold": { + "type": "violationsInSequence", + "timeWindow": 600000 + }, + "evaluationType": "PER_AP", + "customPayloadFields": [], + "id": "DKp0JArJRAiQIav9CoKSWQ", + "created": 1706617456952, + "initialCreated": 1706617456952, + "readOnly": false, + "enabled": true, + "derivedFromGlobalAlert": false + }, "schema": { "$ref": "#/components/schemas/ApplicationAlertConfigWithMetadata" } } - } + }, + "description": "OK" } }, "security": [ @@ -5047,6 +5567,8 @@ "operationId": "findApplicationAlertConfigVersions", "parameters": [ { + "description": "Applicaiton Id", + "example": "DKp0JArJRAiQIav9CoKSWQ", "in": "path", "name": "id", "required": true, @@ -5060,6 +5582,22 @@ "default": { "content": { "application/json": { + "example": [ + { + "id": "DKp0JArJRAiQIav9CoKSWQ", + "created": 1706617456952, + "enabled": true, + "deleted": false, + "changeSummary": { + "changeType": "CREATE", + "author": { + "id": "5ee8a3e8cd70020001ecb007", + "type": "USER", + "fullName": "Stan" + } + } + } + ], "schema": { "type": "array", "example": null, @@ -5122,7 +5660,8 @@ "WEBSITE", "SYNTHETIC", "MOBILE_APP", - "INFRA" + "INFRA", + "LOG" ], "example": null } @@ -14467,6 +15006,8 @@ "operationId": "getSli", "parameters": [ { + "description": "sliId", + "example": "nCtEoR6NSPqG61QkIkwwCw", "in": "path", "name": "sliId", "required": true, @@ -14476,8 +15017,11 @@ } }, { + "description": "slo target", + "example": 0.99, "in": "query", "name": "slo", + "required": true, "schema": { "type": "number", "format": "double", @@ -14485,8 +15029,11 @@ } }, { + "description": "Timestamp milliseconds (13-digit)", + "example": 1706713140000, "in": "query", "name": "from", + "required": true, "schema": { "type": "integer", "format": "int64", @@ -14494,8 +15041,11 @@ } }, { + "description": "Timestamp milliseconds (13-digit)", + "example": 1706713140000, "in": "query", "name": "to", + "required": true, "schema": { "type": "integer", "format": "int64", @@ -14504,9 +15054,18 @@ } ], "responses": { - "default": { + "200": { "content": { "application/json": { + "example": { + "sli": 0.008228916434859497, + "slo": 0.1, + "totalErrorBudget": 10236633, + "errorBudgetRemaining": -1043808, + "fromTimestamp": 1707771600000, + "toTimestamp": 1707858000000, + "violationDistribution": null + }, "schema": { "type": "array", "example": null, @@ -14515,7 +15074,8 @@ } } } - } + }, + "description": "OK" } }, "security": [ @@ -16446,7 +17006,7 @@ "tags": [ "Synthetic Settings" ], - "description": "This API endpoint creates a credential to be used on Synthetic API Script Tests.\n\n## Mandatory Parameters:\n\n- **credentialName** The name identifying the credential. Credential names must start with a letter and can only contain letters, numbers and underscores. Max length is 64.\n\n- **credentialValue:** Value of the credential to be used on the API Script execution. Credential values are stored encrypted and cannot be queried after creation.\n\n\n## Sample script and payload:\n- A sample script to create a new credential\n\n```\ncurl -k -v -X POST \\\nhttps:///api/synthetics/settings/credentials \\\n-H 'authorization: apiToken ' \\\n-H 'content-type: application/json' \\\n-d '{\n \"credentialName\" : \"user1_password\", \n \"credentialValue\" : \"123456\"\n }'\n```\n" + "description": "This API endpoint creates a credential to be used on Synthetic API Script Tests.\n\n## Mandatory Parameters:\n\n- **credentialName** The name identifying the credential. Credential names must start with a letter and can only contain letters, numbers and underscores. Maximum length is 64.\n\n- **credentialValue:** Value of the credential to be used on the API Script execution. Credential values are stored encrypted and cannot be queried after creation.\n\n\n## Sample script and payload:\n- A sample script to create a new credential\n\n```\ncurl -k -v -X POST \\\nhttps:///api/synthetics/settings/credentials \\\n-H 'authorization: apiToken ' \\\n-H 'content-type: application/json' \\\n-d '{\n \"credentialName\" : \"user1_password\", \n \"credentialValue\" : \"123456\"\n }'\n```\n" } }, "/api/synthetics/settings/credentials/{name}": { @@ -16936,7 +17496,7 @@ "tags": [ "Synthetic Settings" ], - "description": "This API endpoint creates a Synthetic Test.\n\n**Note:** The **DNSAction** Synthetic type is not supported.\n\n## Sample script and payload: \n- A sample script to create an API Simple test\n\n```\ncurl -k -v -X POST \\\nhttps:///api/synthetics/settings/tests \\\n-H 'authorization: apiToken ' \\\n-H 'content-type: application/json' \\\n-d '{\n \"label\":\"Test_SimplePing\",\n \"description\":\"this is to test a simple ping API\",\n \"serviceId\":\"serviceId001\",\n \"applicationId\":\"applicationId001\",\n \"active\":true,\n \"testFrequency\":1,\n \"playbackMode\":\"Simultaneous\",\n \"locations\":[\n \"saas_instana_test\"\n ],\n \"configuration\":{\n \"syntheticType\":\"HTTPAction\",\n \"url\":\"https://httpbin.org/post\",\n \"operation\":\"POST\",\n \"headers\":{\n \"Content-Type\":\"text/plain\"\n },\n \"body\":\"Hello World!\",\n \"validationString\":\"Hello World!\"\n },\n \"customProperties\":{\n \"Team\":\"DevTeam\",\n \"Purpose\":\"Demo\"\n }\n }'\n```" + "description": "This API endpoint creates a Synthetic Test.\n\n**Note:** The **DNSAction** Synthetic type is not supported.\n\n## Optional Parameters:\n\n- **id** Users are allowed to specify their own id for the test. A test id can contain letters, numbers, underscores, colons and hyphens. Maximum length is 128.\n\n## Sample script and payload: \n- A sample script to create an API Simple test\n\n```\ncurl -k -v -X POST \\\nhttps:///api/synthetics/settings/tests \\\n-H 'authorization: apiToken ' \\\n-H 'content-type: application/json' \\\n-d '{\n \"id\":\"test_id:12134-89\",\n \"label\":\"Test_SimplePing\",\n \"description\":\"this is to test a simple ping API\",\n \"serviceId\":\"serviceId001\",\n \"applicationId\":\"applicationId001\",\n \"active\":true,\n \"testFrequency\":1,\n \"playbackMode\":\"Simultaneous\",\n \"locations\":[\n \"saas_instana_test\"\n ],\n \"configuration\":{\n \"syntheticType\":\"HTTPAction\",\n \"url\":\"https://httpbin.org/post\",\n \"operation\":\"POST\",\n \"headers\":{\n \"Content-Type\":\"text/plain\"\n },\n \"body\":\"Hello World!\",\n \"validationString\":\"Hello World!\"\n },\n \"customProperties\":{\n \"Team\":\"DevTeam\",\n \"Purpose\":\"Demo\"\n }\n }'\n```" } }, "/api/synthetics/settings/tests/{id}": { @@ -19374,6 +19934,10 @@ "type": "boolean", "example": null }, + "canManuallyCloseIssue": { + "type": "boolean", + "example": null + }, "canRunAutomationActions": { "type": "boolean", "example": null @@ -20354,6 +20918,38 @@ } } }, + "AvailabilityBlueprintIndicator": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ServiceLevelIndicator" + }, + { + "type": "object", + "example": null, + "properties": { + "badEventsFilter": { + "$ref": "#/components/schemas/TagFilterExpressionElement" + }, + "goodEventsFilter": { + "$ref": "#/components/schemas/TagFilterExpressionElement" + }, + "threshold": { + "type": "number", + "format": "double", + "example": null, + "exclusiveMinimum": false, + "minimum": 0 + } + } + } + ], + "example": null, + "required": [ + "blueprint", + "type" + ] + }, "AvailabilitySliEntity": { "type": "object", "allOf": [ @@ -20918,6 +21514,31 @@ } } }, + "CustomBlueprintIndicator": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ServiceLevelIndicator" + }, + { + "type": "object", + "example": null, + "properties": { + "badEventsFilter": { + "$ref": "#/components/schemas/TagFilterExpressionElement" + }, + "goodEventsFilter": { + "$ref": "#/components/schemas/TagFilterExpressionElement" + } + } + } + ], + "example": null, + "required": [ + "goodEventsFilter", + "type" + ] + }, "CustomDashboard": { "type": "object", "example": null, @@ -20993,30 +21614,6 @@ "title" ] }, - "CustomEventBasedSli": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/ServiceLevelIndicator" - }, - { - "type": "object", - "example": null, - "properties": { - "badEventsFilter": { - "$ref": "#/components/schemas/TagFilterExpressionElement" - }, - "goodEventsFilter": { - "$ref": "#/components/schemas/TagFilterExpressionElement" - } - } - } - ], - "example": null, - "required": [ - "goodEventsFilter" - ] - }, "CustomEventMobileAppAlertRule": { "type": "object", "allOf": [ @@ -21629,6 +22226,46 @@ "type" ] }, + "EndpointConfig": { + "type": "object", + "example": null, + "properties": { + "endpointCase": { + "type": "string", + "enum": [ + "ORIGINAL", + "LOWER", + "UPPER" + ], + "example": null + }, + "endpointNameByCollectedPathTemplateRuleEnabled": { + "type": "boolean", + "example": null + }, + "endpointNameByFirstPathSegmentRuleEnabled": { + "type": "boolean", + "example": null + }, + "rules": { + "type": "array", + "example": null, + "items": { + "$ref": "#/components/schemas/HttpEndpointRule" + }, + "maxItems": 500, + "minItems": 1 + }, + "serviceId": { + "type": "string", + "example": null + } + }, + "required": [ + "endpointCase", + "serviceId" + ] + }, "EndpointEventResult": { "type": "object", "allOf": [ @@ -22133,32 +22770,6 @@ "type" ] }, - "EventBasedSli": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/ServiceLevelIndicator" - }, - { - "type": "object", - "example": null, - "properties": { - "blueprint": { - "type": "string", - "enum": [ - "latency", - "availability" - ], - "example": null - } - } - } - ], - "example": null, - "required": [ - "blueprint" - ] - }, "EventFilteringConfiguration": { "type": "object", "example": null, @@ -23163,6 +23774,16 @@ "tagFilterExpression": { "$ref": "#/components/schemas/TagFilterExpressionElement" }, + "tags": { + "type": "array", + "example": null, + "items": { + "type": "string", + "example": null + }, + "maxItems": 5, + "minItems": 0 + }, "timeFrame": { "$ref": "#/components/schemas/TimeFrame" }, @@ -25215,6 +25836,9 @@ "description": "group of infrastructure entities", "example": null, "properties": { + "adjustedTimeframe": { + "$ref": "#/components/schemas/AdjustedTimeframe" + }, "count": { "type": "integer", "format": "int64", @@ -25290,6 +25914,9 @@ "type": "object", "example": null, "properties": { + "adjustedTimeframe": { + "$ref": "#/components/schemas/AdjustedTimeframe" + }, "entityHealthInfo": { "$ref": "#/components/schemas/EntityHealthInfo" }, @@ -25321,6 +25948,14 @@ "type": "string", "example": null }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string", + "example": null + }, + "example": null + }, "time": { "type": "integer", "format": "int64", @@ -25522,6 +26157,37 @@ } } }, + "LatencyBlueprintIndicator": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/ServiceLevelIndicator" + }, + { + "type": "object", + "example": null, + "properties": { + "badEventsFilter": { + "$ref": "#/components/schemas/TagFilterExpressionElement" + }, + "goodEventsFilter": { + "$ref": "#/components/schemas/TagFilterExpressionElement" + }, + "threshold": { + "type": "number", + "format": "double", + "example": null, + "exclusiveMinimum": false, + "minimum": 0 + } + } + } + ], + "example": null, + "required": [ + "type" + ] + }, "LocationStatus": { "type": "object", "example": null, @@ -28464,29 +29130,60 @@ "type": "object", "discriminator": { "mapping": { - "customEventBased": "#/components/schemas/CustomEventBasedSli", - "eventBased": "#/components/schemas/EventBasedSli", - "timeBased": "#/components/schemas/TimeBasedSli" + "availability": "#/components/schemas/AvailabilityBlueprintIndicator", + "custom": "#/components/schemas/CustomBlueprintIndicator", + "latency": "#/components/schemas/LatencyBlueprintIndicator" }, - "propertyName": "type" + "propertyName": "blueprint" }, "example": null, "properties": { + "aggregation": { + "type": "string", + "enum": [ + "SUM", + "MEAN", + "MAX", + "MIN", + "P25", + "P50", + "P75", + "P90", + "P95", + "P98", + "P99", + "P99_9", + "P99_99", + "DISTRIBUTION", + "DISTINCT_COUNT", + "SUM_POSITIVE", + "PER_SECOND" + ], + "example": null + }, + "blueprint": { + "type": "string", + "enum": [ + "latency", + "availability", + "custom" + ], + "example": null + }, "threshold": { "type": "number", "format": "double", - "example": null, - "exclusiveMinimum": false, - "minimum": 0 + "example": null }, "type": { "type": "string", + "enum": [ + "eventBased", + "timeBased" + ], "example": null } - }, - "required": [ - "type" - ] + } }, "ServiceLevelObjectiveConfiguration": { "type": "object", @@ -29538,6 +30235,78 @@ "stackTrace" ] }, + "SpanExcerpt": { + "type": "object", + "example": null, + "properties": { + "data": { + "type": "object", + "additionalProperties": { + "type": "object", + "example": null + }, + "example": null + }, + "duration": { + "type": "integer", + "format": "int64", + "example": null, + "minimum": 0 + }, + "errorCount": { + "type": "integer", + "format": "int32", + "example": null, + "minimum": 0 + }, + "foreignParentId": { + "type": "string", + "example": null + }, + "id": { + "type": "string", + "example": null + }, + "kind": { + "type": "string", + "enum": [ + "UNKNOWN", + "ENTRY", + "EXIT", + "INTERMEDIATE" + ], + "example": null + }, + "name": { + "type": "string", + "example": null + }, + "parentId": { + "type": "string", + "example": null + }, + "stackTrace": { + "type": "array", + "example": null, + "items": { + "$ref": "#/components/schemas/StackTraceItem" + } + }, + "start": { + "type": "integer", + "format": "int64", + "example": null, + "minimum": 1 + } + }, + "required": [ + "data", + "id", + "kind", + "name", + "stackTrace" + ] + }, "SpanRelation": { "type": "object", "example": null, @@ -31606,56 +32375,6 @@ "metricName" ] }, - "TimeBasedSli": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/ServiceLevelIndicator" - }, - { - "type": "object", - "example": null, - "properties": { - "aggregation": { - "type": "string", - "enum": [ - "SUM", - "MEAN", - "MAX", - "MIN", - "P25", - "P50", - "P75", - "P90", - "P95", - "P98", - "P99", - "P99_9", - "P99_99", - "DISTRIBUTION", - "DISTINCT_COUNT", - "SUM_POSITIVE", - "PER_SECOND" - ], - "example": null - }, - "blueprint": { - "type": "string", - "enum": [ - "latency", - "availability" - ], - "example": null - } - } - } - ], - "example": null, - "required": [ - "aggregation", - "blueprint" - ] - }, "TimeFrame": { "type": "object", "example": null, @@ -31776,6 +32495,100 @@ "label" ] }, + "TraceActivityTreeNodeDetails": { + "type": "object", + "example": null, + "properties": { + "batchSelfTime": { + "type": "integer", + "format": "int64", + "example": null + }, + "batchSize": { + "type": "integer", + "format": "int32", + "example": null, + "minimum": 0 + }, + "destination": { + "$ref": "#/components/schemas/SpanRelation" + }, + "duration": { + "type": "integer", + "format": "int64", + "example": null, + "minimum": 0 + }, + "errorCount": { + "type": "integer", + "format": "int32", + "example": null, + "minimum": 0 + }, + "id": { + "type": "string", + "example": null + }, + "isSynthetic": { + "type": "boolean", + "example": null, + "writeOnly": true + }, + "label": { + "type": "string", + "example": null, + "maxLength": 128, + "minLength": 0 + }, + "logs": { + "type": "array", + "example": null, + "items": { + "$ref": "#/components/schemas/SpanExcerpt" + }, + "uniqueItems": true + }, + "minSelfTime": { + "type": "integer", + "format": "int64", + "example": null + }, + "networkTime": { + "type": "integer", + "format": "int64", + "example": null + }, + "source": { + "$ref": "#/components/schemas/SpanRelation" + }, + "spans": { + "type": "array", + "example": null, + "items": { + "$ref": "#/components/schemas/SpanExcerpt" + }, + "maxItems": 2, + "minItems": 1, + "uniqueItems": true + }, + "start": { + "type": "integer", + "format": "int64", + "example": null, + "minimum": 1 + }, + "synthetic": { + "type": "boolean", + "example": null + } + }, + "required": [ + "id", + "label", + "logs", + "spans" + ] + }, "TraceDownloadResult": { "type": "object", "example": null, diff --git a/openapi.yaml b/openapi.yaml index 95ca511..87fc5cc 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -6,7 +6,7 @@ info: url: 'http://instana.com' termsOfService: 'https://www.instana.com/terms-of-use/' title: Introduction to Instana public APIs - version: 1.267.840 + version: 1.268.807 x-logo: altText: instana logo backgroundColor: '#FAFBFC' @@ -1828,8 +1828,173 @@ paths: ## Deprecated Parameters **matchSpecification:** A binary tree sturcture of match expression connected with binary operator AND or OR. It is replaced by **tagFilterExpression** which is also used in Application Analyze API endpoints. + /api/application-monitoring/settings/endpoint: + get: + operationId: getEndpointConfigs + responses: + default: + content: + application/json: + example: + - serviceId: d0cedae516f2182ede16f57f67476dd4c7dab9cd + endpointCase: LOWER + endpointNameByFirstPathSegmentRuleEnabled: false + endpointNameByCollectedPathTemplateRuleEnabled: false + rules: null + - serviceId: d0cedae516f2182ede16f57f67476dd4c7dab9cd + endpointCase: UPPER + endpointNameByFirstPathSegmentRuleEnabled: false + endpointNameByCollectedPathTemplateRuleEnabled: false + rules: null + schema: + type: array + example: null + items: + $ref: '#/components/schemas/EndpointConfig' + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: All Endpoint configurations + tags: + - Application Settings + post: + operationId: createEndpointConfig + requestBody: + content: + application/json: + example: + serviceId: d0cedae516f2182ede16f57f67476dd4c7dab9cd + endpointCase: LOWER + endpointNameByFirstPathSegmentRuleEnabled: false + endpointNameByCollectedPathTemplateRuleEnabled: false + rules: null + schema: + $ref: '#/components/schemas/EndpointConfig' + required: true + responses: + default: + content: + application/json: + example: + serviceId: d0cedae516f2182ede16f57f67476dd4c7dab9cd + endpointCase: LOWER + endpointNameByFirstPathSegmentRuleEnabled: false + endpointNameByCollectedPathTemplateRuleEnabled: false + rules: null + schema: + $ref: '#/components/schemas/EndpointConfig' + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Create endpoint configuration + tags: + - Application Settings + '/api/application-monitoring/settings/endpoint/{id}': + delete: + operationId: deleteEndpointConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + example: null + responses: + default: + content: + application/json: {} + description: default response + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Delete endpoint configuration + tags: + - Application Settings + get: + operationId: getEndpointConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + example: null + responses: + default: + content: + application/json: + example: + serviceId: d0cedae516f2182ede16f57f67476dd4c7dab9cd + endpointCase: LOWER + endpointNameByFirstPathSegmentRuleEnabled: false + endpointNameByCollectedPathTemplateRuleEnabled: false + rules: null + schema: + $ref: '#/components/schemas/EndpointConfig' + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Endpoint configuration + tags: + - Application Settings + put: + operationId: updateEndpointConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + example: null + requestBody: + content: + application/json: + example: + serviceId: 20ba31821b079e7d845a08096124880db3eeeb40 + endpointNameByCollectedPathTemplateRuleEnabled: true + endpointNameByFirstPathSegmentRuleEnabled: true + rules: + - enabled: true + pathSegments: + - name: api + type: FIXED + - name: version + type: PARAMETER + testCases: + - /api/v2/users + endpointCase: UPPER + schema: + $ref: '#/components/schemas/EndpointConfig' + required: true + responses: + default: + content: + application/json: + example: + serviceId: 20ba31821b079e7d845a08096124880db3eeeb40 + endpointNameByCollectedPathTemplateRuleEnabled: true + endpointNameByFirstPathSegmentRuleEnabled: true + rules: + - enabled: true + pathSegments: + - name: api + type: FIXED + - name: version + type: PARAMETER + testCases: + - /api/v2/users + endpointCase: UPPER + schema: + $ref: '#/components/schemas/EndpointConfig' + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Update endpoint configuration + tags: + - Application Settings /api/application-monitoring/settings/http-endpoint: get: + deprecated: true operationId: getHttpEndpointConfigs responses: default: @@ -1857,10 +2022,11 @@ paths: security: - ApiKeyAuth: - ConfigureServiceMapping - summary: All Endpoint configurations + summary: All HTTP endpoint configurations tags: - Application Settings post: + deprecated: true operationId: createHttpEndpointConfig requestBody: content: @@ -1897,11 +2063,12 @@ paths: security: - ApiKeyAuth: - ConfigureServiceMapping - summary: Create endpoint configuration + summary: Create HTTP endpoint configuration tags: - Application Settings '/api/application-monitoring/settings/http-endpoint/{id}': delete: + deprecated: true operationId: deleteHttpEndpointConfig parameters: - in: path @@ -1918,10 +2085,11 @@ paths: security: - ApiKeyAuth: - ConfigureServiceMapping - summary: Delete endpoint configuration + summary: Delete HTTP endpoint configuration tags: - Application Settings get: + deprecated: true operationId: getHttpEndpointConfig parameters: - in: path @@ -1953,10 +2121,11 @@ paths: security: - ApiKeyAuth: - ConfigureServiceMapping - summary: Endpoint configuration + summary: HTTP Endpoint configuration tags: - Application Settings put: + deprecated: true operationId: updateHttpEndpointConfig parameters: - in: path @@ -2008,7 +2177,7 @@ paths: security: - ApiKeyAuth: - ConfigureServiceMapping - summary: Update endpoint configuration + summary: Update HTTP endpoint configuration tags: - Application Settings /api/application-monitoring/settings/manual-service: @@ -2679,6 +2848,92 @@ paths: summary: Get trace detail tags: - Application Analyze + '/api/application-monitoring/v2/analyze/traces/{traceId}/calls/{callId}/details': + get: + operationId: getCallDetails + parameters: + - in: path + name: traceId + required: true + schema: + type: string + example: null + - in: path + name: callId + required: true + schema: + type: string + example: null + responses: + default: + content: + application/json: + example: + id: 14219b3deb6a6bc5 + label: GET /api/shipping/cities/bg + start: 1707295859759 + duration: 3597 + minSelfTime: 2 + networkTime: null + errorCount: 0 + batchSize: 1 + batchSelfTime: 3597 + source: + applications: [] + service: + id: ROOT + label: '' + endpoint: + id: XCjGvnwuiak0m3ISke3naE-NrGA + label: Unspecified + type: UNDEFINED + physicalContext: {} + destination: + applications: [] + service: + id: ce4b152bac7b99744d8314838e49b799afd6dd96 + label: nginx-web + endpoint: + id: wAS2omB44e0EK4xqL7f-e-wt4C4 + label: upstream shipping + type: HTTP + physicalContext: + process: + id: jXvrnXHuBqfhlZQTux-ck1PYd6Y + time: 1707258023000 + label: Node @30303 + plugin: nginx + data: null + spans: + - id: 14219b3deb6a6bc5 + parentId: '' + name: sdk.http.entry + kind: ENTRY + foreignParentId: '' + start: 1707295859759 + duration: 3597 + errorCount: 0 + stackTrace: [] + data: + service: nginx-web + http: + path: /api/shipping/cities/bg + protocol: http + route_id: upstream shipping + method: GET + host: 'web:8080' + url: 'http://web:8080//api/shipping/cities/bg' + status: 200 + logs: [] + synthetic: false + schema: + $ref: '#/components/schemas/TraceActivityTreeNodeDetails' + security: + - ApiKeyAuth: + - Default + summary: Get call detail + tags: + - Application Analyze /api/application-monitoring/v2/metrics: post: operationId: getApplicationDataMetricsV2 @@ -3402,12 +3657,18 @@ paths: description: Configs are sorted descending by their created date. operationId: findActiveApplicationAlertConfigs parameters: - - in: query + - description: Application Id + example: IYS1XOEcTNiT1eOD8pxgXg + in: query name: applicationId schema: type: string example: null - - in: query + - description: Alert Ids + example: + - 5GJXiK9aciVaBPnu + - lXQ3rSSWVAl0VhBM + in: query name: alertIds schema: type: array @@ -3419,14 +3680,55 @@ paths: minItems: 0 uniqueItems: true responses: - default: + '200': content: application/json: + example: + - name: Erroneous call rate is higher than normal + description: The erroneous call rate is higher or equal to 4%. + boundaryScope: ALL + applicationId: IYS1XOEcTNiT1eOD8pxgXg + applications: + IYS1XOEcTNiT1eOD8pxgXg: + applicationId: IYS1XOEcTNiT1eOD8pxgXg + inclusive: true + services: {} + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [] + includeInternal: false + includeSynthetic: false + rule: + alertType: errors + metricName: errors + aggregation: MEAN + threshold: + type: staticThreshold + operator: '>=' + value: 0.04 + lastUpdated: 0 + alertChannelIds: [] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + evaluationType: PER_AP + customPayloadFields: [] + id: A5VvSXR_SVG6z7YbnIHiHQ + created: 1707751873882 + initialCreated: 1707751873882 + readOnly: false + enabled: true + derivedFromGlobalAlert: false schema: type: array example: null items: $ref: '#/components/schemas/ApplicationAlertConfigWithMetadata' + description: OK security: - ApiKeyAuth: - Default @@ -3480,24 +3782,83 @@ paths: description: Find a Application Alert Config by ID. This will deliver deleted configs too. operationId: findApplicationAlertConfig parameters: - - in: path + - description: Application Alert Config ID + example: DKp0JArJRAiQIav9CoKSWQ + in: path name: id required: true schema: type: string example: null - - in: query + - description: Timestamp for each Id + example: 1706617456952 + in: query name: validOn schema: type: integer format: int64 example: null responses: - default: + '200': content: application/json: + example: + name: Calls are slower than usual + description: Calls are slower or equal to the expectation based on latency (90th). + boundaryScope: INBOUND + applicationId: ZOi0te_ERE-mRm-9zsbwdg + applications: + ZOi0te_ERE-mRm-9zsbwdg: + applicationId: ZOi0te_ERE-mRm-9zsbwdg + inclusive: true + services: {} + severity: 5 + triggering: false + tagFilterExpression: + type: TAG_FILTER + name: endpoint.name + stringValue: null + numberValue: null + booleanValue: null + key: null + value: null + operator: NOT_EMPTY + entity: DESTINATION + includeInternal: false + includeSynthetic: false + rule: + alertType: slowness + aggregation: P90 + metricName: latency + threshold: + type: historicBaseline + operator: '>=' + seasonality: DAILY + baseline: + - - 0 + - 1 + - 3 + - - 600000 + - 1 + - 3 + deviationFactor: 3 + lastUpdated: 0 + alertChannelIds: [] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + evaluationType: PER_AP + customPayloadFields: [] + id: DKp0JArJRAiQIav9CoKSWQ + created: 1706617456952 + initialCreated: 1706617456952 + readOnly: false + enabled: true + derivedFromGlobalAlert: false schema: $ref: '#/components/schemas/ApplicationAlertConfigWithMetadata' + description: OK security: - ApiKeyAuth: - Default @@ -3655,7 +4016,9 @@ paths: description: Find all versions of a Application Alert Config by ID. This will deliver deleted configs too. Configs are sorted descending by their created date. operationId: findApplicationAlertConfigVersions parameters: - - in: path + - description: Applicaiton Id + example: DKp0JArJRAiQIav9CoKSWQ + in: path name: id required: true schema: @@ -3665,6 +4028,17 @@ paths: default: content: application/json: + example: + - id: DKp0JArJRAiQIav9CoKSWQ + created: 1706617456952 + enabled: true + deleted: false + changeSummary: + changeType: CREATE + author: + id: 5ee8a3e8cd70020001ecb007 + type: USER + fullName: Stan schema: type: array example: null @@ -3705,6 +4079,7 @@ paths: - SYNTHETIC - MOBILE_APP - INFRA + - LOG example: null responses: default: @@ -10265,39 +10640,59 @@ paths: get: operationId: getSli parameters: - - in: path + - description: sliId + example: nCtEoR6NSPqG61QkIkwwCw + in: path name: sliId required: true schema: type: string example: null - - in: query + - description: slo target + example: 0.99 + in: query name: slo + required: true schema: type: number format: double example: null - - in: query + - description: Timestamp milliseconds (13-digit) + example: 1706713140000 + in: query name: from + required: true schema: type: integer format: int64 example: null - - in: query + - description: Timestamp milliseconds (13-digit) + example: 1706713140000 + in: query name: to + required: true schema: type: integer format: int64 example: null responses: - default: + '200': content: application/json: + example: + sli: 0.008228916434859497 + slo: 0.1 + totalErrorBudget: 10236633 + errorBudgetRemaining: -1043808 + fromTimestamp: 1707771600000 + toTimestamp: 1707858000000 + violationDistribution: null schema: type: array example: null items: $ref: '#/components/schemas/SliReport' + description: OK security: - ApiKeyAuth: - canConfigureServiceLevelIndicators @@ -11811,7 +12206,7 @@ paths: ## Mandatory Parameters: - - **credentialName** The name identifying the credential. Credential names must start with a letter and can only contain letters, numbers and underscores. Max length is 64. + - **credentialName** The name identifying the credential. Credential names must start with a letter and can only contain letters, numbers and underscores. Maximum length is 64. - **credentialValue:** Value of the credential to be used on the API Script execution. Credential values are stored encrypted and cannot be queried after creation. @@ -12213,6 +12608,10 @@ paths: **Note:** The **DNSAction** Synthetic type is not supported. + ## Optional Parameters: + + - **id** Users are allowed to specify their own id for the test. A test id can contain letters, numbers, underscores, colons and hyphens. Maximum length is 128. + ## Sample script and payload: - A sample script to create an API Simple test @@ -12222,6 +12621,7 @@ paths: -H 'authorization: apiToken ' \ -H 'content-type: application/json' \ -d '{ + "id":"test_id:12134-89", "label":"Test_SimplePing", "description":"this is to test a simple ping API", "serviceId":"serviceId001", @@ -14010,6 +14410,9 @@ components: canInstallNewAgents: type: boolean example: null + canManuallyCloseIssue: + type: boolean + example: null canRunAutomationActions: type: boolean example: null @@ -14750,6 +15153,27 @@ components: - INSTANA - UNKNOWN example: null + AvailabilityBlueprintIndicator: + type: object + allOf: + - $ref: '#/components/schemas/ServiceLevelIndicator' + - type: object + example: null + properties: + badEventsFilter: + $ref: '#/components/schemas/TagFilterExpressionElement' + goodEventsFilter: + $ref: '#/components/schemas/TagFilterExpressionElement' + threshold: + type: number + format: double + example: null + exclusiveMinimum: false + minimum: 0 + example: null + required: + - blueprint + - type AvailabilitySliEntity: type: object allOf: @@ -15167,6 +15591,21 @@ components: format: int32 description: number of values to return example: null + CustomBlueprintIndicator: + type: object + allOf: + - $ref: '#/components/schemas/ServiceLevelIndicator' + - type: object + example: null + properties: + badEventsFilter: + $ref: '#/components/schemas/TagFilterExpressionElement' + goodEventsFilter: + $ref: '#/components/schemas/TagFilterExpressionElement' + example: null + required: + - goodEventsFilter + - type CustomDashboard: type: object example: null @@ -15225,20 +15664,6 @@ components: - annotations - id - title - CustomEventBasedSli: - type: object - allOf: - - $ref: '#/components/schemas/ServiceLevelIndicator' - - type: object - example: null - properties: - badEventsFilter: - $ref: '#/components/schemas/TagFilterExpressionElement' - goodEventsFilter: - $ref: '#/components/schemas/TagFilterExpressionElement' - example: null - required: - - goodEventsFilter CustomEventMobileAppAlertRule: type: object allOf: @@ -15697,6 +16122,36 @@ components: - serviceId - technologies - type + EndpointConfig: + type: object + example: null + properties: + endpointCase: + type: string + enum: + - ORIGINAL + - LOWER + - UPPER + example: null + endpointNameByCollectedPathTemplateRuleEnabled: + type: boolean + example: null + endpointNameByFirstPathSegmentRuleEnabled: + type: boolean + example: null + rules: + type: array + example: null + items: + $ref: '#/components/schemas/HttpEndpointRule' + maxItems: 500 + minItems: 1 + serviceId: + type: string + example: null + required: + - endpointCase + - serviceId EndpointEventResult: type: object allOf: @@ -16074,22 +16529,6 @@ components: - plugin - state - type - EventBasedSli: - type: object - allOf: - - $ref: '#/components/schemas/ServiceLevelIndicator' - - type: object - example: null - properties: - blueprint: - type: string - enum: - - latency - - availability - example: null - example: null - required: - - blueprint EventFilteringConfiguration: type: object example: null @@ -16854,6 +17293,14 @@ components: $ref: '#/components/schemas/CursorPaginationInfraExploreCursor' tagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' + tags: + type: array + example: null + items: + type: string + example: null + maxItems: 5 + minItems: 0 timeFrame: $ref: '#/components/schemas/TimeFrame' type: @@ -18417,6 +18864,8 @@ components: description: group of infrastructure entities example: null properties: + adjustedTimeframe: + $ref: '#/components/schemas/AdjustedTimeframe' count: type: integer format: int64 @@ -18474,6 +18923,8 @@ components: type: object example: null properties: + adjustedTimeframe: + $ref: '#/components/schemas/AdjustedTimeframe' entityHealthInfo: $ref: '#/components/schemas/EntityHealthInfo' label: @@ -18497,6 +18948,12 @@ components: snapshotId: type: string example: null + tags: + type: object + additionalProperties: + type: string + example: null + example: null time: type: integer format: int64 @@ -18643,6 +19100,26 @@ components: $ref: '#/components/schemas/SnapshotPreview' pod: $ref: '#/components/schemas/SnapshotPreview' + LatencyBlueprintIndicator: + type: object + allOf: + - $ref: '#/components/schemas/ServiceLevelIndicator' + - type: object + example: null + properties: + badEventsFilter: + $ref: '#/components/schemas/TagFilterExpressionElement' + goodEventsFilter: + $ref: '#/components/schemas/TagFilterExpressionElement' + threshold: + type: number + format: double + example: null + exclusiveMinimum: false + minimum: 0 + example: null + required: + - type LocationStatus: type: object example: null @@ -20920,23 +21397,50 @@ components: type: object discriminator: mapping: - customEventBased: '#/components/schemas/CustomEventBasedSli' - eventBased: '#/components/schemas/EventBasedSli' - timeBased: '#/components/schemas/TimeBasedSli' - propertyName: type + availability: '#/components/schemas/AvailabilityBlueprintIndicator' + custom: '#/components/schemas/CustomBlueprintIndicator' + latency: '#/components/schemas/LatencyBlueprintIndicator' + propertyName: blueprint example: null properties: + aggregation: + type: string + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTRIBUTION + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + example: null + blueprint: + type: string + enum: + - latency + - availability + - custom + example: null threshold: type: number format: double example: null - exclusiveMinimum: false - minimum: 0 type: type: string + enum: + - eventBased + - timeBased example: null - required: - - type ServiceLevelObjectiveConfiguration: type: object example: null @@ -21723,6 +22227,62 @@ components: - label - name - stackTrace + SpanExcerpt: + type: object + example: null + properties: + data: + type: object + additionalProperties: + type: object + example: null + example: null + duration: + type: integer + format: int64 + example: null + minimum: 0 + errorCount: + type: integer + format: int32 + example: null + minimum: 0 + foreignParentId: + type: string + example: null + id: + type: string + example: null + kind: + type: string + enum: + - UNKNOWN + - ENTRY + - EXIT + - INTERMEDIATE + example: null + name: + type: string + example: null + parentId: + type: string + example: null + stackTrace: + type: array + example: null + items: + $ref: '#/components/schemas/StackTraceItem' + start: + type: integer + format: int64 + example: null + minimum: 1 + required: + - data + - id + - kind + - name + - stackTrace SpanRelation: type: object example: null @@ -23270,44 +23830,6 @@ components: example: null required: - metricName - TimeBasedSli: - type: object - allOf: - - $ref: '#/components/schemas/ServiceLevelIndicator' - - type: object - example: null - properties: - aggregation: - type: string - enum: - - SUM - - MEAN - - MAX - - MIN - - P25 - - P50 - - P75 - - P90 - - P95 - - P98 - - P99 - - P99_9 - - P99_99 - - DISTRIBUTION - - DISTINCT_COUNT - - SUM_POSITIVE - - PER_SECOND - example: null - blueprint: - type: string - enum: - - latency - - availability - example: null - example: null - required: - - aggregation - - blueprint TimeFrame: type: object example: null @@ -23399,6 +23921,80 @@ components: required: - id - label + TraceActivityTreeNodeDetails: + type: object + example: null + properties: + batchSelfTime: + type: integer + format: int64 + example: null + batchSize: + type: integer + format: int32 + example: null + minimum: 0 + destination: + $ref: '#/components/schemas/SpanRelation' + duration: + type: integer + format: int64 + example: null + minimum: 0 + errorCount: + type: integer + format: int32 + example: null + minimum: 0 + id: + type: string + example: null + isSynthetic: + type: boolean + example: null + writeOnly: true + label: + type: string + example: null + maxLength: 128 + minLength: 0 + logs: + type: array + example: null + items: + $ref: '#/components/schemas/SpanExcerpt' + uniqueItems: true + minSelfTime: + type: integer + format: int64 + example: null + networkTime: + type: integer + format: int64 + example: null + source: + $ref: '#/components/schemas/SpanRelation' + spans: + type: array + example: null + items: + $ref: '#/components/schemas/SpanExcerpt' + maxItems: 2 + minItems: 1 + uniqueItems: true + start: + type: integer + format: int64 + example: null + minimum: 1 + synthetic: + type: boolean + example: null + required: + - id + - label + - logs + - spans TraceDownloadResult: type: object example: null