diff --git a/openapi.json b/openapi.json index 23220ea..50b4673 100644 --- a/openapi.json +++ b/openapi.json @@ -8,7 +8,7 @@ }, "termsOfService": "https://www.instana.com/terms-of-use/", "title": "Instana REST API documentation", - "version": "1.284.871", + "version": "1.285.1341", "x-logo": { "altText": "instana logo", "backgroundColor": "#FAFBFC", @@ -521,7 +521,8 @@ "summary": "Get grouped trace metrics", "tags": [ "Application Analyze" - ] + ], + "description": "The API endpoint retrieves metrics for traces that are grouped in the endpoint or service name.\n\nThe supported `groupbyTag` are `trace.endpoint.name` and `trace.service.name`. \n{: note}\n" } }, "/api/application-monitoring/analyze/traces": { @@ -1183,6 +1184,7 @@ "enum": [ "GROUPING", "FILTERING", + "SERVICE_MAPPING", "SMART_ALERTS", "SMART_ALERTS_LOGS", "SMART_ALERTS_ADAPTIVE_BASELINE", @@ -1329,6 +1331,7 @@ "enum": [ "GROUPING", "FILTERING", + "SERVICE_MAPPING", "SMART_ALERTS", "SMART_ALERTS_LOGS", "SMART_ALERTS_ADAPTIVE_BASELINE", @@ -3615,6 +3618,40 @@ ] } }, + "/api/application-monitoring/settings/subtrace/{id}": { + "delete": { + "operationId": "deleteSubtraceConfig", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "content": { + "application/json": {} + }, + "description": "default response" + } + }, + "security": [ + { + "ApiKeyAuth": [ + "ConfigureServiceMapping" + ] + } + ], + "summary": "Delete subtrace configuration", + "tags": [ + "Application Settings" + ] + } + }, "/api/application-monitoring/topology/services": { "get": { "operationId": "getServicesMap", @@ -4123,11 +4160,6 @@ } }, "security": [ - { - "ApiKeyAuth": [ - "Default" - ] - }, { "ApiKeyAuth": [ "canDeleteAutomationActionHistory" @@ -4382,11 +4414,6 @@ } }, "security": [ - { - "ApiKeyAuth": [ - "Default" - ] - }, { "ApiKeyAuth": [ "canRunAutomationActions" @@ -4459,11 +4486,6 @@ } }, "security": [ - { - "ApiKeyAuth": [ - "Default" - ] - }, { "ApiKeyAuth": [ "canDeleteAutomationActionHistory" @@ -4880,11 +4902,6 @@ } }, "security": [ - { - "ApiKeyAuth": [ - "Default" - ] - }, { "ApiKeyAuth": [ "canRunAutomationActions" @@ -5203,11 +5220,6 @@ } }, "security": [ - { - "ApiKeyAuth": [ - "Default" - ] - }, { "ApiKeyAuth": [ "canConfigureAutomationPolicies" @@ -5259,11 +5271,6 @@ } }, "security": [ - { - "ApiKeyAuth": [ - "Default" - ] - }, { "ApiKeyAuth": [ "canConfigureAutomationPolicies" @@ -5304,11 +5311,6 @@ } }, "security": [ - { - "ApiKeyAuth": [ - "Default" - ] - }, { "ApiKeyAuth": [ "canConfigureAutomationPolicies" @@ -5553,11 +5555,6 @@ } }, "security": [ - { - "ApiKeyAuth": [ - "Default" - ] - }, { "ApiKeyAuth": [ "canConfigureAutomationPolicies" @@ -6119,6 +6116,7 @@ "enum": [ "GROUPING", "FILTERING", + "SERVICE_MAPPING", "SMART_ALERTS", "SMART_ALERTS_LOGS", "SMART_ALERTS_ADAPTIVE_BASELINE", @@ -13333,7 +13331,7 @@ "security": [ { "ApiKeyAuth": [ - "CanConfigureCustomAlerts" + "CanManuallyCloseIssue" ] } ], @@ -17318,6 +17316,7 @@ "enum": [ "GROUPING", "FILTERING", + "SERVICE_MAPPING", "SMART_ALERTS", "SMART_ALERTS_LOGS", "SMART_ALERTS_ADAPTIVE_BASELINE", @@ -23530,6 +23529,7 @@ "enum": [ "GROUPING", "FILTERING", + "SERVICE_MAPPING", "SMART_ALERTS", "SMART_ALERTS_LOGS", "SMART_ALERTS_ADAPTIVE_BASELINE", @@ -24806,11 +24806,11 @@ "required": true }, "responses": { - "default": { + "200": { "content": { "application/json": {} }, - "description": "default response" + "description": "OK" } }, "security": [ @@ -24924,10 +24924,43 @@ "tags": [ "Synthetic Settings" ] + } + }, + "/api/synthetics/settings/credentials/{name}": { + "delete": { + "operationId": "deleteSyntheticCredential", + "parameters": [ + { + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "content": { + "application/json": {} + }, + "description": "default response" + } + }, + "security": [ + { + "ApiKeyAuth": [ + "canConfigureSyntheticCredentials" + ] + } + ], + "summary": "Delete Synthetic credential", + "tags": [ + "Synthetic Settings" + ] }, "patch": { - "deprecated": true, - "operationId": "patchSyntheticCredentialAssociations", + "operationId": "patchSyntheticCredential", "parameters": [ { "in": "path", @@ -24941,7 +24974,12 @@ "requestBody": { "content": { "application/json": { - "example": " {\n \"applications\": [\n \"f4KX5zd8RW2pERKKFUCZgQ\"\n ],\n }\n", + "example": { + "credentialValue": "newPassword", + "applications": [ + "f4KX5zd8RW2pERKKFUCZgQ" + ] + }, "schema": { "$ref": "#/components/schemas/SyntheticCredential" } @@ -24950,11 +24988,11 @@ "required": true }, "responses": { - "default": { + "200": { "content": { "application/json": {} }, - "description": "default response" + "description": "OK" } }, "security": [ @@ -24965,16 +25003,13 @@ ] } ], - "summary": "Patch the associations of a Synthetic Credential (This API will be replaced by a new API in R285)", + "summary": "Patch a Synthetic Credential", "tags": [ "Synthetic Settings" - ], - "description": "This API updates the endpoint associations of a Synthetic Credential.\n\n- Credential values cannot be patched.\n- Credentials can be associated to multiple application ids.\n- Patching a credential association will replace the entire array with the full set of values provided.\n\n## Sample script and payload: \n- A sample script to patch a DB2 Admin password and associate it to application ids 'Ss2FBjSTQVef5LsqhPiYkg' and 'KJ8MdZVqK4odMUoBaClH'.\n\n```\ncurl -k -v -X PATCH \\\nhttps:///api/synthetics/settings/credentials/associations/db2AdminPwd \\\n-H 'authorization: apiToken ' \\\n-H 'content-type: application/json' \\\n-d '{\n \"applications\" : [ \"Ss2FBjSTQVef5LsqhPiYkg\", \"KJ8MdZVqK4odMUoBaClH\" ]\n }'\n```" - } - }, - "/api/synthetics/settings/credentials/{name}": { - "delete": { - "operationId": "deleteSyntheticCredential", + ] + }, + "put": { + "operationId": "updateSyntheticCredential", "parameters": [ { "in": "path", @@ -24985,12 +25020,29 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "example": { + "credentialName": "userPassword", + "credentialValue": "123456", + "applications": [ + "f4KX5zd8RW2pERKKFUCZgQ" + ] + }, + "schema": { + "$ref": "#/components/schemas/SyntheticCredential" + } + } + }, + "required": true + }, "responses": { - "default": { + "200": { "content": { "application/json": {} }, - "description": "default response" + "description": "OK" } }, "security": [ @@ -25000,7 +25052,7 @@ ] } ], - "summary": "Delete Synthetic credential", + "summary": "Update a Synthetic Credential", "tags": [ "Synthetic Settings" ] @@ -26070,6 +26122,7 @@ "enum": [ "GROUPING", "FILTERING", + "SERVICE_MAPPING", "SMART_ALERTS", "SMART_ALERTS_LOGS", "SMART_ALERTS_ADAPTIVE_BASELINE", @@ -41595,6 +41648,9 @@ } } } + ], + "required": [ + "trafficType" ] }, "Trigger": { diff --git a/openapi.yaml b/openapi.yaml index 46531ed..a3087c5 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: Instana REST API documentation - version: 1.284.871 + version: 1.285.1341 x-logo: altText: instana logo backgroundColor: '#FAFBFC' @@ -664,6 +664,11 @@ paths: summary: Get grouped trace metrics tags: - Application Analyze + description: | + The API endpoint retrieves metrics for traces that are grouped in the endpoint or service name. + + The supported `groupbyTag` are `trace.endpoint.name` and `trace.service.name`. + {: note} /api/application-monitoring/analyze/traces: post: operationId: getTraces @@ -1143,6 +1148,7 @@ paths: enum: - GROUPING - FILTERING + - SERVICE_MAPPING - SMART_ALERTS - SMART_ALERTS_LOGS - SMART_ALERTS_ADAPTIVE_BASELINE @@ -1243,6 +1249,7 @@ paths: enum: - GROUPING - FILTERING + - SERVICE_MAPPING - SMART_ALERTS - SMART_ALERTS_LOGS - SMART_ALERTS_ADAPTIVE_BASELINE @@ -2796,6 +2803,26 @@ paths: summary: Update service configuration tags: - Application Settings + '/api/application-monitoring/settings/subtrace/{id}': + delete: + operationId: deleteSubtraceConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Delete subtrace configuration + tags: + - Application Settings /api/application-monitoring/topology/services: get: operationId: getServicesMap @@ -3140,8 +3167,6 @@ paths: '500': description: The request do not contain a valid user or API Token. security: - - ApiKeyAuth: - - Default - ApiKeyAuth: - canDeleteAutomationActionHistory summary: Delete automation action run results. @@ -3319,8 +3344,6 @@ paths: '403': description: Automation feature is not enabled or Insufficient permissions. security: - - ApiKeyAuth: - - Default - ApiKeyAuth: - canRunAutomationActions summary: Run an automation action. @@ -3368,8 +3391,6 @@ paths: '500': description: The request do not contain a valid user or API Token. security: - - ApiKeyAuth: - - Default - ApiKeyAuth: - canDeleteAutomationActionHistory summary: Deletes an automation action run result from the action run history by ID. @@ -3648,8 +3669,6 @@ paths: '500': description: Internal server error security: - - ApiKeyAuth: - - Default - ApiKeyAuth: - canRunAutomationActions summary: Resolve dynamic parameter values @@ -3852,8 +3871,6 @@ paths: '403': description: Insufficient permissions. security: - - ApiKeyAuth: - - Default - ApiKeyAuth: - canConfigureAutomationPolicies summary: Create an automation policy. @@ -3885,8 +3902,6 @@ paths: '403': description: Insufficient permissions. security: - - ApiKeyAuth: - - Default - ApiKeyAuth: - canConfigureAutomationPolicies summary: Create automation policies. @@ -3912,8 +3927,6 @@ paths: '403': description: Insufficient permissions. security: - - ApiKeyAuth: - - Default - ApiKeyAuth: - canConfigureAutomationPolicies summary: Deletes an automation policy by identifier. @@ -4071,8 +4084,6 @@ paths: '403': description: Insufficient permissions. security: - - ApiKeyAuth: - - Default - ApiKeyAuth: - canConfigureAutomationPolicies summary: Updates an automation policy by identifier. @@ -4436,6 +4447,7 @@ paths: enum: - GROUPING - FILTERING + - SERVICE_MAPPING - SMART_ALERTS - SMART_ALERTS_LOGS - SMART_ALERTS_ADAPTIVE_BASELINE @@ -9398,7 +9410,7 @@ paths: description: The event id refers to an event that is not open. security: - ApiKeyAuth: - - CanConfigureCustomAlerts + - CanManuallyCloseIssue summary: Manually close an event. tags: - Event Settings @@ -12176,6 +12188,7 @@ paths: enum: - GROUPING - FILTERING + - SERVICE_MAPPING - SMART_ALERTS - SMART_ALERTS_LOGS - SMART_ALERTS_ADAPTIVE_BASELINE @@ -17158,6 +17171,7 @@ paths: enum: - GROUPING - FILTERING + - SERVICE_MAPPING - SMART_ALERTS - SMART_ALERTS_LOGS - SMART_ALERTS_ADAPTIVE_BASELINE @@ -17991,10 +18005,10 @@ paths: $ref: '#/components/schemas/SyntheticCredential' required: true responses: - default: + '200': content: application/json: {} - description: default response + description: OK security: - ApiKeyAuth: - canConfigureSyntheticCredentials @@ -18062,9 +18076,28 @@ paths: summary: A Synthetic Credential with Name and Associations tags: - Synthetic Settings + '/api/synthetics/settings/credentials/{name}': + delete: + operationId: deleteSyntheticCredential + parameters: + - in: path + name: name + required: true + schema: + type: string + responses: + default: + content: + application/json: {} + description: default response + security: + - ApiKeyAuth: + - canConfigureSyntheticCredentials + summary: Delete Synthetic credential + tags: + - Synthetic Settings patch: - deprecated: true - operationId: patchSyntheticCredentialAssociations + operationId: patchSyntheticCredential parameters: - in: path name: name @@ -18074,64 +18107,53 @@ paths: requestBody: content: application/json: - example: |2 - { - "applications": [ - "f4KX5zd8RW2pERKKFUCZgQ" - ], - } + example: + credentialValue: newPassword + applications: + - f4KX5zd8RW2pERKKFUCZgQ schema: $ref: '#/components/schemas/SyntheticCredential' required: true responses: - default: + '200': content: application/json: {} - description: default response + description: OK security: - ApiKeyAuth: - canUseSyntheticCredentials - canConfigureSyntheticTests - summary: Patch the associations of a Synthetic Credential (This API will be replaced by a new API in R285) + summary: Patch a Synthetic Credential tags: - Synthetic Settings - description: |- - This API updates the endpoint associations of a Synthetic Credential. - - - Credential values cannot be patched. - - Credentials can be associated to multiple application ids. - - Patching a credential association will replace the entire array with the full set of values provided. - - ## Sample script and payload: - - A sample script to patch a DB2 Admin password and associate it to application ids 'Ss2FBjSTQVef5LsqhPiYkg' and 'KJ8MdZVqK4odMUoBaClH'. - - ``` - curl -k -v -X PATCH \ - https:///api/synthetics/settings/credentials/associations/db2AdminPwd \ - -H 'authorization: apiToken ' \ - -H 'content-type: application/json' \ - -d '{ - "applications" : [ "Ss2FBjSTQVef5LsqhPiYkg", "KJ8MdZVqK4odMUoBaClH" ] - }' - ``` - '/api/synthetics/settings/credentials/{name}': - delete: - operationId: deleteSyntheticCredential + put: + operationId: updateSyntheticCredential parameters: - in: path name: name required: true schema: type: string + requestBody: + content: + application/json: + example: + credentialName: userPassword + credentialValue: '123456' + applications: + - f4KX5zd8RW2pERKKFUCZgQ + schema: + $ref: '#/components/schemas/SyntheticCredential' + required: true responses: - default: + '200': content: application/json: {} - description: default response + description: OK security: - ApiKeyAuth: - canConfigureSyntheticCredentials - summary: Delete Synthetic credential + summary: Update a Synthetic Credential tags: - Synthetic Settings /api/synthetics/settings/datacenters: @@ -19062,6 +19084,7 @@ paths: enum: - GROUPING - FILTERING + - SERVICE_MAPPING - SMART_ALERTS - SMART_ALERTS_LOGS - SMART_ALERTS_ADAPTIVE_BASELINE @@ -30487,6 +30510,8 @@ components: enum: - erroneous - all + required: + - trafficType Trigger: type: object description: The trigger is the Instana event or Smart Alert that defines the initial conditions that must be met for the policy to apply on the actions in `typeConfiguration`.