Instana Website Configuration 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 Website Configuration 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: Website Configuration
paths:
  /api/website-monitoring/config:
    get:
      description: API request to get all configured websites details.
      operationId: getWebsites
      responses:
        '200':
          content:
            application/json:
              example:
              - id: K3bP-bmCRkyimNai9vvq8o
                name: example_website
                appName: example_website
                rbacTags:
                - id: test
                  displayName: test
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Website'
          description: OK
        '400':
          description: Bad request.
        '401':
          description: Unauthorized access - requires user authentication.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth:
        - Default
      summary: Get configured websites
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
    post:
      description: API request to add new website.
      operationId: createWebsite
      parameters:
      - in: query
        name: name
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
            - id: test
              displayName: test
            schema:
              type: array
              items:
                type: object
                properties:
                  displayName:
                    type: string
                    description: Name of team tag
                  id:
                    type: string
                    description: ID of team tag
      responses:
        '200':
          content:
            application/json:
              example:
                id: K3bP-bmCRkyimNai9vvq8o
                name: example_website
                appName: example_website
              schema:
                $ref: '#/components/schemas/Website'
          description: Website successfully configured
        '400':
          description: Missing name query parameter or name already used for a configured website
        '401':
          description: Unauthorized access - requires user authentication.
        '403':
          description: Insufficient permissions.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth:
        - CanConfigureEumApplications
      summary: Configure new website
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
  /api/website-monitoring/config/{websiteId}:
    delete:
      description: API request to delete website.
      operationId: deleteWebsite
      parameters:
      - description: Website ID
        example: K3bP-bmCRkyimNai9vvq8o
        in: path
        name: websiteId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Website successfully removed
        '401':
          description: Unauthorized access - requires user authentication.
        '403':
          description: Insufficient permissions.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth:
        - CanConfigureEumApplications
      summary: Remove website
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
    get:
      description: API request to get configured website details for specified websiteId
      operationId: getWebsite
      parameters:
      - description: Website ID
        example: 1ELrNt-eQ9SlK4D_EgLMiA
        in: path
        name: websiteId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example: " {\n   \"id\": \"1ELrNt-eQ9SlK4D_EgLMiA\",\n   \"name\": \"example_website\",\n   \"appName\": \"example_website\"\n   \"rbacTags: [{\n       \"id\": \"test\",\n       \"displayName\": \"test\"\n   }]\n }\n"
              schema:
                $ref: '#/components/schemas/Website'
          description: OK
        '401':
          description: Unauthorized access - requires user authentication.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth:
        - Default
      summary: Get configured website
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
    put:
      description: API request to rename website.
      operationId: renameWebsite
      parameters:
      - description: Website ID
        example: K3bP-bmCRkyimNai9vvq8o
        in: path
        name: websiteId
        required: true
        schema:
          type: string
      - in: query
        name: name
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                id: K3bP-bmCRkyimNai9vvq8o
                name: example_website
                appName: example_website
              schema:
                $ref: '#/components/schemas/Website'
          description: Website successfully renamed
        '400':
          description: Missing name query parameter or name already used for a configured website
        '401':
          description: Unauthorized access - requires user authentication.
        '403':
          description: Insufficient permissions.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth:
        - CanConfigureEumApplications
      summary: Rename website
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
  /api/website-monitoring/config/{websiteId}/geo-location:
    get:
      description: API request to get geo-location configuration of a website specified by its websiteId
      operationId: getWebsiteGeoLocationConfiguration
      parameters:
      - description: Website ID
        example: 1ELrNt-eQ9SlK4D_EgLMiA
        in: path
        name: websiteId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                geoDetailRemoval: NO_REMOVAL
                geoMappingRules: []
              schema:
                $ref: '#/components/schemas/GeoLocationConfiguration'
          description: OK
        '401':
          description: Unauthorized access - requires user authentication.
        '403':
          description: Insufficient permissions.
        '404':
          description: Resource not found.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth:
        - CanConfigureEumApplications
      summary: Get geo location configuration for website
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
    put:
      description: API request to update geo location configuration for website.
      operationId: updateWebsiteGeoLocationConfiguration
      parameters:
      - description: Website ID
        example: iiLxP1zaTuCS7fyk9m4W0W
        in: path
        name: websiteId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GeoLocationConfiguration'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeoLocationConfiguration'
          description: OK
        '401':
          description: Unauthorized access - requires user authentication.
        '403':
          description: Insufficient permissions.
        '404':
          description: Resource not found.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth:
        - CanConfigureEumApplications
      summary: Update geo location configuration for website
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
  /api/website-monitoring/config/{websiteId}/geo-mapping-rules:
    get:
      description: API request to get custom geo mapping rules for website.
      operationId: getWebsiteGeoMappingRules
      parameters:
      - description: Website ID
        example: iiLxP1zaTuCS7fyk9m4W0W
        in: path
        name: websiteId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            text/csv: {}
          description: OK
        '401':
          description: Unauthorized access - requires user authentication.
        '403':
          description: Insufficient permissions.
        '404':
          description: Resource not found.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth:
        - CanConfigureEumApplications
      summary: Get custom geo mapping rules for website
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
    put:
      description: API request to set custom geo mapping rules for website.
      operationId: setWebsiteGeoMappingRules
      parameters:
      - description: Website ID
        example: K3bP-bmCRkyimNai9vvq8o
        in: path
        name: websiteId
        required: true
        schema:
          type: string
      requestBody:
        content:
          text/csv:
            schema:
              type: string
      responses:
        '200':
          content:
            text/csv: {}
          description: OK
        '401':
          description: Unauthorized access - requires user authentication.
        '403':
          description: Insufficient permissions.
        '404':
          description: Resource not found.
        '415':
          description: Unsupported Media Type.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth:
        - CanConfigureEumApplications
      summary: Set custom geo mapping rules for website
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
  /api/website-monitoring/config/{websiteId}/ip-masking:
    get:
      description: API request to get IP masking configuration of a website specified by its websiteId
      operationId: getWebsiteIpMaskingConfiguration
      parameters:
      - description: Website ID
        example: 1ELrNt-eQ9SlK4D_EgLMiA
        in: path
        name: websiteId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                ipMasking: DEFAULT
              schema:
                $ref: '#/components/schemas/IpMaskingConfiguration'
          description: OK
        '401':
          description: Unauthorized access - requires user authentication.
        '403':
          description: Insufficient permissions.
        '404':
          description: Resource not found.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth:
        - CanConfigureEumApplications
      summary: Get IP masking configuration for website
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
    put:
      description: API request to update IP masking configuration for website.
      operationId: updateWebsiteIpMaskingConfiguration
      parameters:
      - description: Website ID
        example: iiLxP1zaTuCS7fyk9m4W0W
        in: path
        name: websiteId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IpMaskingConfiguration'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpMaskingConfiguration'
          description: OK
        '401':
          description: Unauthorized access - requires user authentication.
        '403':
          description: Insufficient permissions.
        '404':
          description: Resource not found.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth:
        - CanConfigureEumApplications
      summary: Update IP masking configuration for website
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
  /api/website-monitoring/config/{websiteId}/sourcemap-upload:
    get:
      description: API request to get all sourcemap upload configurations for website.
      operationId: getWebsiteSourceMapUploadConfigurations
      parameters:
      - description: Website ID
        example: 1ELrNt-eQ9SlK4D_EgLMiA
        in: path
        name: websiteId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                configs:
                - id: 67f84a0b117c99e
                  description: websiteSourcemapUploadConfig1
                  createdAt: 1747978171.2347815
                  modifiedAt: 1747978171.2347815
                  metadata: []
              schema:
                $ref: '#/components/schemas/SourceMapUploadConfigs'
          description: OK
        '401':
          description: Unauthorized access - requires user authentication.
        '500':
          description: Internal server error.
      summary: Get all sourcemap upload configurations for website
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
    post:
      description: API request to add sourcemap upload configuration for website.
      operationId: postWebsiteSourceMapUploadConfig
      parameters:
      - description: Website ID
        example: 1ELrNt-eQ9SlK4D_EgLMiA
        in: path
        name: websiteId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              description: websiteSourcemapConfig2
            schema:
              type: object
              description: Source map upload configuration
              properties:
                description:
                  type: string
                  description: Name of configuration
      responses:
        '200':
          content:
            application/json:
              example:
                id: 5894971d635094e7
                description: websiteSourcemapConfig2
                createdAt: 1747980062.6018546
                modifiedAt: 1747980062.6018546
                metadata: []
              schema:
                $ref: '#/components/schemas/SourceMapUploadConfig'
          description: Website sourcemap upload configuration added successfully
        '400':
          description: Missing description or description already used for a configuration.
        '401':
          description: Unauthorized access - requires user authentication.
        '403':
          description: Insufficient permissions.
        '422':
          description: Unprocessable request - missing/invalid data.
        '500':
          description: Internal server error.
      summary: Add new sourcemap upload configuration for website
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
  /api/website-monitoring/config/{websiteId}/sourcemap-upload/{sourceMapConfigId}:
    delete:
      description: API request to delete sourcemap upload configuration for website.
      operationId: deleteWebsiteSourceMapUploadConfiguration
      parameters:
      - description: Website ID
        example: 1ELrNt-eQ9SlK4D_EgLMiA
        in: path
        name: websiteId
        required: true
        schema:
          type: string
      - description: Source Map Config ID
        example: 97e0ad312110d3ad
        in: path
        name: sourceMapConfigId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Sourcemap configuration successfully deleted or sourcemap not found
        '401':
          description: Unauthorized access - requires user authentication.
        '403':
          description: Insufficient permissions.
        '500':
          description: Internal server error.
      summary: Delete sourcemap upload configuration for website
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
    get:
      description: API request to get sourcemap upload configuration for website.
      operationId: getWebsiteSourceMapUploadConfiguration
      parameters:
      - in: path
        name: websiteId
        required: true
        schema:
          type: string
      - description: Source Map Config ID
        example: 97e0ad312110d3ad
        in: path
        name: sourceMapConfigId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                id: 67f84a0b117c99e
                description: websiteSourcemapUploadConfig1
                createdAt: 1747978171.2347815
                modifiedAt: 1747978171.2347815
                metadata: []
              schema:
                $ref: '#/components/schemas/SourceMapUploadConfig'
          description: OK
        '401':
          description: Unauthorized access - requires user authentication.
        '500':
          description: Internal server error.
      summary: Get sourcemap upload configurations for website
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
  /api/website-monitoring/config/{websiteId}/sourcemap-upload/{sourceMapConfigId}/clear:
    put:
      description: API request to clear source map files for sourcemap upload configuration.
      operationId: clearSourceMapUploadConfiguration
      parameters:
      - description: Website ID
        example: UhzF-fWORlyVLHDlvutYYQ
        in: path
        name: websiteId
        required: true
        schema:
          type: string
      - description: Source Map Config ID
        example: 97e0ad312110d3ad
        in: path
        name: sourceMapConfigId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Source map files in the source map upload configuration successfully cleared
        '401':
          description: Unauthorized access - requires user authentication.
        '403':
          description: Insufficient permissions.
        '404':
          description: Resource not found.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth:
        - CanConfigureEumApplications
      summary: Clear source map files for sourcemap upload configuration
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
  /api/website-monitoring/config/{websiteId}/sourcemap-upload/{sourceMapConfigId}/form:
    put:
      description: API request to upload sourcemap file for website.
      operationId: uploadSourceMapFile
      parameters:
      - description: Website ID
        example: UhzF-fWORlyVLHDlvutYYQ
        in: path
        name: websiteId
        required: true
        schema:
          type: string
      - description: Source Map Config ID
        example: 97e0ad312110d3ad
        in: path
        name: sourceMapConfigId
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                fileFormat:
                  type: string
                sourceMap:
                  type: string
                  format: binary
                  description: Local Source Map file path
                url:
                  type: string
                  description: URL of the website
              required:
              - sourceMap
              - url
      responses:
        '200':
          content:
            application/json:
              example:
                id: 67f84a0b117c99e
                description: websiteSourcemapUploadConfig1
                createdAt: 1747978171.2347815
                modifiedAt: 1747978171.2347815
                metadata: []
              schema:
                $ref: '#/components/schemas/SourceMapUploadConfig'
          description: OK
        '400':
          description: Bad request.
        '401':
          description: Unauthorized access - requires user authentication.
        '403':
          description: Insufficient permissions.
        '404':
          description: Resource not found.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth:
        - CanConfigureEumApplications
      summary: Upload sourcemap file for website
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
  /api/website-monitoring/config/{websiteId}/teams:
    put:
      description: API request to update teams of a website.
      operationId: updateWebsiteTeams
      parameters:
      - in: path
        name: websiteId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
            - id: test
              displayName: test
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ApiTag'
      responses:
        '200':
          content:
            application/json:
              example:
              - id: test
                displayName: test
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiTag'
          description: Website successfully configured
        '400':
          description: Bad request.
        '401':
          description: Unauthorized access - requires user authentication.
        '403':
          description: Insufficient permissions.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth:
        - CanConfigureEumApplications
      summary: Update teams assigned to the website
      tags:
      - Website Configuration
      x-ibm-ahub-byok: true
components:
  schemas:
    ApiTag:
      type: object
      properties:
        displayName:
          type: string
          maxLength: 256
          minLength: 0
        id:
          type: string
          maxLength: 64
          minLength: 0
      required:
      - displayName
      - id
    GeoSubdivision:
      type: object
      properties:
        code:
          type: string
          maxLength: 32
          minLength: 0
        name:
          type: string
          maxLength: 256
          minLength: 0
      required:
      - name
    Website:
      type: object
      properties:
        appName:
          type: string
        id:
          type: string
        name:
          type: string
      required:
      - id
      - name
    SourceMapFileMeta:
      type: object
      properties:
        blobs:
          type: array
          items:
            $ref: '#/components/schemas/SourceMapFileBlob'
        format:
          type: string
        meta:
          type: string
        size:
          type: integer
          format: int64
        sizeOnDisk:
          type: integer
          format: int64
        type:
          type: string
          enum:
          - JS_MAP
          - JS
          - R8PG_MAP
          - DWARF
        url:
          type: string
      required:
      - format
      - type
      - url
    SourceMapUploadConfig:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
        description:
          type: string
        id:
          type: string
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/SourceMapFileMeta'
          maxItems: 500
          minItems: 0
        modifiedAt:
          type: string
          format: date-time
      required:
      - id
      - metadata
    SourceMapUploadConfigs:
      type: object
      properties:
        config:
          type: array
          items:
            $ref: '#/components/schemas/SourceMapUploadConfig'
          writeOnly: true
        configs:
          type: array
          items:
            $ref: '#/components/schemas/SourceMapUploadConfig'
          maxItems: 1024
          minItems: 0
      required:
      - configs
    GeoMappingRule:
      type: object
      properties:
        accuracyRadius:
          type: integer
          format: int64
          minimum: -1
        cidr:
          type: string
          maxLength: 128
          minLength: 0
        city:
          type: string
        continent:
          type: string
        continentCode:
          type: string
        country:
          type: string
        countryCode:
          type: string
        latitude:
          type: number
          format: double
        leastSpecificSubdivision:
          $ref: '#/components/schemas/GeoSubdivision'
        longitude:
          type: number
          format: double
        subdivisions:
          type: array
          items:
            $ref: '#/components/schemas/GeoSubdivision'
          maxItems: 8
          minItems: 0
      required:
      - cidr
      - subdivisions
    IpMaskingConfiguration:
      type: object
      properties:
        ipMasking:
          type: string
          enum:
          - DEFAULT
          - STRICT
          - REMOVE_ALL_DETAILS
      required:
      - ipMasking
    SourceMapFileBlob:
      type: object
      properties:
        blobIndex:
          type: integer
          format: int32
        size:
          type: integer
          format: int64
        sizeOnDisk:
          type: integer
          format: int64
    GeoLocationConfiguration:
      type: object
      properties:
        geoDetailRemoval:
          type: string
          enum:
          - NO_REMOVAL
          - REMOVE_COORDINATES
          - REMOVE_CITY
          - REMOVE_ALL
        geoMappingRules:
          type: array
          items:
            $ref: '#/components/schemas/GeoMappingRule'
          maxItems: 512
          minItems: 0
      required:
      - geoDetailRemoval
  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