Pandium Runs API

openapi: 3.2.0
info:
  title: Pandium Connector Calls Runs 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: Runs
  description: View run status and trigger syncs.
paths:
  /v2/tenants/{tenant_id}/sync:
    post:
      operationId: triggerTenantSync
      summary: Pandium Trigger a sync for a tenant
      description: Request a sync for an existing tenant. Pandium debounces triggers to prevent more than one sync
        per tenant at any given time.
      tags:
      - Runs
      parameters:
      - $ref: '#/components/parameters/TenantId'
      - name: mode
        in: query
        description: The sync mode to use.
        required: true
        schema:
          type: string
          enum:
          - init
          - normal
      responses:
        '200':
          description: Sync triggered successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TriggerResponse'
        '401':
          description: Unauthorized. Invalid or missing API key.
        '404':
          description: Tenant not found.
  /v2/tenants/{tenant_id}/runs:
    get:
      operationId: listTenantRuns
      summary: Pandium List runs for a tenant
      description: Get runs for a specific tenant.
      tags:
      - Runs
      parameters:
      - $ref: '#/components/parameters/TenantId'
      - 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 runs for the tenant.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Run'
        '401':
          description: Unauthorized. Invalid or missing API key.
        '404':
          description: Tenant not found.
  /v2/runs/triggers/{trigger_id}/status:
    get:
      tags:
      - Runs
      summary: Get Run Status From Trigger
      description: Returns status information for a run associated with the provided trigger id, _if that run exists_.
        Triggers are are debounced, so run status information may not be immediately available. If no status information
        is yet available, this endpoint will return a 404.
      operationId: get_run_status_from_trigger_v2_runs_triggers__trigger_id__status_get
      parameters:
      - name: trigger_id
        in: path
        required: true
        schema:
          type: string
          description: Returned from Pandium after a sync request in the response payload
          title: Trigger Id
        description: Returned from Pandium after a sync request in the response payload
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TriggerStatus'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v2/runs/{run_id}/log:
    get:
      tags:
      - Runs
      summary: Get Run Log
      description: Redirects to a signed GCS URL to download the log for a run. The URL expires in 15 minutes.
      operationId: get_run_log_v2_runs__run_id__log_get
      parameters:
      - name: run_id
        in: path
        required: true
        schema:
          type: integer
          description: The ID of the run
          title: Run Id
        description: The ID of the run
      responses:
        '302':
          description: Redirect to signed GCS URL for log download
          content:
            application/json:
              schema: {}
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v2/integrations/{integration_id}/sync:
    post:
      summary: Sync By Integration Id
      description: 'Request a sync for an existing tenant based on an integration ID and a user name.

        For this to work, the user must have installed the integration via the [Pandium

        In-App Marketplace](https://docs.pandium.com/quick-start/marketplaces), which creates a tenant associated
        with that user''s username. To sync a tenant created in the Pandium Integration Hub, use the sync by tenant
        id endpoint.'
      operationId: sync_by_integration_id_v2_integrations__integration_id__sync_post
      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
      - name: mode
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/V2RunMode'
          description: must be one of 'init' or 'normal'
        description: must be one of 'init' or 'normal'
      - name: user_name
        in: query
        required: true
        schema:
          type: string
          description: must correspond to the user id sent from your system to the Pandium In-App Marketplace when
            the user installed this integration
          title: User Name
        description: must correspond to the user id sent from your system to the Pandium In-App Marketplace when
          the user installed this integration
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - type: object
                additionalProperties: true
              - type: 'null'
              description: fields determined by the integration
              title: Body
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Trigger'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Unprocessable Content
      tags:
      - Runs
components:
  parameters:
    TenantId:
      name: tenant_id
      in: path
      description: The unique identifier of the tenant.
      required: true
      schema:
        type: integer
    TriggerId:
      name: trigger_id
      in: path
      description: The trigger ID associated with a run.
      required: true
      schema:
        type: string
  schemas:
    Run:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for the run.
        tenant_id:
          type: integer
          description: ID of the tenant this run belongs to.
        trigger_id:
          type: string
          description: The trigger ID associated with this run.
        status:
          type: string
          description: Current status of the run.
          enum:
          - pending
          - running
          - completed
          - failed
        mode:
          type: string
          description: The mode the run was triggered with.
          enum:
          - cron
          - manual
          - webhook
          - api
        created_date:
          type: string
          format: date-time
          description: Date and time the run was created.
        modified_date:
          type: string
          format: date-time
          description: Date and time the run was last modified.
        started_date:
          type: string
          format: date-time
          description: Date and time the run started executing.
        completed_date:
          type: string
          format: date-time
          description: Date and time the run completed.
    TriggerResponse:
      type: object
      properties:
        trigger_id:
          type: string
          description: The trigger ID that can be used to check the status of the triggered run.
    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
    TriggerStatus:
      properties:
        status:
          type: string
          title: Status
      type: object
      required:
      - status
      title: TriggerStatus
    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
    Trigger:
      properties:
        trigger_id:
          type: string
          title: Trigger Id
      type: object
      required:
      - trigger_id
      title: Trigger
    V2RunMode:
      type: string
      enum:
      - init
      - normal
      title: V2RunMode
  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'