Pandium

opencollection: 1.0.0
info:
  name: Pandium API
  version: 2.0.0
request:
  auth:
    type: apikey
    key: Authorization
    value: '{{Authorization}}'
    placement: header
items:
- info:
    name: Integrations
    type: folder
  items:
  - info:
      name: Pandium List all integrations
      type: http
    http:
      method: GET
      url: https://api.pandium.io/v2/integrations
      params:
      - name: skip
        value: ''
        type: query
        description: Number of records to skip for pagination.
      - name: limit
        value: ''
        type: query
        description: Maximum number of records to return.
    docs: Get all your integrations on Pandium.
  - info:
      name: Pandium Get a single integration
      type: http
    http:
      method: GET
      url: https://api.pandium.io/v2/integrations/:integration_id
      params:
      - name: integration_id
        value: ''
        type: path
        description: The unique identifier of the integration.
    docs: Retrieve a single integration by its ID.
  - info:
      name: Pandium List releases for an integration
      type: http
    http:
      method: GET
      url: https://api.pandium.io/v2/integrations/:integration_id/releases
      params:
      - name: integration_id
        value: ''
        type: path
        description: The unique identifier of the integration.
    docs: Get all releases for a specific integration.
  - info:
      name: Pandium Get a single release
      type: http
    http:
      method: GET
      url: https://api.pandium.io/v2/integrations/:integration_id/releases/:release_id
      params:
      - name: integration_id
        value: ''
        type: path
        description: The unique identifier of the integration.
      - name: release_id
        value: ''
        type: path
        description: The unique identifier of the release.
    docs: Get a single release for a specific integration.
- info:
    name: Tenants
    type: folder
  items:
  - info:
      name: Pandium List all tenants
      type: http
    http:
      method: GET
      url: https://api.pandium.io/v2/tenants
      params:
      - name: skip
        value: ''
        type: query
        description: Number of records to skip for pagination.
      - name: limit
        value: ''
        type: query
        description: Maximum number of records to return.
      - name: integration_id
        value: ''
        type: query
        description: Filter tenants by integration ID.
    docs: Get all your tenants on Pandium.
  - info:
      name: Pandium Create a tenant
      type: http
    http:
      method: POST
      url: https://api.pandium.io/v2/tenants
      body:
        type: json
        data: '{}'
    docs: Create a new, unconnected tenant. The tenant will be paused. If no schedule or release is provided, integration
      defaults will apply.
  - info:
      name: Pandium Get a single tenant
      type: http
    http:
      method: GET
      url: https://api.pandium.io/v2/tenants/:tenant_id
      params:
      - name: tenant_id
        value: ''
        type: path
        description: The unique identifier of the tenant.
    docs: Retrieve a single tenant by its ID.
  - info:
      name: Pandium Update a tenant
      type: http
    http:
      method: PATCH
      url: https://api.pandium.io/v2/tenants/:tenant_id
      params:
      - name: tenant_id
        value: ''
        type: path
        description: The unique identifier of the tenant.
      body:
        type: json
        data: '{}'
    docs: Update properties of an existing tenant such as name, configs, paused status, archived status, and user_schedule.
- info:
    name: Runs
    type: folder
  items:
  - info:
      name: Pandium Trigger a sync for a tenant
      type: http
    http:
      method: POST
      url: https://api.pandium.io/v2/tenants/:tenant_id/sync
      params:
      - name: tenant_id
        value: ''
        type: path
        description: The unique identifier of the tenant.
      - name: mode
        value: ''
        type: query
        description: The sync mode to use.
    docs: Request a sync for an existing tenant. Pandium debounces triggers to prevent more than one sync per tenant at any
      given time.
  - info:
      name: Pandium List runs for a tenant
      type: http
    http:
      method: GET
      url: https://api.pandium.io/v2/tenants/:tenant_id/runs
      params:
      - name: tenant_id
        value: ''
        type: path
        description: The unique identifier of the tenant.
      - name: skip
        value: ''
        type: query
        description: Number of records to skip for pagination.
      - name: limit
        value: ''
        type: query
        description: Maximum number of records to return.
    docs: Get runs for a specific tenant.
  - info:
      name: Pandium Get run status by trigger ID
      type: http
    http:
      method: GET
      url: https://api.pandium.io/v2/tenants/:tenant_id/runs/:trigger_id
      params:
      - name: tenant_id
        value: ''
        type: path
        description: The unique identifier of the tenant.
      - name: trigger_id
        value: ''
        type: path
        description: The trigger ID associated with a run.
    docs: Returns status information for a run associated with the provided trigger ID, if that run exists. Since triggers
      are debounced, run status information may not be immediately available.
- info:
    name: Connector Calls
    type: folder
  items:
  - info:
      name: Pandium Proxy a connector call
      type: http
    http:
      method: POST
      url: https://api.pandium.io/v2/tenants/:tenant_id/connectors/:connector_name/call
      params:
      - name: tenant_id
        value: ''
        type: path
        description: The unique identifier of the tenant.
      - name: connector_name
        value: ''
        type: path
        description: The name of the connector to call through.
      body:
        type: json
        data: '{}'
    docs: Make a call to an external API (REST, SOAP, or XML) on behalf of a tenant. This endpoint proxies a synchronous connector
      call using the tenant's stored credentials.
- info:
    name: Tenant Metadata
    type: folder
  items:
  - info:
      name: Pandium Get tenant metadata
      type: http
    http:
      method: GET
      url: https://api.pandium.io/v2/tenants/:tenant_id/metadata
      params:
      - name: tenant_id
        value: ''
        type: path
        description: The unique identifier of the tenant.
    docs: Get the metadata for a tenant.
  - info:
      name: Pandium Update tenant metadata
      type: http
    http:
      method: PATCH
      url: https://api.pandium.io/v2/tenants/:tenant_id/metadata
      params:
      - name: tenant_id
        value: ''
        type: path
        description: The unique identifier of the tenant.
      body:
        type: json
        data: '{}'
    docs: Update metadata for a tenant. Metadata is validated against the tenant's integration release metadata schema.
bundled: true