PipesHub · Schema

ConnectorConfig

Configuration for a connector instance including auth, sync, and filter settings

CompanyArtificial IntelligenceEnterprise SearchAI AgentsOpen SourceKnowledge ManagementWorkplace AI

Properties

Name Type Description
connectorId string Connector instance ID
connectorType string Connector type
instanceName string Instance name
authType object
scope object
config object Configuration sections
baseUrl string Base URL for self-hosted instances
isActive boolean
isConfigured boolean
isAuthenticated boolean
View JSON Schema on GitHub

JSON Schema

pipeshub-connector-config-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/pipeshub/json-schema/pipeshub-connector-config-schema.json",
  "title": "ConnectorConfig",
  "description": "Configuration for a connector instance including auth, sync, and filter settings",
  "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/ConnectorConfig",
  "type": "object",
  "properties": {
    "connectorId": {
      "type": "string",
      "description": "Connector instance ID"
    },
    "connectorType": {
      "type": "string",
      "description": "Connector type"
    },
    "instanceName": {
      "type": "string",
      "description": "Instance name"
    },
    "authType": {
      "$ref": "#/$defs/ConnectorAuthType"
    },
    "scope": {
      "$ref": "#/$defs/ConnectorScope"
    },
    "config": {
      "type": "object",
      "description": "Configuration sections",
      "properties": {
        "auth": {
          "type": "object",
          "description": "Authentication configuration (sensitive data redacted)"
        },
        "sync": {
          "type": "object",
          "description": "Sync configuration (schedule, options)"
        },
        "filters": {
          "type": "object",
          "description": "Filter selections for data scope"
        }
      }
    },
    "baseUrl": {
      "type": "string",
      "description": "Base URL for self-hosted instances"
    },
    "isActive": {
      "type": "boolean"
    },
    "isConfigured": {
      "type": "boolean"
    },
    "isAuthenticated": {
      "type": "boolean"
    }
  },
  "$defs": {
    "ConnectorAuthType": {
      "type": "string",
      "description": "Authentication method required by the connector:<br>\n<ul>\n<li><code>OAUTH</code> - User OAuth consent flow</li>\n<li><code>OAUTH_ADMIN_CONSENT</code> - Admin OAuth with org-wide consent</li>\n<li><code>API_TOKEN</code> - API key or token authentication</li>\n<li><code>USERNAME_PASSWORD</code> - Username/password credentials</li>\n<li><code>NONE</code> - No authentication required</li>\n</ul>\n",
      "enum": [
        "OAUTH",
        "OAUTH_ADMIN_CONSENT",
        "API_TOKEN",
        "USERNAME_PASSWORD",
        "NONE"
      ]
    },
    "ConnectorScope": {
      "type": "string",
      "description": "Scope determines visibility and access control for connectors:<br>\n<ul>\n<li><code>team</code> - Available to all users in the organization (admin-only creation)</li>\n<li><code>personal</code> - Private to the creating user only</li>\n</ul>\n",
      "enum": [
        "team",
        "personal"
      ]
    }
  }
}

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-connector-config"
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.