Pandium Integrations API

openapi: 3.2.0
info:
  title: Pandium Connector Calls Integrations API
  description: The Pandium API provides programmatic access to native Pandium resources including integrations,
    tenants, and runs. It uses standard REST conventions and HTTP methods, allowing B2B SaaS companies to manage
    their integration platform, trigger syncs, proxy connector calls, and manage tenant metadata.
  version: 2.0.0
  contact:
    name: Pandium
    url: https://www.pandium.com/
  license:
    name: Proprietary
    url: https://www.pandium.com/terms-and-conditions
  termsOfService: https://www.pandium.com/terms-and-conditions
servers:
- url: https://api.pandium.io
  description: Production
- url: https://api.sandbox.pandium.com
  description: Sandbox
security:
- apiKey: []
tags:
- name: Integrations
  description: Manage integrations on the Pandium platform.
paths:
  /v2/integrations:
    get:
      operationId: listIntegrations
      summary: Pandium List all integrations
      description: Get all your integrations on Pandium.
      tags:
      - Integrations
      parameters:
      - name: skip
        in: query
        description: Number of records to skip for pagination.
        required: false
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: Maximum number of records to return.
        required: false
        schema:
          type: integer
          default: 50
      responses:
        '200':
          description: A list of integrations.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Integration'
        '401':
          description: Unauthorized. Invalid or missing API key.
  /v2/integrations/{integration_id}:
    get:
      operationId: getIntegration
      summary: Pandium Get a single integration
      description: Retrieve a single integration by its ID.
      tags:
      - Integrations
      parameters:
      - $ref: '#/components/parameters/IntegrationId'
      responses:
        '200':
          description: The requested integration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Integration'
        '401':
          description: Unauthorized. Invalid or missing API key.
        '404':
          description: Integration not found.
  /v2/integrations/{integration_id}/releases:
    get:
      operationId: listIntegrationReleases
      summary: Pandium List releases for an integration
      description: Get all releases for a specific integration.
      tags:
      - Integrations
      parameters:
      - $ref: '#/components/parameters/IntegrationId'
      responses:
        '200':
          description: A list of releases for the integration.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Release'
        '401':
          description: Unauthorized. Invalid or missing API key.
        '404':
          description: Integration not found.
  /v2/integrations/{integration_id}/releases/{release_id}:
    get:
      operationId: getIntegrationRelease
      summary: Pandium Get a single release
      description: Get a single release for a specific integration.
      tags:
      - Integrations
      parameters:
      - $ref: '#/components/parameters/IntegrationId'
      - $ref: '#/components/parameters/ReleaseId'
      responses:
        '200':
          description: The requested release.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Release'
        '401':
          description: Unauthorized. Invalid or missing API key.
        '404':
          description: Release not found.
  /v2/integrations/{integration_id}/releases/default:
    get:
      summary: Get Default Integration Release
      description: Get the default release for an integration
      operationId: get_default_integration_release_v2_integrations__integration_id__releases_default_get
      parameters:
      - name: integration_id
        in: path
        required: true
        schema:
          type: integer
          description: Unique identifier for an integration
          title: Integration Id
        description: Unique identifier for an integration
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/external_api_v1__v2schemas__IntegrationRelease'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Integrations
  /v2/integrations/{integration_id}/releases/latest:
    get:
      summary: Get Latest Release
      description: Get the latest release for an Integration
      operationId: get_latest_release_v2_integrations__integration_id__releases_latest_get
      parameters:
      - name: integration_id
        in: path
        required: true
        schema:
          type: string
          description: Unique identifier for an id
          title: Integration Id
        description: Unique identifier for an id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/external_api_v1__v2schemas__IntegrationRelease'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Integrations
components:
  parameters:
    IntegrationId:
      name: integration_id
      in: path
      description: The unique identifier of the integration.
      required: true
      schema:
        type: integer
    ReleaseId:
      name: release_id
      in: path
      description: The unique identifier of the release.
      required: true
      schema:
        type: integer
  schemas:
    Integration:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for the integration.
        name:
          type: string
          description: Name of the integration.
        archived:
          type: boolean
          description: Whether the integration is archived.
        created_date:
          type: string
          format: date-time
          description: Date and time the integration was created.
        modified_date:
          type: string
          format: date-time
          description: Date and time the integration was last modified.
    Release:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for the release.
        integration_id:
          type: integer
          description: ID of the integration this release belongs to.
        version:
          type: string
          description: Version label of the release.
        created_date:
          type: string
          format: date-time
          description: Date and time the release was created.
        modified_date:
          type: string
          format: date-time
          description: Date and time the release was last modified.
    ErrorMessage:
      properties:
        message:
          type: string
          title: Message
      type: object
      required:
      - message
      title: ErrorMessage
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    external_api_v1__v2schemas__IntegrationRelease:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        repository_tracking_branch:
          anyOf:
          - type: string
          - type: 'null'
          title: Repository Tracking Branch
        run_command:
          anyOf:
          - type: string
          - type: 'null'
          title: Run Command
        tag:
          anyOf:
          - type: string
          - type: 'null'
          title: Tag
        config_schema:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Config Schema
        config_version:
          type: string
          title: Config Version
        metadata_schema:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Metadata Schema
        created_date:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created Date
        modified_date:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Modified Date
      type: object
      required:
      - id
      - name
      - config_version
      title: IntegrationRelease
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
      description: 'API key generated from the Settings sidebar in the Pandium Integration Hub under the API Access
        tab. Attach it to requests in the X-API-KEY header. Source: https://docs.pandium.com/reference/pandium-api'