BigID

BigID Data Sources API

Programmatically manage data source connections in BigID. List, create, test, and export data sources, and inspect the catalog of available connector templates (e.g. rdb-mysql, s3-v2, snowflake, sharepoint-online).

GitHub OpenAPI

Operations 4

GET /ds-connections List Data Sources #
POST /ds_connections Create A Data Source #
POST /ds-connection-test Test A Data Source Connection #
GET /ds-connections/file-download/export Export Data Sources #

Documentation

📖
Documentation
https://developer.bigid.com/api/data-source-connections-api-tutorial/
📖
Documentation
https://developer.bigid.com/api/bigid-api-add-data-source-tutorial/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/bigid/openapi/bigid-data-sources-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/bigid/json-schema/bigid-data-source-schema.json

Other Resources

🔗
Examples
https://artifacts.apis.io/bigid/examples/bigid-list-data-sources-example.json

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/bigid:bigid-data-sources-api"
All apis 
curl "https://apis.io/api/v1/apis?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.

GitHub Google LinkedIn

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

OpenAPI Specification

bigid-data-sources-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: BigID Authentication Actionable Insights Data Sources API
  description: Authenticate against a BigID deployment using either user credentials (username/password) or a long-lived user token. Exchange a user token for a short-lived system token (session token) used to authorize subsequent calls against the BigID REST API.
  version: '1.0'
  contact:
    name: BigID Support
    url: https://developer.bigid.com/
    email: support@bigid.com
  license:
    name: BigID Terms of Service
    url: https://bigid.com/terms/
servers:
- url: https://sandbox.bigid.tools/api/v1
  description: BigID developer sandbox.
- url: https://{deployment}.bigid.com/api/v1
  description: Customer-hosted BigID deployment.
  variables:
    deployment:
      default: tenant
      description: Tenant subdomain assigned by BigID.
tags:
- name: Data Sources
  description: Manage data source connections.
paths:
  /ds-connections:
    get:
      tags:
      - Data Sources
      operationId: listDataSources
      summary: List Data Sources
      description: Retrieve all configured data sources for the BigID deployment.
      security:
      - BearerAuth: []
      responses:
        '200':
          description: Data sources retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourceList'
  /ds_connections:
    post:
      tags:
      - Data Sources
      operationId: createDataSource
      summary: Create A Data Source
      description: Create a new data source connection in BigID.
      security:
      - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSource'
      responses:
        '201':
          description: Data source created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSource'
  /ds-connection-test:
    post:
      tags:
      - Data Sources
      operationId: testDataSourceConnection
      summary: Test A Data Source Connection
      description: Validate connectivity to a data source using a candidate configuration before persisting the connection. Returns the test result and any error details.
      security:
      - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSource'
      responses:
        '200':
          description: Connection test executed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
  /ds-connections/file-download/export:
    get:
      tags:
      - Data Sources
      operationId: exportDataSources
      summary: Export Data Sources
      description: Export the configured data sources for the deployment as a JSON file.
      security:
      - BearerAuth: []
      responses:
        '200':
          description: Data sources exported.
          content:
            application/json:
              schema:
                type: object
components:
  schemas:
    DataSource:
      type: object
      properties:
        name:
          type: string
          description: Display name for the data source.
          example: my-mysql-database
        type:
          type: string
          description: Connector template type (e.g. rdb-mysql, s3-v2, snowflake).
        location:
          type: string
          description: Hostname or URI of the data source.
        username:
          type: string
        password:
          type: string
        scope:
          type: string
          description: Optional scope restricting which schemas/tables/objects to scan.
        enabled:
          type: string
          enum:
          - 'yes'
          - 'no'
        scanner_group:
          type: string
          description: Scanner group that should perform scans for this source.
    DataSourceList:
      type: object
      properties:
        status:
          type: string
        statusCode:
          type: integer
        data:
          type: object
          properties:
            ds_connections:
              type: array
              items:
                $ref: '#/components/schemas/DataSource'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT