BigID Scans API
Configure and execute BigID scans. Create scan profiles to control which data sources are scanned and using which classifier template, then start and monitor scan executions and parent-scan rollups.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/bigid-scans-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 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.
OpenAPI Specification
openapi: 3.2.0
info:
title: BigID Authentication Actionable Insights Scans 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: Scans
description: Execute and monitor scans.
paths:
/scans:
get:
tags:
- Scans
operationId: listScans
summary: List Scans
description: Retrieve a list of scan executions.
security:
- BearerAuth: []
responses:
'200':
description: Scans retrieved.
content:
application/json:
schema:
type: object
post:
tags:
- Scans
operationId: startScan
summary: Start A Scan
description: Trigger a scan based on a scan profile.
security:
- BearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
scanProfileId:
type: string
responses:
'202':
description: Scan started.
/scans/parent-scans:
get:
tags:
- Scans
operationId: listParentScans
summary: List Parent Scans
description: Retrieve parent scans with customizable query parameters.
security:
- BearerAuth: []
parameters:
- name: sort
in: query
schema:
type: string
- name: limit
in: query
schema:
type: integer
responses:
'200':
description: Parent scans retrieved.
content:
application/json:
schema:
type: object
/scans/{scan_id}/status:
get:
tags:
- Scans
operationId: getScanStatus
summary: Get Scan Status
description: Check the current status of a specific scan to determine whether it is running or completed.
security:
- BearerAuth: []
parameters:
- name: scan_id
in: path
required: true
schema:
type: string
responses:
'200':
description: Scan status retrieved.
content:
application/json:
schema:
type: object
properties:
status:
type: string
progress:
type: number
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT