Instana Application Topology API

openapi: 3.2.0
info:
  contact:
    email: support@instana.com
    name: © Instana
    url: http://instana.com
  termsOfService: https://www.instana.com/terms-of-use/
  title: Instana REST API documentation Application Topology API
  version: 1.307.1417
  x-ibm-ahub-try: true
  x-logo:
    altText: instana logo
    backgroundColor: '#FAFBFC'
    url: header-logo.svg
  description: Searching for answers and best pratices?
servers:
- description: Instana Backend
  url: https://{unit}-{tenant}.instana.io
  variables:
    tenant:
      default: tenant
      description: Customer tenant unit
    unit:
      default: unit
      description: Customer tenant name
- description: Instana Self-Hosted Backend
  url: https://{domain}
  variables:
    domain:
      default: example.com
      description: Customer Self-Hosted domain
tags:
- name: Application Topology
paths:
  /api/application-monitoring/topology/services:
    get:
      description: 'Use this API endpoint if one wants to retrieve services and connections (call paths) between them for calls in the scope given by the parameters.


        ## Errata:


        The following fields are unsupported but documented in the schema for the result `services`:

        - The `applications` field is always missing and the `snapshotIds` field is always empty, despite being declared as required in the result schema.

        - The `maxSeverity` and `numberOfOpenIssues` fields are always missing.'
      operationId: getServicesMap
      parameters:
      - description: Size of time window in milliseconds
        in: query
        name: windowSize
        schema:
          type: integer
          format: int64
      - description: Timestamp since Unix Epoch in milliseconds of the end of the time window
        in: query
        name: to
        schema:
          type: integer
          format: int64
      - description: Filter by application ID
        in: query
        name: applicationId
        schema:
          type: string
      - description: Filter by application scope, i.e., INBOUND or ALL. The default value is INBOUND. Applies only if application ID filter is specified.
        in: query
        name: applicationBoundaryScope
        schema:
          type: string
          enum:
          - ALL
          - INBOUND
      responses:
        '200':
          content:
            application/json:
              example:
                connections:
                - from: 8bfb4e1aa590eab8f08f837b97acf5803a5737ed
                  to: f17e7efb3b9b2d62bfec6b07905759fb81e99797
                  calls: 2179
                  latency: 1.6103717301514455
                  errorRate: 0
                services:
                - id: f17e7efb3b9b2d62bfec6b07905759fb81e99797
                  label: robot-shop
                  types:
                  - MESSAGING
                  technologies:
                  - kubernetesService
                  - rabbitMq
                  snapshotIds: []
                  entityType: SERVICE
              schema:
                $ref: '#/components/schemas/ServiceMap'
          description: OK
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - ApiKeyAuth:
        - Default
      summary: Gets the service topology
      tags:
      - Application Topology
      x-ibm-ahub-byok: true
components:
  schemas:
    ExtendedService:
      type: object
      description: List of services in the topology.
      properties:
        applications:
          type: array
          items:
            type: string
          uniqueItems: true
        entityType:
          type: string
          description: Since, this is a Service, it will be of type `SERVICE`.
          enum:
          - APPLICATION
          - SERVICE
          - ENDPOINT
        id:
          type: string
          description: 'Unique ID of the Service. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`.'
        label:
          type: string
          description: 'Name of the Service. Eg: `payment`.'
        maxSeverity:
          type: number
          format: double
          maximum: 10
          minimum: 0
        numberOfOpenIssues:
          type: integer
          format: int32
          minimum: 0
        snapshotIds:
          type: array
          description: A unique identifier the metrics are assigned to.
          items:
            type: string
            description: A unique identifier the metrics are assigned to.
          uniqueItems: true
        technologies:
          type: array
          description: 'List of technologies: `Eg:["springbootApplicationContainer"]`'
          items:
            type: string
            description: 'List of technologies: `Eg:["springbootApplicationContainer"]`'
          uniqueItems: true
        types:
          type: array
          description: 'Shows types of Endpoints a Service can consist of. It may be one or more. Eg: `HTTP` `OPENTELEMETRY` can be in 1 Service.'
          items:
            type: string
            description: 'Shows types of Endpoints a Service can consist of. It may be one or more. Eg: `HTTP` `OPENTELEMETRY` can be in 1 Service.'
            enum:
            - UNDEFINED
            - RPC
            - EVENT
            - GRAPHQL
            - BATCH
            - SHELL
            - HTTP
            - SDK
            - OPENTELEMETRY
            - INTERNAL
            - DATABASE
            - MESSAGING
            - PAGE
            - PAGE_RESOURCE
          uniqueItems: true
      required:
      - applications
      - id
      - label
      - snapshotIds
      - technologies
      - types
    ServiceMap:
      type: object
      properties:
        connections:
          type: array
          description: A list which indicates which services are consumers and which are providers in the communication chain.
          items:
            $ref: '#/components/schemas/ServiceMapConnection'
          uniqueItems: true
        services:
          type: array
          description: List of services in the topology.
          items:
            $ref: '#/components/schemas/ExtendedService'
          uniqueItems: true
      required:
      - connections
      - services
    ServiceMapConnection:
      type: object
      description: A list which indicates which services are consumers and which are providers in the communication chain.
      properties:
        calls:
          type: integer
          format: int64
          description: "The number of calls between the 2 services.\nEg: The number of calls from `24558242fdeb52571cfb9fa42f1b334aa65d7e61` service to `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa` service over the mentioned timeframe is `200`. \n\nIf no timeframe (`to` and `windowSize` in query paramter) is mentioned, the timeframe is taken as last hour.\n"
          minimum: 0
        errorRate:
          type: number
          format: double
          description: "The error rate of the calls between the 2 services.\nEg: The error rate of calls from `24558242fdeb52571cfb9fa42f1b334aa65d7e61` service to `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa` service over the mentioned timeframe is `0.1`. \n\nThe value is between 0 and 1. \n\nIf no timeframe (`to` and `windowSize` in query paramter) is mentioned, the timeframe is taken as last hour.\n"
          maximum: 1
          minimum: 0
        from:
          type: string
          description: 'The service that initiates a request to another service.

            It contains a unique service id. Eg: `24558242fdeb52571cfb9fa42f1b334aa65d7e61`.

            '
        latency:
          type: number
          format: double
          description: "The mean latency of the calls between the 2 services.\nEg: The mean latency of calls from `24558242fdeb52571cfb9fa42f1b334aa65d7e61` service to `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa` service over the mentioned timeframe is `4.46`. \n\nThe value is in milliseconds. \n\nIf no timeframe (`to` and `windowSize` in query paramter) is mentioned, the timeframe is taken as last hour.\n"
          minimum: 0
        to:
          type: string
          description: 'The service that receives the request sent by the source service.

            It contains a unique service id. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`.

            '
      required:
      - from
      - to
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: authorization
      type: apiKey
      description: "## Example\n\n```bash\ncurl --request GET \\\n  --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \\\n  --header 'authorization: apiToken xxxxxxxxxxxxxxxx'\n```\n"
x-tagGroups:
- name: Websites & Mobile Apps
  tags:
  - Website Metrics
  - Website Catalog
  - Website Analyze
  - Website Configuration
  - Mobile App Metrics
  - Mobile App Catalog
  - Mobile App Analyze
  - Mobile App Configuration
  - End User Monitoring
- name: Applications
  tags:
  - Application Metrics
  - Application Resources
  - Application Catalog
  - Application Analyze
  - Application Settings
  - Application Topology
  - Application Alert Configuration
  - Global Application Alert Configuration
- name: Infrastructure
  tags:
  - Infrastructure Analyze
  - Infrastructure Metrics
  - Infrastructure Resources
  - Infrastructure Catalog
  - Infrastructure Topology
- name: Logging
  tags:
  - Logging Analyze
- name: Synthetic Monitoring
  tags:
  - Synthetic Catalog
  - Synthetic Metrics
  - Synthetic Settings
  - Synthetic Test Playback Results
  - Synthetic Alert Configuration
- name: Logs
  tags:
  - Log Alert Configuration
- name: Events
  tags:
  - Events
  - Event Settings
- name: Automation
  tags:
  - Action Catalog
  - Action History
  - Policies
- name: Service Levels
  tags:
  - SLI Settings
  - SLI Report
  - Apdex Settings
  - Apdex Report
  - Service Levels Objective(SLO) Configurations
  - Service Levels Objective(SLO) Report
  - Service Levels Alert Configuration
  - SLO Correction Configurations
  - SLO Correction Windows
- name: AI Management
  tags:
  - AI Management
- name: Settings
  tags:
  - Custom Dashboards
  - User
  - Groups
  - Teams
  - Roles
  - Audit Log
  - API Token
  - Maintenance Configuration
  - Synthetic Calls
  - Session Settings
  - Automation Settings
  - Authentication
- name: Open Beta Features
  tags:
  - Infrastructure Analyze
- name: Closed Beta Features
  tags:
  - Infrastructure Alert Configuration
- name: Instana
  tags:
  - Releases
  - Host Agent
  - Health
  - Usage