openapi: 3.2.0
info:
  contact:
    email: support@altr.com
    name: API Support
  description: This is the API for managing sidecar and agent telemetry data.
  termsOfService: https://altr.com/info/altr-solutions-inc-terms-of-service/
  title: ALTR Telemetry Sidecar API
  version: 1.7.0
servers:
- url: https://{org_id}.sc-control.live.altr.com/v1
  variables:
    org_id:
      default: ''
tags:
- name: Sidecar
paths:
  /sidecars/{sidecar_id}/instances:
    get:
      description: Get sidecar instances for a specific sidecar by its ID.
      parameters:
      - description: Sidecar ID
        in: path
        name: sidecar_id
        required: true
        schema:
          type: string
      - description: If provided, will return the next set of items after this ID. If not provided, will return the first set of items.
        in: query
        name: contiguous_id
        schema:
          type: string
      - description: Maximum number of items to return, must be between 1 and 1000
        in: query
        name: limit
        schema:
          type: integer
      - description: Filter instances checked in at or after this time (inclusive). Accepts unix milliseconds or relative duration (e.g. 5m, 1h, 24h, 7d).
        in: query
        name: checkin_after
        schema:
          type: string
      - description: Filter instances checked in at or before this time (inclusive). Accepts unix milliseconds or relative duration (e.g. 5m, 1h, 24h, 7d).
        in: query
        name: checkin_before
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.SidecarInstancesItemResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/main.APIErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/main.APIErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/main.APIErrorResponse'
          description: Internal Server Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/main.APIErrorResponse'
          description: Service Unavailable
      security:
      - basic: []
      summary: Get Sidecar Instances by Sidecar ID
      tags:
      - Sidecar
  /sidecars/{sidecar_id}/instances/{instance_id}:
    delete:
      description: Delete a sidecar instance by its ID.
      parameters:
      - description: Sidecar ID
        in: path
        name: sidecar_id
        required: true
        schema:
          type: string
      - description: Instance ID
        in: path
        name: instance_id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/main.APIErrorResponse'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/main.APIErrorResponse'
          description: Internal Server Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/main.APIErrorResponse'
          description: Service Unavailable
      security:
      - basic: []
      summary: Delete Sidecar Instance by ID
      tags:
      - Sidecar
    get:
      description: Get a specific sidecar instance by its ID.
      parameters:
      - description: Sidecar ID
        in: path
        name: sidecar_id
        required: true
        schema:
          type: string
      - description: Instance ID
        in: path
        name: instance_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.SidecarInstanceItemResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/main.APIErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/main.APIErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/main.APIErrorResponse'
          description: Internal Server Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/main.APIErrorResponse'
          description: Service Unavailable
      security:
      - basic: []
      summary: Get Sidecar Instance by ID
      tags:
      - Sidecar
components:
  schemas:
    fiber.APIErrorResponse:
      properties:
        error_code:
          type: integer
        message:
          type: string
      type: object
    main.APIErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/fiber.APIErrorResponse'
      type: object
    types.SidecarInstancesItemResponse:
      properties:
        contiguous_id:
          description: Base64 encoded string representing the LastEvaluatedKey for pagination
          example: eyJHU0kyUEsiOiJPUkdJRCM1MmY0MTVhNC1kZTM3LTQ5OGItYTM4Zi1jMGEzYjQ3NDczMGUjU0lERUNBUklEI2IzMDg2YTcyLWYyNGEtNDkwNS1hODQ4LWNlM2VlMjc0MzI0NiIsIkdTSTJTSyI6IkNIRUNLSU5USU1FIzIwMjUtMDctMDhUMTc6MjA6MTguOTg1WiIsIlBLIjoiVEVMRU1FVFJZI09SR0lEIzUyZjQxNWE0LWRlMzctNDk4Yi1hMzhmLWMwYTNiNDc0NzMwZSNTSURFQ0FSSUQjYjMwODZhNzItZjI0YS00OTA1LWE4NDgtY2UzZWUyNzQzMjQ2I0lOU1RBTkNFSUQjYzU4YTI5NzYtZDJkZi00YWY0LTlmYmEtYmRhNmUwOWM4YzFmIiwiU0siOiJDSEVDS0lOIn0
          type: string
        items:
          description: List of sidecar instance items
          items:
            $ref: '#/components/schemas/types.SidecarInstanceItemResponse'
          type: array
          uniqueItems: false
      type: object
    types.SidecarInstanceItemResponse:
      properties:
        active_connections:
          description: Number of active connections the sidecar has
          example: 4
          type: integer
        checkin_time:
          description: Unix timestamp in milliseconds since epoch of the time that the server processed the telemetry data
          example: 1752074610981
          type: integer
        instance_id:
          description: UUID of the instance that the sidecar is running on
          example: b55f7214-191b-47df-adf1-9b004fd98e39
          type: string
        sidecar_id:
          description: UUID of the sidecar that sent the telemetry data
          example: 344d9ceb-b23e-400f-b1e4-3887ef4e715a
          type: string
        sidecar_version:
          description: 'Version of the sidecar sending the telemetry data as defined by semver.org Ex: "1.0.0", "2.3.4-beta", etc.'
          example: 1.2.3
          type: string
        tags:
          additionalProperties:
            type: string
          description: Tags associated with this instance
          type: object
      type: object
  securitySchemes:
    basic:
      scheme: basic
      type: http
externalDocs:
  description: ALTR Documentation
  url: https://docs.altr.com/?lang=en