Bigeye

Bigeye Data Class Service API

The DataClassService API from Bigeye — 4 operation(s) for dataclassservice.

GitHub OpenAPI

Operations 6

POST /api/v1/sds/data-class Create a data class #
POST /api/v1/sds/data-class/fetch Fetch data classes with filters and pagination #
DELETE /api/v1/sds/data-class/{id} Delete a data class #
GET /api/v1/sds/data-class/{id} Get a data class by ID #
PUT /api/v1/sds/data-class/{id} Update a data class #
PUT /api/v1/sds/data-class/{id}/reset Reset a Bigeye-provided data class to its default state #

Documentation

📖
Documentation
https://docs.bigeye.com/docs/api-user-guide
📖
APIReference
https://docs.bigeye.com/reference
📖
Documentation
https://docs.bigeye.com/docs/monitoring
📖
Documentation
https://docs.bigeye.com/docs/getting-started-scanning

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bigeye/refs/heads/main/openapi/bigeye-dataclassservice-api-openapi.yml

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/bigeye-dataclassservice-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.

GitHub Google LinkedIn

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

OpenAPI Specification

bigeye-dataclassservice-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sensitivity Data Class Service API
  version: version not set
servers:
- url: https://app.bigeye.com
security:
- basicAuth: []
- Personal_API_Key: []
tags:
- name: DataClassService
paths:
  /api/v1/sds/data-class:
    post:
      operationId: DataClassService_CreateDataClass
      requestBody:
        $ref: '#/components/requestBodies/generatedCreateOrUpdateDataClassRequest'
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedDataClass'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Create a data class
      tags:
      - DataClassService
  /api/v1/sds/data-class/fetch:
    post:
      operationId: DataClassService_FetchDataClasses
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generatedGetDataClassListRequest'
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedGetDataClassListResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Fetch data classes with filters and pagination
      tags:
      - DataClassService
  /api/v1/sds/data-class/{id}:
    delete:
      operationId: DataClassService_DeleteDataClass
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: int64
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedEmpty'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Delete a data class
      tags:
      - DataClassService
    get:
      operationId: DataClassService_GetDataClass
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: int64
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedDataClass'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get a data class by ID
      tags:
      - DataClassService
    put:
      operationId: DataClassService_UpdateDataClass
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: int64
      requestBody:
        $ref: '#/components/requestBodies/generatedCreateOrUpdateDataClassRequest'
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedDataClass'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Update a data class
      tags:
      - DataClassService
  /api/v1/sds/data-class/{id}/reset:
    put:
      operationId: DataClassService_ResetDataClass
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: int64
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedDataClass'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Reset a Bigeye-provided data class to its default state
      tags:
      - DataClassService
components:
  schemas:
    generatedSortDirection:
      default: SORT_DIRECTION_UNSPECIFIED
      enum:
      - SORT_DIRECTION_UNSPECIFIED
      - SORT_DIRECTION_ASCENDING
      - SORT_DIRECTION_DESCENDING
      title: Unspecified will default to ASCENDING
      type: string
    generatedEntityInfo:
      properties:
        createdBy:
          format: int32
          type: integer
        createdEpochSeconds:
          format: int64
          type: string
        updatedBy:
          format: int32
          type: integer
        updatedEpochSeconds:
          format: int64
          type: string
      type: object
    generatedDataClass:
      properties:
        canResetToDefault:
          type: boolean
        categories:
          items:
            $ref: '#/components/schemas/generatedDataClassCategory'
          type: array
        colorHex:
          type: string
        createdBy:
          $ref: '#/components/schemas/generatedUser'
        description:
          type: string
        entityInfo:
          $ref: '#/components/schemas/generatedEntityInfo'
        id:
          format: int64
          type: string
        name:
          type: string
        numberOfClassifiers:
          format: int32
          type: integer
        providedByBigeye:
          type: boolean
        sensitivity:
          $ref: '#/components/schemas/generatedDataSensitivity'
        workspaceId:
          format: int32
          type: integer
      type: object
    generatedIdAndDisplayName:
      properties:
        displayName:
          type: string
        id:
          format: int32
          type: integer
      type: object
    generatedEmpty:
      type: object
    generatedDataSensitivity:
      default: DATA_SENSITIVITY_UNSPECIFIED
      enum:
      - DATA_SENSITIVITY_UNSPECIFIED
      - DATA_SENSITIVITY_PUBLIC
      - DATA_SENSITIVITY_INTERNAL
      - DATA_SENSITIVITY_CONFIDENTIAL
      - DATA_SENSITIVITY_RESTRICTED
      type: string
    generatedCreateOrUpdateDataClassRequest:
      properties:
        colorHex:
          type: string
        description:
          type: string
        name:
          type: string
        sensitivity:
          $ref: '#/components/schemas/generatedDataSensitivity'
        workspaceId:
          format: int32
          type: integer
      type: object
    generatedUser:
      properties:
        email:
          type: string
        groups:
          items:
            $ref: '#/components/schemas/generatedIdAndDisplayName'
          type: array
        id:
          format: int32
          type: integer
        idpGroups:
          items:
            type: string
          type: array
        isServiceAccount:
          type: boolean
        lastLoginAt:
          format: int64
          type: string
        name:
          type: string
        pictureUrl:
          type: string
      type: object
    generatedDataClassCategory:
      properties:
        description:
          type: string
        id:
          format: int64
          type: string
        name:
          type: string
        workspaceId:
          format: int32
          type: integer
      type: object
    generatedDataClassSortField:
      default: DATA_CLASS_SORT_FIELD_UNSPECIFIED
      enum:
      - DATA_CLASS_SORT_FIELD_UNSPECIFIED
      - DATA_CLASS_SORT_FIELD_NAME
      - DATA_CLASS_SORT_FIELD_SENSITIVITY
      - DATA_CLASS_SORT_FIELD_CREATOR
      - DATA_CLASS_SORT_FIELD_NUMBER_OF_CLASSIFIERS
      type: string
    generatedGetDataClassListRequest:
      properties:
        classifierIds:
          items:
            format: int64
            type: string
          title: Filter to data classes used by these classifiers
          type: array
        creatorIds:
          items:
            format: int32
            type: integer
          type: array
        dataClassCategoryIds:
          items:
            format: int64
            type: string
          type: array
        pageCursor:
          type: string
        pageSize:
          format: int32
          type: integer
        scanJobIds:
          items:
            format: int64
            type: string
          title: Filter to data classes used by classifiers in these scan jobs
          type: array
        search:
          type: string
        sensitivities:
          items:
            $ref: '#/components/schemas/generatedDataSensitivity'
          type: array
        sortOptions:
          items:
            $ref: '#/components/schemas/generatedDataClassSortOption'
          type: array
        workspaceId:
          format: int32
          type: integer
      type: object
    generatedGetDataClassListResponse:
      properties:
        dataClasses:
          items:
            $ref: '#/components/schemas/generatedDataClass'
          type: array
        paginationInfo:
          $ref: '#/components/schemas/generatedPaginationInfo'
      type: object
    runtimeError:
      properties:
        code:
          format: int32
          type: integer
        details:
          items:
            $ref: '#/components/schemas/protobufAny'
          type: array
        error:
          type: string
        message:
          type: string
      type: object
    generatedDataClassSortOption:
      properties:
        sortDirection:
          $ref: '#/components/schemas/generatedSortDirection'
        sortField:
          $ref: '#/components/schemas/generatedDataClassSortField'
      type: object
    generatedPaginationInfo:
      properties:
        firstSortDistinctValues:
          format: int64
          type: string
        nextCursor:
          type: string
        noNumRecords:
          type: boolean
        numRecords:
          format: int32
          type: integer
        prevCursor:
          type: string
      type: object
    protobufAny:
      properties:
        typeUrl:
          type: string
        value:
          format: byte
          type: string
      type: object
  requestBodies:
    generatedCreateOrUpdateDataClassRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/generatedCreateOrUpdateDataClassRequest'
      required: true
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    Agent_API_Key:
      description: Add 'apikey ' to the beginning of your api key
      in: header
      name: Authorization
      type: apiKey
    Personal_API_Key:
      description: Add 'apikey ' to the beginning of your api key
      in: header
      name: Authorization
      type: apiKey