ALTR Data Masking API

Access to column info around available masking types

Operations 2

GET /masking/v2/column/types/{fieldId}/ Checks column masking types #
GET /masking/v2/column/types/array Checks column masking types for input array #

Documentation

📖
Documentation
https://altrnet.live.altr.com/api/swagger/
📖
APIReference
https://altrnet.live.altr.com/api/swagger/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/altr/refs/heads/main/authentication/altr-authentication.yml
📖
Documentation
https://api.live.altr.com/v1/unified-policy/docs
📖
APIReference
https://api.live.altr.com/v1/unified-policy/docs
📖
Documentation
https://api.live.altr.com/v1/rbac/api-docs/index.html
📖
APIReference
https://api.live.altr.com/v1/rbac/api-docs/index.html
📖
Documentation
https://docs.classification.live.altr.com/v1/docs
📖
APIReference
https://docs.classification.live.altr.com/v1/docs
📖
Documentation
https://api.live.altr.com/v1/tag/auto-tagging-api-docs/index.html
📖
APIReference
https://api.live.altr.com/v1/tag/auto-tagging-api-docs/index.html
📖
Documentation
https://api.live.altr.com/v1/tag/masking-api-docs/index.html
📖
APIReference
https://api.live.altr.com/v1/tag/masking-api-docs/index.html
📖
Documentation
https://api.live.altr.com/v1/tag/refresh-api-docs/index.html
📖
APIReference
https://api.live.altr.com/v1/tag/refresh-api-docs/index.html
📖
Documentation
https://api.live.altr.com/v1/alpha/dbx/tag-policy/docs/index.html
📖
APIReference
https://api.live.altr.com/v1/alpha/dbx/tag-policy/docs/index.html
📖
Documentation
https://api.live.altr.com/v1/dis/swagger/
📖
APIReference
https://api.live.altr.com/v1/dis/swagger/
📖
Documentation
https://api.live.altr.com/v1/snowflake/metadata-api-docs/index.html
📖
APIReference
https://api.live.altr.com/v1/snowflake/metadata-api-docs/index.html
📖
Documentation
https://api.live.altr.com/v1/query-audits/api-docs/index.html
📖
APIReference
https://api.live.altr.com/v1/query-audits/api-docs/index.html
📖
Documentation
https://api.live.altr.com/v1/dam/docs
📖
APIReference
https://api.live.altr.com/v1/dam/docs
📖
Documentation
https://docs.dam-alerting.live.altr.com/v1/dam-alerting/docs
📖
APIReference
https://docs.dam-alerting.live.altr.com/v1/dam-alerting/docs
📖
Documentation
https://docs.audit-report.live.altr.com/v1/audit-reports/docs
📖
APIReference
https://docs.audit-report.live.altr.com/v1/audit-reports/docs
📖
Documentation
https://docs.notifications.live.altr.com/v1/notification-integration/docs
📖
APIReference
https://docs.notifications.live.altr.com/v1/notification-integration/docs
📖
Documentation
https://docs.critical.live.altr.com/v2
📖
APIReference
https://docs.critical.live.altr.com/v2
📖
Documentation
https://docs.sc-control.live.altr.com/v1/repo-config-docs
📖
APIReference
https://docs.sc-control.live.altr.com/v1/repo-config-docs
📖
Documentation
https://docs.sc-control.live.altr.com/v1/audits/docs
📖
APIReference
https://docs.sc-control.live.altr.com/v1/audits/docs
📖
Documentation
https://docs.sc-control.live.altr.com/v1/sidecars/telemetry/docs
📖
APIReference
https://docs.sc-control.live.altr.com/v1/sidecars/telemetry/docs
📖
Documentation
https://docs.sc-control.live.altr.com/v1/access-tokens/docs
📖
APIReference
https://docs.sc-control.live.altr.com/v1/access-tokens/docs
📖
Documentation
https://docs.service-user.live.altr.com/v1/docs
📖
APIReference
https://docs.service-user.live.altr.com/v1/docs

Specifications

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/altr-data-masking-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

altr-data-masking-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: ALTR Datastore Information Service Data Masking API
  description: Welcome to the Swagger documentation for ALTR's Datastore Information Service (DIS).
  termsOfService: https://www.altr.com/info/altr-solutions-inc-terms-of-service
  contact:
    name: Support
    email: support@altr.com
  version: 3.4.3
servers:
- url: '/v1/dis '
security:
- bearerAuth: []
  basicAuth: []
tags:
- name: Data Masking
  description: Access to column info around available masking types
  externalDocs:
    description: Find out more
    url: https://docs.altr.com/explore-altr-features/locks#Dynamic%20Data%20Masking
paths:
  /masking/v2/column/types/{fieldId}/:
    get:
      tags:
      - Data Masking
      summary: Checks column masking types
      description: 'Checks to see if the column can be masked with given mask for a client.


        Normalized data types: [ STRING,

        NUMBER,

        DATETIME ] ReplacementStrategies:

        [ REPLACEMENT_STRATEGY_NOOP = 0;

        ALL = 1; // Replace the entire original string with Replacement.value

        CHAR = 2; // Replace every character with Replacement.value

        EMAIL = 3; // Replace every character in local part of email with Replacement.value

        LAST_FOUR = 4; // Replace every character except for the final four and certain delimiters with Replacement.value

        CONSTANT_REPLACE = 5; // Replace entire original value with constant

        ]'
      operationId: columnMaskTypes
      parameters:
      - name: fieldId
        in: path
        description: Comes from /api/data list (see <a href="https://altrnet.live.altr.com/api/swagger/#/data">https://altrnet.live.altr.com/api/swagger/#/data</a>)
        required: true
        explode: true
        schema: {}
      responses:
        '200':
          description: Successfully retrieved column list for tagID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArrayNoMaskingType'
          headers:
            trackingID:
              schema:
                type: String
                description: Returns a tracking identification UUID for the request.
                example: 8cfa50b0-2f9e-52cf-b739-b0eab8e7c37f
        '401':
          description: Invalid credentials provided
          headers:
            trackingID:
              schema:
                type: String
                description: Returns a tracking identification UUID for the request.
                example: 8cfa50b0-2f9e-52cf-b739-b0eab8e7c37f
        '404':
          description: No field id exists of this value.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            trackingID:
              schema:
                type: String
                description: Returns a tracking identification UUID for the request.
                example: 8cfa50b0-2f9e-52cf-b739-b0eab8e7c37f
        5xx:
          description: Failure servicing this request
  /masking/v2/column/types/array:
    get:
      tags:
      - Data Masking
      summary: Checks column masking types for input array
      description: 'Checks to see if the columns in the input array can be masked with given mask for a client.


        Normalized data types: [ STRING,

        NUMBER,

        DATETIME ] ReplacementStrategies:

        [ REPLACEMENT_STRATEGY_NOOP = 0;

        ALL = 1; // Replace the entire original string with Replacement.value

        CHAR = 2; // Replace every character with Replacement.value

        EMAIL = 3; // Replace every character in local part of email with Replacement.value

        LAST_FOUR = 4; // Replace every character except for the final four and certain delimiters with Replacement.value

        CONSTANT_REPLACE = 5; // Replace entire original value with constant

        ]'
      operationId: columnMaskTypesArray
      consumes: application/json
      parameters:
      - in: query
        name: fieldIDs
        description: Comma delimited list of field ID integers. Checks masking types for each of the field ids included in the input list. Field ids come from /api/data list (see <a href="https://altrnet.live.altr.com/api/swagger/#/data">https://altrnet.live.altr.com/api/swagger/#/data</a>)
        required: true
        schema: {}
      responses:
        '200':
          description: Successfully retrieved column list for tagID array
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArrayNoMaskingType'
          headers:
            trackingID:
              schema:
                type: String
                description: Returns a tracking identification UUID for the request.
                example: 8cfa50b0-2f9e-52cf-b739-b0eab8e7c37f
        '401':
          description: Invalid credentials provided
          headers:
            trackingID:
              schema:
                type: String
                description: Returns a tracking identification UUID for the request.
                example: 8cfa50b0-2f9e-52cf-b739-b0eab8e7c37f
        '404':
          description: No field id exists of this value.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            trackingID:
              schema:
                type: String
                description: Returns a tracking identification UUID for the request.
                example: 8cfa50b0-2f9e-52cf-b739-b0eab8e7c37f
        5xx:
          description: Failure servicing this request
components:
  schemas:
    Error:
      type: object
      properties:
        errorCode:
          type: integer
          format: int64
          example: 404
        message:
          type: string
          example: Requested ID did not exist.
    ArrayNoMaskingType:
      type: array
      items:
        $ref: '#/components/schemas/SingleNoMaskingType'
    SingleNoMaskingType:
      type: object
      properties:
        field_id:
          type: integer
          example: 1
        canSet:
          type: boolean
          example: true
        maskingTypes:
          type: array
          example:
          - 0
          - 1
          - 2
          - 3
        columnType:
          type: string
          example: String
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: DIS uses [HTTP Basic Authentication](https://swagger.io/docs/specification/authentication/basic-authentication/).<br/><br/>DIS/MAPI credentials can be obtained on the [API page](https://altrnet.live.altr.com/settings/preferences/api) (found under Settings > Preferences > API) of ALTR's portal for Enterprise and Enterprise+ customers.<br/><br/>Usernames are the 'Key Names' listed on that page, and Passwords are the 'Key Secret' provided when an API key is created.
    bearerAuth:
      type: http
      scheme: bearer
      description: JWT Info here
externalDocs:
  description: Find out more about ALTR
  url: https://docs.altr.com