openapi: 3.0.1
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 SLO Correction Configurations 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? Check our [IBM Instana Community](https://community.ibm.com/community/user/aiops/communities/community-home?CommunityKey=58f324a3-3104-41be-9510-5b7c413cc48f).\n\n<div style=\"background-color:#e6f0ff; padding: 12px; border-left: 6px solid #0052cc; font-size: 14px; display: flex; align-items: center;\">\n  <img src=\"https://img.icons8.com/ios-filled/50/0052cc/info.png\" width=\"18\" height=\"18\" style=\"margin-right: 8px;\" alt=\"info icon\"/>\n  <span>\n    <b>Our API documentation is moving to</b> \n    <a href=\"https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Introduction\" target=\"_blank\">API Hub</a>\n\t — please update your bookmarks now, as the current site will be deprecated after Release-306.\n  </span>\n</div>\n\n## Overview\nThe Instana REST API provides programmatic access to the Instana platform. It can be used to retrieve data available through the Instana UI Dashboard -- metrics, events, traces, etc -- and also to automate configuration tasks such as user management.\n\n### Navigating the API documentation\nThe API endpoints are grouped by product area and functionality. This generally maps to how our UI Dashboard is organized, hopefully making it easier to locate which endpoints you'd use to fetch the data you see visualized in our UI. The [UI sections](https://www.ibm.com/docs/en/instana-observability/current?topic=working-user-interface#navigation-menu) include:\n- Websites & Mobile Apps\n- Applications\n- Infrastructure\n- Synthetic Monitoring\n- Events\n- Automation\n- Service Levels\n- Settings\n- etc\n\n### Rate Limiting\nA rate limit is applied to API usage. Up to 5,000 calls per hour can be made. How many remaining calls can be made and when this call limit resets, can inspected via three headers that are part of the responses of the API server.\n\n- **X-RateLimit-Limit:** Shows the maximum number of calls that may be executed per hour.\n- **X-RateLimit-Remaining:** How many calls may still be executed within the current hour.\n- **X-RateLimit-Reset:** Time when the remaining calls will be reset to the limit. For compatibility reasons with other rate limited APIs, this date is not the date in milliseconds, but instead in seconds since 1970-01-01T00:00:00+00:00.\n\n### Further Reading\nWe provide additional documentation for our REST API in our [product documentation](https://www.ibm.com/docs/en/instana-observability/current?topic=apis-web-rest-api). Here you'll also find some common queries for retrieving data and configuring Instana.\n\n## Getting Started with the REST API\n\n### API base URL\nThe base URL for an specific instance of Instana can be determined using the tenant and unit information.\n- `base`: This is the base URL of a tenant unit, e.g. `https://test-example.instana.io`. This is the same URL that is used to access the Instana user interface.\n- `apiToken`: Requests against the Instana API require valid API tokens. An initial API token can be generated via the Instana user interface. Any additional API tokens can be generated via the API itself.\n\n### Curl Example\nHere is an Example to use the REST API with Curl. First lets get all the available metrics with possible aggregations with a GET call.\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\nNext we can get every call grouped by the endpoint name that has an error count greater then zero. As a metric we could get the mean error rate for example.\n\n```bash\ncurl --request POST \\\n  --url https://test-instana.instana.io/api/application-monitoring/analyze/call-groups \\\n  --header 'authorization: apiToken xxxxxxxxxxxxxxxx' \\\n  --header 'content-type: application/json' \\\n  --data '{\n  \"group\":{\n      \"groupbyTag\":\"endpoint.name\"\n  },\n  \"tagFilters\":[\n  \t{\n  \t\t\"name\":\"call.error.count\",\n  \t\t\"value\":\"0\",\n  \t\t\"operator\":\"GREATER_THAN\"\n  \t}\n  ],\n  \"metrics\":[\n  \t{\n  \t\t\"metric\":\"errors\",\n  \t\t\"aggregation\":\"MEAN\"\n  \t}\n  ]\n  }'\n```\n\n### Generating REST API clients\n\nThe API is specified using the [OpenAPI v3](https://github.com/OAI/OpenAPI-Specification) (previously known as Swagger) format.\nYou can download the current specification at our [GitHub API documentation](https://instana.github.io/openapi/openapi.yaml).\n\nOpenAPI tries to solve the issue of ever-evolving APIs and clients lagging behind. Please make sure that you always use the latest version of the generator, as a number of improvements are regularly made.\nTo generate a client library for your language, you can use the [OpenAPI client generators](https://github.com/OpenAPITools/openapi-generator).\n\n#### Go\nFor example, to generate a client library for Go to interact with our backend, you can use the following script; mind replacing the values of the `UNIT_NAME` and `TENANT_NAME` environment variables using those for your tenant unit:\n\n```bash\n#!/bin/bash\n\n### This script assumes you have the `java` and `wget` commands on the path\n\nexport UNIT_NAME='myunit' # for example: prod\nexport TENANT_NAME='mytenant' # for example: awesomecompany\n\n//Download the generator to your current working directory:\nwget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar -O openapi-generator-cli.jar --server-variables \"tenant=${TENANT_NAME},unit=${UNIT_NAME}\"\n\n//generate a client library that you can vendor into your repository\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g go \\\n    -o pkg/instana/openapi \\\n    --skip-validate-spec\n\n//(optional) format the Go code according to the Go code standard\ngofmt -s -w pkg/instana/openapi\n```\n\nThe generated clients contain comprehensive READMEs, and you can start right away using the client from the example above:\n\n```go\nimport instana \"./pkg/instana/openapi\"\n\n// readTags will read all available application monitoring tags along with their type and category\nfunc readTags() {\n\tconfiguration := instana.NewConfiguration()\n\tconfiguration.Host = \"tenant-unit.instana.io\"\n\tconfiguration.BasePath = \"https://tenant-unit.instana.io\"\n\n\tclient := instana.NewAPIClient(configuration)\n\tauth := context.WithValue(context.Background(), instana.ContextAPIKey, instana.APIKey{\n\t\tKey:    apiKey,\n\t\tPrefix: \"apiToken\",\n\t})\n\n\ttags, _, err := client.ApplicationCatalogApi.GetApplicationTagCatalog(auth)\n\tif err != nil {\n\t\tfmt.Fatalf(\"Error calling the API, aborting.\")\n\t}\n\n\tfor _, tag := range tags {\n\t\tfmt.Printf(\"%s (%s): %s\\n\", tag.Category, tag.Type, tag.Name)\n\t}\n}\n```\n\n#### Java\nFollow the instructions provided in the official documentation from [OpenAPI Tools](https://github.com/OpenAPITools) to download the [openapi-generator-cli.jar](https://github.com/OpenAPITools/openapi-generator?tab=readme-ov-file#13---download-jar).\n\nDepending on your environment, use one of the following java http client implementations which will create a valid client for our OpenAPI specification:\n```\n//Nativ Java HTTP Client\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec  -p dateLibrary=java8 --library native\n\n//Spring WebClient\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec  -p dateLibrary=java8,hideGenerationTimestamp=true --library webclient\n\n//Spring RestTemplate\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec  -p dateLibrary=java8,hideGenerationTimestamp=true --library resttemplate\n\n```\n"
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: SLO Correction Configurations
paths:
  /api/settings/correction:
    get:
      operationId: getAllSloCorrectionWindowConfigs
      parameters:
      - in: query
        name: pageSize
        schema:
          type: integer
          format: int32
          description: Size of the Page
          example: 1
      - in: query
        name: page
        schema:
          type: integer
          format: int32
          description: Page Number
          example: 1
      - in: query
        name: orderBy
        schema:
          type: string
          description: Order By Value
          enum:
          - name
          - start
          - nextStart
          - duration
          - 'null'
          example: name
      - in: query
        name: orderDirection
        schema:
          type: string
          description: Order Direction of the Result, it could be ascending or descending
          enum:
          - ASC
          - DESC
          example: ASC
      - in: query
        name: query
        schema:
          type: string
          description: Keyword or Query which needs to be searched
          example: test Correction
      - in: query
        name: tag
        schema:
          type: array
          description: List of tags which needs to be searched
          example: Testing
          items:
            type: string
            description: List of tags which needs to be searched
            example: Testing
          uniqueItems: true
      - in: query
        name: id
        schema:
          type: array
          description: List of Correction Configuration IDs for which details need to be fetched
          example: SSPTkTWoT1W0OpE_iQbfaA
          items:
            type: string
            description: List of Correction Configuration IDs for which details need to be fetched
            example: SSPTkTWoT1W0OpE_iQbfaA
      - in: query
        name: sloId
        schema:
          type: array
          description: List of SLO IDs for which details need to be fetched
          example: SLOdCTspkHlS_OzNOATQWgsuw
          items:
            type: string
            description: List of SLO IDs for which details need to be fetched
            example: SLOdCTspkHlS_OzNOATQWgsuw
      - in: query
        name: refresh
        schema:
          type: boolean
          description: Boolean operator which specifies if the cache needs to be refreshed
          example: false
      responses:
        '200':
          content:
            application/json:
              example:
                items:
                - id: N9RdTL-WQkSTa3DYZidxzw
                  name: Correction test 2
                  description: Correction test 2
                  active: false
                  createdDate: 1749638253403
                  lastUpdated: 1749595053386
                  scheduling:
                    startTime: 1749664800000
                    duration: 2
                    durationUnit: hour
                    recurrentRule: FREQ=DAILY;INTERVAL=1
                    recurrent: true
                  sloIds:
                  - SLOBL-EmhZZQRy-19JVEivEdg
                  tags: []
                - id: p9kWax0uS7K2Who1WegsSg
                  name: New test for DST corrections - Test-1
                  description: This is to minimize impacts from DST
                  active: true
                  createdDate: 1749514781416
                  lastUpdated: 1749514780649
                  scheduling:
                    startTime: 1748775600000
                    duration: 10
                    durationUnit: hour
                    recurrentRule: FREQ=DAILY;INTERVAL=1
                    recurrent: true
                  sloIds:
                  - SLOffwtrVkfRmCjOZbdv3Ls9g
                  tags:
                  - seasonal
                  - once
                - id: b1T4ShnZS-qaORzBTAFRTA
                  name: test rrule - one time
                  description: test
                  active: true
                  createdDate: 1750161592895
                  lastUpdated: 1750161592139
                  scheduling:
                    startTime: 1750287600000
                    duration: 24
                    durationUnit: hour
                    recurrentRule: ''
                    recurrent: false
                  sloIds:
                  - SLOffwtrVkfRmCjOZbdv3Ls9g
                  tags: []
                page: 1
                pageSize: 10000
                totalHits: 3
              schema:
                $ref: '#/components/schemas/PaginatedResult'
          description: Fetched list of the SLO Correction Window Configurations Successfully
      security:
      - ApiKeyAuth:
        - Default
      summary: Get All SLO Correction Window Configs
      tags:
      - SLO Correction Configurations
      x-ibm-ahub-byok: true
    post:
      operationId: createSloCorrectionWindowConfig
      requestBody:
        content:
          application/json:
            example:
              name: New test for DST corrections Test-9
              description: This is to check report API
              active: true
              scheduling:
                startTime: 1749607200000
                duration: 3
                durationUnit: HOUR
                recurrentRule: FREQ=DAILY;INTERVAL=1
              sloIds:
              - SLO4s-fs-GuT56c3v4KzQKBuQ
              tags:
              - test
              - rrule
            schema:
              $ref: '#/components/schemas/CorrectionConfiguration'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                id: S8rHrE93Rz2TXScTjBw1eg
                name: New test for DST corrections Test-9
                description: This is to check report API
                active: true
                createdDate: 1750179360429
                lastUpdated: 1750179359948
                scheduling:
                  startTime: 1749607200000
                  duration: 3
                  durationUnit: hour
                  recurrentRule: FREQ=DAILY;INTERVAL=1
                  recurrent: true
                sloIds:
                - SLO4s-fs-GuT56c3v4KzQKBuQ
                tags:
                - rrule
                - test
              schema:
                $ref: '#/components/schemas/CorrectionConfiguration'
          description: New SLO Correction Window Configuration Created Successfully
      security:
      - ApiKeyAuth:
        - canConfigureServiceLevelCorrectionWindows
      summary: Create a new SLO Correction Window Config
      tags:
      - SLO Correction Configurations
      x-ibm-ahub-byok: true
  /api/settings/correction/{id}:
    delete:
      operationId: deleteSloCorrectionWindowConfig
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          description: SLO Correction Window Configuration ID
          example: cvLxfzNJQriV86MQTqOu1g
      responses:
        '204':
          description: SLO Correction Window Configuration Deleted Successfully
      security:
      - ApiKeyAuth:
        - canConfigureServiceLevelCorrectionWindows
      summary: Delete an existing SLO Correction Window Configuration
      tags:
      - SLO Correction Configurations
      x-ibm-ahub-byok: true
    get:
      operationId: getSloCorrectionWindowConfigById
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          description: SLO Correction Window Configuration ID
          example: dCTspkffgHlS_OzNOATQWgsuw
      - in: query
        name: refresh
        schema:
          type: boolean
          description: Boolean operator which specifies if the cache needs to be refreshed
          example: false
      responses:
        '200':
          content:
            application/json:
              example:
                id: S8rHrE93Rz2TXScTjBw1eg
                name: New test for DST corrections Test-9
                description: This is to check report API
                active: true
                createdDate: 1750179360429
                lastUpdated: 1750179359948
                scheduling:
                  startTime: 1749607200000
                  duration: 3
                  durationUnit: hour
                  recurrentRule: FREQ=DAILY;INTERVAL=1
                  recurrent: true
                sloIds:
                - SLO4s-fs-GuT56c3v4KzQKBuQ
                tags:
                - rrule
                - test
              schema:
                $ref: '#/components/schemas/CorrectionConfiguration'
          description: Fetched SLO Correction Window Configuration Successfully
        '404':
          content:
            application/json:
              example:
                errors:
                - The SLO Correction Window Configuration you are looking for does not exist.
              schema:
                type: string
          description: SLO Correction Window Configuration Not Found
      security:
      - ApiKeyAuth:
        - Default
      summary: Get an existing SLO Correction Window Config
      tags:
      - SLO Correction Configurations
      x-ibm-ahub-byok: true
    put:
      operationId: updateSloCorrectionWindowConfig
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          description: SLO Correction Window Configuration ID
          example: cvLxfzNJQriV86MQTqOu1g
      requestBody:
        content:
          application/json:
            example:
              name: New test for DST corrections Test-9
              description: This is to check report API
              active: true
              scheduling:
                startTime: 1749607200000
                duration: 3
                durationUnit: HOUR
                recurrentRule: FREQ=DAILY;INTERVAL=1
              sloIds:
              - SLO4s-fs-GuT56c3v4KzQKBuQ
              tags:
              - test
              - rrule
            schema:
              $ref: '#/components/schemas/CorrectionConfiguration'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                id: S8rHrE93Rz2TXScTjBw1eg
                name: New test for DST corrections Test-9
                description: This is to check report API
                active: true
                createdDate: 1750179360429
                lastUpdated: 1750179359948
                scheduling:
                  startTime: 1749607200000
                  duration: 3
                  durationUnit: hour
                  recurrentRule: FREQ=DAILY;INTERVAL=1
                  recurrent: true
                sloIds:
                - SLO4s-fs-GuT56c3v4KzQKBuQ
                tags:
                - rrule
                - test
              schema:
                $ref: '#/components/schemas/CorrectionConfiguration'
          description: Updated SLO Correction Window Configuration Successfully
        '404':
          content:
            application/json:
              example:
                errors:
                - The SLO Correction Window Configuration you are looking for does not exist.
              schema:
                type: string
          description: SLO Correction Window Configuration Not Found
      security:
      - ApiKeyAuth:
        - canConfigureServiceLevelCorrectionWindows
      summary: Update an existing SLO Correction Window Config
      tags:
      - SLO Correction Configurations
      x-ibm-ahub-byok: true
components:
  schemas:
    CorrectionScheduling:
      type: object
      description: Time scheduling of the SLO Correction Window configurations.
      properties:
        duration:
          type: integer
          format: int32
          description: Duration of the correction window, defined by the count of time units.
        durationUnit:
          type: string
          description: 'Unit for duration. Supported values: `MINUTE`, `HOUR`, `DAY`.'
          enum:
          - millisecond
          - second
          - minute
          - hour
          - day
          - week
          - month
        recurrent:
          type: boolean
        recurrentRule:
          type: string
          description: 'Recurrence Rule defines how the event recurs, using iCalendar RRULE format (e.g., `FREQ=DAILY;INTERVAL=1`).It supports fields like FREQ, INTERVAL, BYDAY, etc. Refer to RFC 5545: https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10'
          maxLength: 2048
          minLength: 0
        startTime:
          type: string
          format: date-time
          description: Start time of the correction window in milliseconds since epoch (UTC) (e.g., `1706713140000`).
      required:
      - duration
      - durationUnit
      - startTime
    CorrectionConfiguration:
      type: object
      properties:
        active:
          type: boolean
          description: If value is true, then the correction window is active
        createdDate:
          type: string
          format: date-time
          description: Created date of SLO Correction Window Configuration
        description:
          type: string
          description: Description of the SLO Correction Window Configuration
        id:
          type: string
          description: SLO Correction Window Configuration ID
          maxLength: 64
          minLength: 0
        lastUpdated:
          type: string
          format: date-time
          description: Last updated date of SLO Correction Window Configuration
        name:
          type: string
          description: Name of the SLO Correction Window Configuration
        scheduling:
          $ref: '#/components/schemas/CorrectionScheduling'
        sloIds:
          type: array
          description: This is the list of SLO configurations related to this Correction Window.
          items:
            type: string
            description: This is the list of SLO configurations related to this Correction Window.
          maxItems: 1024
          minItems: 0
          uniqueItems: true
        tags:
          type: array
          description: List of tags associated with SLO Correction Window Configuration
          items:
            type: string
            description: List of tags associated with SLO Correction Window Configuration
          uniqueItems: true
      required:
      - name
      - scheduling
      - sloIds
      - tags
    PaginatedResult:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
        page:
          type: integer
          format: int32
          description: Page Number
          minimum: 1
        pageSize:
          type: integer
          format: int32
          minimum: 1
        totalHits:
          type: integer
          format: int64
          minimum: 0
      required:
      - items
  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