PipesHub · Schema

UpdateConnectorConfigRequest

Request to update connector configuration (partial updates supported)

CompanyArtificial IntelligenceEnterprise SearchAI AgentsOpen SourceKnowledge ManagementWorkplace AI

Properties

Name Type Description
auth object
sync object
filters object
baseUrl string Base URL for self-hosted instances
View JSON Schema on GitHub

JSON Schema

pipeshub-update-connector-config-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/pipeshub/json-schema/pipeshub-update-connector-config-request-schema.json",
  "title": "UpdateConnectorConfigRequest",
  "description": "Request to update connector configuration (partial updates supported)",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/pipeshub-connector-configuration-api-openapi.yml#/components/schemas/UpdateConnectorConfigRequest",
  "type": "object",
  "properties": {
    "auth": {
      "$ref": "#/$defs/ConnectorAuthConfig"
    },
    "sync": {
      "$ref": "#/$defs/ConnectorSyncConfig"
    },
    "filters": {
      "$ref": "#/$defs/ConnectorFiltersConfig"
    },
    "baseUrl": {
      "type": "string",
      "description": "Base URL for self-hosted instances",
      "format": "uri"
    }
  },
  "$defs": {
    "ConnectorAuthConfig": {
      "type": "object",
      "description": "Authentication configuration for a connector instance",
      "properties": {
        "values": {
          "type": "object",
          "description": "Authentication values (keys depend on connector's auth schema)",
          "additionalProperties": true
        },
        "oauthConfigId": {
          "type": "string",
          "description": "ID of admin-created OAuth configuration to use"
        },
        "customValues": {
          "type": "object",
          "description": "Custom authentication values specific to the connector",
          "additionalProperties": true
        }
      }
    },
    "ConnectorFiltersConfig": {
      "type": "object",
      "description": "Filter configuration to control what data is synced (sync filters and indexing filters)",
      "properties": {
        "sync": {
          "type": "object",
          "description": "Sync filter selections",
          "properties": {
            "values": {
              "type": "object",
              "description": "Selected filter values (keys are filter field names)",
              "additionalProperties": true
            }
          }
        },
        "indexing": {
          "type": "object",
          "description": "Indexing filter selections",
          "properties": {
            "values": {
              "type": "object",
              "additionalProperties": true
            }
          }
        }
      }
    },
    "ConnectorSyncConfig": {
      "type": "object",
      "description": "Synchronization configuration for a connector instance",
      "properties": {
        "selectedStrategy": {
          "type": "string",
          "enum": [
            "MANUAL",
            "SCHEDULED",
            "WEBHOOK",
            "REALTIME"
          ],
          "description": "Sync strategy: MANUAL (user-triggered), SCHEDULED (interval/cron), WEBHOOK (event-driven), REALTIME (WebSocket)",
          "default": "MANUAL"
        },
        "scheduledConfig": {
          "type": "object",
          "description": "Configuration for scheduled sync strategy",
          "properties": {
            "intervalMinutes": {
              "type": "integer",
              "description": "Sync interval in minutes",
              "minimum": 5,
              "default": 60
            },
            "cronExpression": {
              "type": "string",
              "description": "Cron expression for advanced scheduling"
            },
            "timezone": {
              "type": "string",
              "description": "Timezone for scheduled sync",
              "default": "UTC"
            }
          }
        },
        "webhookConfig": {
          "type": "object",
          "description": "Configuration for webhook-based sync",
          "properties": {
            "webhookUrl": {
              "type": "string",
              "description": "URL to receive webhook events (auto-generated)"
            },
            "events": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Subscribed event types"
            }
          }
        },
        "values": {
          "type": "object",
          "description": "Sync setting values specific to the connector",
          "additionalProperties": true
        },
        "customValues": {
          "type": "object",
          "description": "Custom sync values",
          "additionalProperties": true
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/pipeshub-update-connector-config-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.