How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Bigeye

Bigeye Scan Job Service API

The ScanJobService API from Bigeye — 12 operation(s) for scanjobservice.

Documentation Provider Profile APIs.io OpenAPI GitHub

Bigeye Scan Job Service API is one of 45 APIs that Bigeye publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ScanJobService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 14 operations across 12 paths, and defines 56 schemas. It is described by OpenAPI 3.2.0, at version version not set.

Requests are made against a single base URL, https://app.bigeye.com.

14 operations 12 paths 56 schemas 1 DELETE2 GET7 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
version not set
Base URL
https://app.bigeye.com
Authentication
HTTP Basic, API Key, API Key
Resource Areas
1

Authentication & Security 3

Bigeye Scan Job Service API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as Authorization (Agent_API_Key). An API key is passed in the header as Authorization (Personal_API_Key). By default, every request must be authenticated.

  • Agent_API_Key — Add 'apikey ' to the beginning of your api key
  • Personal_API_Key — Add 'apikey ' to the beginning of your api key

Paths & Operations 14

Across 12 paths, the API surfaces 14 operations — 1 DELETE, 2 GET, 7 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

ScanJobService 14
POST
/api/v1/sds/scan-job/{id}/cancel
Cancel a running scan job
ScanJobService_CancelScanJob 1 param → 200default
POST
/api/v1/sds/scan-job
Create a scan job
ScanJobService_CreateScanJob body → 200default
POST
/api/v1/sds/scan-job/fetch
Fetch scan jobs with filters and pagination
ScanJobService_FetchScanJobs body → 200default
POST
/api/v1/sds/scan-job/findings/aggregate
Get aggregate findings for a scan job
ScanJobService_GetAggregateFindings body → 200default
DELETE
/api/v1/sds/scan-job/{id}
Delete a scan job
ScanJobService_DeleteScanJob 1 param → 200default
GET
/api/v1/sds/scan-job/{id}
Get a scan job by ID
ScanJobService_GetScanJob 1 param → 200default
PUT
/api/v1/sds/scan-job/{id}
Update a scan job
ScanJobService_UpdateScanJob 1 param body → 200default
GET
/api/v1/sds/scan-job/{id}/status
Get the status of a scan job
ScanJobService_GetScanJobStatus 1 param → 200default
POST
/api/v1/sds/scan-job/findings/snapshot
Get snapshot findings for a scan job
ScanJobService_GetSnapshotFindings body → 200default
PUT
/api/v1/sds/scan-job/reset-scan
Reset scan data for specific tables in a scan job
ScanJobService_ResetScan body → 200default
PUT
/api/v1/sds/scan-job/{id}/retry
Retry a failed scan job
ScanJobService_RetryScanJob 1 param → 200default
POST
/api/v1/sds/scan-job/{id}/run
Run a scan job
ScanJobService_RunScanJob 1 param → 200default
PUT
/api/v1/sds/scan-job/{id}/partition-columns
Set partition columns for a scan job
ScanJobService_SetPartitionColumns 1 param body → 200default
POST
/api/v1/sds/scan-job/{id}/terminate
Terminate a running scan job
ScanJobService_TerminateScanJob 1 param body → 200default

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are generatedScanFinding (23 properties), generatedScanJob (19 properties), generatedGetScanJobListRequest (18 properties), generatedGetScanFindingsRequest (17 properties). Each schema is shown below with its type and property counts.

generatedSlackChannelInfo
object
4 properties
generatedCreateOrUpdateScanJobRequest
object
11 properties
generatedEmpty
object
generatedExternalTicketProvider
string
generatedSetPartitionColumnRequest
object
1 property
generatedScanJobStatus
string
generatedSortDirection
string
generatedUser
object
8 properties
generatedDataClass
object
12 properties
generatedTimeIntervalType
string
generatedTimeInterval
object
2 properties
generatedScanType
string
generatedResetScanRequest
object
1 property
generatedGetScanFindingsRequest
object
17 properties
generatedScanRun
object
14 properties
generatedScanFindingChunkInfo
object
7 properties
generatedScanScheduleFrequency
object
4 properties
generatedBulkSetPartitionColumnsResponse
object
2 properties
generatedBulkResetScanResponse
object
2 properties
generatedDataSensitivity
string
generatedNamedSchedule
object
5 properties
generatedScanSchedule
object
2 properties
generatedScanJobSortField
string
generatedPaginationInfo
object
5 properties
generatedBulkSetPartitionColumnsRequest
object
1 property
generatedScanJob
object
19 properties
generatedGetScanJobListRequest
object
18 properties
generatedGetScanFindingsResponse
object
2 properties
generatedScanFinding
object
23 properties
generatedGetScanJobListResponse
object
2 properties
protobufAny
object
2 properties
generatedEntityInfo
object
4 properties
generatedWebhookHeader
object
2 properties
generatedScanJobSortOption
object
2 properties
generatedSetPartitionColumnFailure
object
2 properties
generatedWarehouse
object
3 properties
generatedThreeLeggedBoolean
string
We need this for isMuted filters as unspecified == no filter, but the generated typescript file is setting null to false so there is no way for the receiver to…
generatedWorkflowV2StatusResponse
object
5 properties
generatedDataClassCategory
object
4 properties
generatedTerminateScanJobRequest
object
1 property
generatedIssueExternalTicketInfo
object
4 properties
generatedSplitFailure
object
2 properties
generatedWorkflowV2Id
object
2 properties
generatedTableToScan
object
9 properties
generatedWebhook
object
2 properties
generatedResetScanFailure
object
2 properties
generatedWarehouseType
string
generatedScanFindingSortField
string
generatedBulkResetScanRequest
object
3 properties
generatedWorkflowProcessingStatus
string
generatedIdAndDisplayName
object
2 properties
generatedResetScanAction
string
runtimeError
object
4 properties
generatedScanFindingSortOption
object
2 properties
generatedTableType
string
generatedNotificationChannel
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bigeye-scanjobservice-api-openapi.yml Raw ↑

Other APIs Bigeye publishes across the network.

Bigeye MCP Gateway
AE Profile APIs.io
Bigeye Agent Service API
AE Profile APIs.io
Bigeye API Key Service API
AE Profile APIs.io
Bigeye Catalog Rebuilds Service API
AE Profile APIs.io
Bigeye Classifier Service API
AE Profile APIs.io
Bigeye Collection Service API
AE Profile APIs.io
Bigeye Collection V2 Service API
AE Profile APIs.io
Bigeye Column Service API
AE Profile APIs.io
Bigeye Company Service API
AE Profile APIs.io
Bigeye Comparison Table Service API
AE Profile APIs.io
Bigeye Config Service API
AE Profile APIs.io
Bigeye Custom Rule Service API
AE Profile APIs.io
#ScanJobService
← Back to B APIs
API Details
ID
bigeye:bigeye-scanjobservice-api
Base URL
https://app.bigeye.com
Docs
https://docs.bigeye.com/reference
Provider
Bigeye
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=bigeye-scanjobservice-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/bigeye-scanjobservice-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Bigeye Scan Job Service API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.