Grapes Knowledge Base

Grapes Knowledge Base Sensitive Fields API

The SensitiveFields API from Grapes Knowledge Base — 4 operation(s) for sensitivefields.

GitHub OpenAPI

Operations 5

POST /api/{version}/organizations/{orgId}/projects/{projId}/databases/{dbId}/sensitive-fields Create sensitive field #
GET /api/{version}/organizations/{orgId}/projects/{projId}/databases/{dbId}/sensitive-fields Get sensitive fields #
PATCH /api/{version}/organizations/{orgId}/projects/{projId}/databases/{dbId}/sensitive-fields/{sensitiveFieldId} Update sensitive field #
POST /api/{version}/organizations/{orgId}/projects/{projId}/databases/{dbId}/sensitive-fields/{sensitiveFieldId}/workflow-status Update sensitive field wokflow status #
POST /api/{version}/organizations/{orgId}/projects/{projId}/databases/{dbId}/sensitive-fields/recognize Recognize sensitive fields #

Documentation

📖
Documentation
https://docs.data-grapes.com/en/docs/developer-docs/api/api-reference/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/grapes-knowledge-base/refs/heads/main/openapi/grapes-knowledge-base-sensitivefields-api-openapi.yml

Other Resources

🔗
Security
https://docs.data-grapes.com/en/docs/developer-docs/api/api-security/

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/grapes-knowledge-base:grapes-knowledge-base-sensitivefields-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

grapes-knowledge-base-sensitivefields-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Grapes Sensitive Fields API
  version: v1
security:
- Bearer: []
tags:
- name: SensitiveFields
paths:
  /api/{version}/organizations/{orgId}/projects/{projId}/databases/{dbId}/sensitive-fields:
    post:
      tags:
      - SensitiveFields
      operationId: CreateSensitiveField
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
      - name: projId
        in: path
        required: true
        schema:
          type: string
      - name: dbId
        in: path
        required: true
        schema:
          type: string
      - name: version
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSensitiveFieldRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/CreateSensitiveFieldRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CreateSensitiveFieldRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SensitiveFieldDtoItemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/SensitiveFieldDtoItemResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/SensitiveFieldDtoItemResponse'
        '400':
          description: Validation failed
      summary: Create sensitive field
      x-summary-source: derived
    get:
      tags:
      - SensitiveFields
      operationId: GetSensitiveFields
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
      - name: projId
        in: path
        required: true
        schema:
          type: string
      - name: dbId
        in: path
        required: true
        schema:
          type: string
      - name: Skip
        in: query
        schema:
          type: integer
          format: int32
      - name: Take
        in: query
        schema:
          type: integer
          format: int32
      - name: version
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SensitiveFieldDtoListItemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/SensitiveFieldDtoListItemResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/SensitiveFieldDtoListItemResponse'
      summary: Get sensitive fields
      x-summary-source: derived
  /api/{version}/organizations/{orgId}/projects/{projId}/databases/{dbId}/sensitive-fields/{sensitiveFieldId}:
    patch:
      tags:
      - SensitiveFields
      operationId: UpdateSensitiveField
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
      - name: projId
        in: path
        required: true
        schema:
          type: string
      - name: dbId
        in: path
        required: true
        schema:
          type: string
      - name: sensitiveFieldId
        in: path
        required: true
        schema:
          type: string
      - name: version
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSensitiveFieldRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/UpdateSensitiveFieldRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UpdateSensitiveFieldRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SensitiveFieldDtoListItemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/SensitiveFieldDtoListItemResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/SensitiveFieldDtoListItemResponse'
      summary: Update sensitive field
      x-summary-source: derived
  ? /api/{version}/organizations/{orgId}/projects/{projId}/databases/{dbId}/sensitive-fields/{sensitiveFieldId}/workflow-status
  : post:
      tags:
      - SensitiveFields
      operationId: UpdateSensitiveFieldWokflowStatus
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
      - name: projId
        in: path
        required: true
        schema:
          type: string
      - name: dbId
        in: path
        required: true
        schema:
          type: string
      - name: sensitiveFieldId
        in: path
        required: true
        schema:
          type: string
      - name: version
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSensitiveFieldStatusRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/UpdateSensitiveFieldStatusRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UpdateSensitiveFieldStatusRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SensitiveFieldDtoListItemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/SensitiveFieldDtoListItemResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/SensitiveFieldDtoListItemResponse'
      summary: Update sensitive field wokflow status
      x-summary-source: derived
  /api/{version}/organizations/{orgId}/projects/{projId}/databases/{dbId}/sensitive-fields/recognize:
    post:
      tags:
      - SensitiveFields
      operationId: RecognizeSensitiveFields
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
      - name: projId
        in: path
        required: true
        schema:
          type: string
      - name: dbId
        in: path
        required: true
        schema:
          type: string
      - name: version
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecognizeSensitiveFieldsRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/RecognizeSensitiveFieldsRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/RecognizeSensitiveFieldsRequest'
      responses:
        '202':
          description: Accepted
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/IActionResult'
            application/json:
              schema:
                $ref: '#/components/schemas/IActionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/IActionResult'
        '400':
          description: Validation failed
      summary: Recognize sensitive fields
      x-summary-source: derived
components:
  schemas:
    SensitiveFieldDto:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        tableName:
          type:
          - string
          - 'null'
        fieldName:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/SensitiveFieldTypes'
        status:
          $ref: '#/components/schemas/SensitiveFieldStatusTypes'
        origin:
          $ref: '#/components/schemas/SensitiveFieldOrigins'
        piiScore:
          type:
          - number
          - 'null'
          format: double
        workflowStatus:
          $ref: '#/components/schemas/SensitiveFieldWorkflowStatusTypes'
        rejectedReason:
          type:
          - string
          - 'null'
        createdDate:
          type: string
          format: date-time
        anonymizationRule:
          $ref: '#/components/schemas/IAnonymizationRule'
      additionalProperties: false
    RecognizeSensitiveFieldsRequest:
      type: object
      properties:
        databaseEnvironmentId:
          type:
          - string
          - 'null'
      additionalProperties: false
    SensitiveFieldDtoItemResponse:
      type: object
      properties:
        item:
          $ref: '#/components/schemas/SensitiveFieldDto'
        links:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/HateoasLink'
      additionalProperties: false
    SensitiveFieldStatusTypes:
      enum:
      - New
      - Validated
      - FalsePositive
      type: string
    SensitiveFieldWorkflowStatusTypes:
      enum:
      - ReadyForReview
      - Approved
      - Rejected
      type: string
    SensitiveFieldTypes:
      enum:
      - EmailAddress
      - IPAddress
      - MacAddress
      - PhoneNumber
      - FirstName
      - LastName
      - SensitiveDate
      - CreditCard
      - Iban
      - Address
      - PostalCode
      - Unknown
      type: string
    IActionResult:
      type: object
      additionalProperties: false
    SensitiveFieldDtoListItemResponse:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SensitiveFieldDtoItemResponse'
        totalCount:
          type: integer
          format: int32
      additionalProperties: false
    SensitiveFieldOrigins:
      enum:
      - Auto
      - Manuel
      type: string
    IAnonymizationRule:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
          readOnly: true
      additionalProperties: false
    UpdateSensitiveFieldStatusRequest:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/SensitiveFieldWorkflowStatusTypes'
        rejectedReason:
          type:
          - string
          - 'null'
      additionalProperties: false
    UpdateSensitiveFieldRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/SensitiveFieldTypes'
        piiScore:
          type:
          - number
          - 'null'
          format: double
        status:
          $ref: '#/components/schemas/SensitiveFieldStatusTypes'
        anonymizationRule:
          $ref: '#/components/schemas/IAnonymizationRule'
      additionalProperties: false
    HateoasLink:
      type: object
      properties:
        relation:
          type:
          - string
          - 'null'
        uri:
          type:
          - string
          - 'null'
        method:
          type:
          - string
          - 'null'
      additionalProperties: false
    CreateSensitiveFieldRequest:
      type: object
      properties:
        tableName:
          type:
          - string
          - 'null'
        fieldName:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/SensitiveFieldTypes'
        status:
          $ref: '#/components/schemas/SensitiveFieldStatusTypes'
        origin:
          $ref: '#/components/schemas/SensitiveFieldOrigins'
        piiScore:
          type:
          - number
          - 'null'
          format: double
        workflowStatus:
          $ref: '#/components/schemas/SensitiveFieldWorkflowStatusTypes'
        rejectedReason:
          type:
          - string
          - 'null'
        anonymizationRule:
          $ref: '#/components/schemas/IAnonymizationRule'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: oauth2
      description: "JWT Authorization header using the Bearer scheme. \n\n Enter 'Bearer' [space] and then your token in the text input below.\n\nExample: \"Bearer 1safsfsdfdfd\""
x-provenance:
  method: harvested
  publisher: Grapes Knowledge Base
  source: https://api.data-grapes.com/swagger/v1/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)