BigID

BigID Scan Profiles API

Configure recurring scan profiles.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.bigid.com/api/bigid-api-metadata-export-tutorial/
📖
Documentation
https://developer.bigid.com/api/bigid-api-duplicate-data-tutorial/
📖
Documentation
https://developer.bigid.com/api/cluster-analysis-api-tutorial/
📖
Documentation
https://developer.bigid.com/api/data-posture-api-tutorial/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bigid/refs/heads/main/openapi/bigid-scan-profiles-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/bigid/refs/heads/main/json-schema/bigid-catalog-object-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/bigid/refs/heads/main/json-schema/bigid-case-schema.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/bigid/refs/heads/main/examples/bigid-list-posture-cases-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-scan-profiles-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

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

OpenAPI Specification

bigid-scan-profiles-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: BigID Authentication Actionable Insights Scan Profiles 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: Scan Profiles
  description: Configure recurring scan profiles.
paths:
  /scanProfiles:
    post:
      tags:
      - Scan Profiles
      operationId: createScanProfile
      summary: Create A Scan Profile
      description: Create a new scan profile that controls which data sources are scanned and using which template.
      security:
      - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScanProfile'
      responses:
        '201':
          description: Scan profile created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanProfile'
  /scanProfiles/{id}:
    get:
      tags:
      - Scan Profiles
      operationId: getScanProfile
      summary: Get A Scan Profile
      description: Retrieve the details of a scan profile by its identifier.
      security:
      - BearerAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Scan profile retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanProfile'
components:
  schemas:
    ScanProfile:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        dataSourceList:
          type: array
          items:
            type: string
        scanTemplateId:
          type: string
        active:
          type: boolean
        isCustomScanProfile:
          type: boolean
        schedule:
          type: object
          properties:
            cronExpression:
              type: string
            timeZone:
              type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT