Skip to content

Reference

Platform API

Automate Maskflare with an API client: keys, providers, masking rules, devices and audit events over a versioned OpenAPI 3.1 API.

Terraform, scripts and MCP servers manage an organization through the same API the console uses, with an API client instead of a person's login. Create one under Settings › API clients with one role (admin, security, developer or auditor) and a client secret or a public key (private_key_jwt).

Authenticate

Shell
TOKEN=$(curl -s -X POST "$MASKFLARE_TOKEN_URL" \
  -d grant_type=client_credentials -d client_id="$MASKFLARE_CLIENT_ID" -d client_secret="$MASKFLARE_CLIENT_SECRET" \
  | jq -r .access_token)
curl -s https://YOUR_GATEWAY_HOST/api/platform/v1/organizations/current/api-keys \
  -H "Authorization: Bearer $TOKEN"

Contract

  • OpenAPI 3.1 at /api/platform/v1/openapi.json, browsable at /api/platform/v1/docs on your gateway. It lists exactly the operations an API client may call; members, approvals, billing and webhooks stay with people.
  • The version is in the path. Within v1 changes are additive only.
  • Rate limit: 600 requests per minute per client by default, with RateLimit-* headers; over it, `rate_limited` with Retry-After.
  • Masking rule changes made by a client are proposals a person approves.

Operations

The 88 operations an API client may call in v1.

MethodPathWhat it does
GET/api/platform/v1/meMe
GET/api/platform/v1/organizations/currentCurrent Organization
GET/api/platform/v1/organizations/current/agent-policyGet Agent Policy
PUT/api/platform/v1/organizations/current/agent-policyPublish Agent Policy
POST/api/platform/v1/organizations/current/agent-policy/rollbackRollback Agent Policy
GET/api/platform/v1/organizations/current/agent-rolloutsList Rollouts
PUT/api/platform/v1/organizations/current/agent-rollouts/{ring}Start Rollout
DELETE/api/platform/v1/organizations/current/agent-rollouts/{ring}Stop Rollout
POST/api/platform/v1/organizations/current/agent-rollouts/{ring}/pausePause Rollout
POST/api/platform/v1/organizations/current/agent-rollouts/{ring}/resumeResume Rollout
GET/api/platform/v1/organizations/current/api-keysList Api Keys
POST/api/platform/v1/organizations/current/api-keysCreate Api Key
PATCH/api/platform/v1/organizations/current/api-keys/{key_id}Update Api Key
DELETE/api/platform/v1/organizations/current/api-keys/{key_id}Revoke Api Key
GET/api/platform/v1/organizations/current/audit-eventsList Audit Events
GET/api/platform/v1/organizations/current/audit-events/actionsList Audit Actions
GET/api/platform/v1/organizations/current/audit-events/exportExport Audit Events
GET/api/platform/v1/organizations/current/browser-dlpGet Browser Dlp
PUT/api/platform/v1/organizations/current/browser-dlpUpdate Browser Dlp
PUT/api/platform/v1/organizations/current/browser-dlp/apps/{key}Update Browser Dlp App
GET/api/platform/v1/organizations/current/device-enrollment-tokensList Enrollment Tokens
POST/api/platform/v1/organizations/current/device-enrollment-tokensCreate Enrollment Token
DELETE/api/platform/v1/organizations/current/device-enrollment-tokens/{token_id}Revoke Enrollment Token
GET/api/platform/v1/organizations/current/device-groupsList Groups
POST/api/platform/v1/organizations/current/device-groupsCreate Group
PUT/api/platform/v1/organizations/current/device-groups/orderOrder Groups
PATCH/api/platform/v1/organizations/current/device-groups/{group_id}Update Group
DELETE/api/platform/v1/organizations/current/device-groups/{group_id}Delete Group
GET/api/platform/v1/organizations/current/device-lifecycleGet Device Lifecycle
PUT/api/platform/v1/organizations/current/device-lifecycleUpdate Device Lifecycle
GET/api/platform/v1/organizations/current/device-self-enrollmentGet Self Enrollment
PUT/api/platform/v1/organizations/current/device-self-enrollmentUpdate Self Enrollment
GET/api/platform/v1/organizations/current/devicesList Devices
GET/api/platform/v1/organizations/current/devices/export.csvExport Devices
GET/api/platform/v1/organizations/current/devices/{device_id}Get Device
PATCH/api/platform/v1/organizations/current/devices/{device_id}Update Device
DELETE/api/platform/v1/organizations/current/devices/{device_id}Revoke Device
POST/api/platform/v1/organizations/current/devices/{device_id}/pause-codeIssue Pause Code
GET/api/platform/v1/organizations/current/devices/{device_id}/timelineDevice Timeline
POST/api/platform/v1/organizations/current/devices/{device_id}/uninstall-codeIssue Uninstall Code
GET/api/platform/v1/organizations/current/end-user-messagesGet End User Messages
PUT/api/platform/v1/organizations/current/end-user-messagesUpdate End User Messages
GET/api/platform/v1/organizations/current/environments/{environment}/compliance-coverageEnvironment Compliance Coverage
GET/api/platform/v1/organizations/current/environments/{environment}/masking-allowlistGet Masking Allowlist
PUT/api/platform/v1/organizations/current/environments/{environment}/masking-allowlistPropose Masking Allowlist
GET/api/platform/v1/organizations/current/environments/{environment}/masking-change-sets/{change_set_id}Get Masking Change Set
GET/api/platform/v1/organizations/current/environments/{environment}/masking-change-sets/{change_set_id}/lintLint Masking Change Set
GET/api/platform/v1/organizations/current/environments/{environment}/masking-profilesEnvironment Masking Profiles
POST/api/platform/v1/organizations/current/environments/{environment}/masking-profiles/{profile_id}/applyApply Masking Profile
POST/api/platform/v1/organizations/current/environments/{environment}/masking-profiles/{profile_id}/upgradeUpgrade Masking Profile
GET/api/platform/v1/organizations/current/environments/{environment}/masking-rule-changesList Masking Rule Changes
POST/api/platform/v1/organizations/current/environments/{environment}/masking-rule-changes/batchPropose Masking Change Set
GET/api/platform/v1/organizations/current/environments/{environment}/masking-rule-changes/{change_id}/lintLint Masking Rule Change
GET/api/platform/v1/organizations/current/environments/{environment}/masking-rule-changes/{change_id}/termsGet Masking Rule Change Terms
GET/api/platform/v1/organizations/current/environments/{environment}/masking-rule-lintLint Masking Rules
GET/api/platform/v1/organizations/current/environments/{environment}/masking-rule-packsList Masking Rule Packs
POST/api/platform/v1/organizations/current/environments/{environment}/masking-rule-packs/{pack}Propose Masking Rule Pack Toggle
GET/api/platform/v1/organizations/current/environments/{environment}/masking-rulesList Masking Rules
POST/api/platform/v1/organizations/current/environments/{environment}/masking-rulesPropose Masking Rule Create
POST/api/platform/v1/organizations/current/environments/{environment}/masking-rules/previewPreview Masking
PATCH/api/platform/v1/organizations/current/environments/{environment}/masking-rules/{rule_id}Propose Masking Rule Update
DELETE/api/platform/v1/organizations/current/environments/{environment}/masking-rules/{rule_id}Propose Masking Rule Delete
GET/api/platform/v1/organizations/current/environments/{environment}/masking-rules/{rule_id}/termsGet Masking Rule Terms
GET/api/platform/v1/organizations/current/environments/{environment}/masking-scopeGet Masking Scope
PUT/api/platform/v1/organizations/current/environments/{environment}/masking-scope/excludeSet Masking Scope Exclude
PUT/api/platform/v1/organizations/current/environments/{environment}/masking-scope/includeSet Masking Scope Include
GET/api/platform/v1/organizations/current/environments/{environment}/masking-thresholdsGet Masking Thresholds
PUT/api/platform/v1/organizations/current/environments/{environment}/masking-thresholds/{scope}/{key}Set Masking Threshold
DELETE/api/platform/v1/organizations/current/environments/{environment}/masking-thresholds/{scope}/{key}Delete Masking Threshold
GET/api/platform/v1/organizations/current/environments/{environment}/mcp-serversList Mcp Servers
POST/api/platform/v1/organizations/current/environments/{environment}/mcp-serversCreate Mcp Server
DELETE/api/platform/v1/organizations/current/environments/{environment}/mcp-servers/{server_id}Delete Mcp Server
PUT/api/platform/v1/organizations/current/environments/{environment}/provider-passthroughSet Provider Passthrough
PUT/api/platform/v1/organizations/current/environments/{environment}/rulesUpdate Rules
GET/api/platform/v1/organizations/current/masking-change-setsList Masking Change Sets
GET/api/platform/v1/organizations/current/masking-profilesList Masking Profiles
GET/api/platform/v1/organizations/current/masking-rule-changesList Organization Masking Rule Changes
GET/api/platform/v1/organizations/current/masking-settingsGet Masking Settings
GET/api/platform/v1/organizations/current/masking-validatorsList Masking Validators
GET/api/platform/v1/organizations/current/provider-connectionsList Connections
POST/api/platform/v1/organizations/current/provider-connections/validateValidate Connection
PUT/api/platform/v1/organizations/current/provider-connections/{environment}/{provider}Upsert Connection
DELETE/api/platform/v1/organizations/current/provider-connections/{environment}/{provider}Delete Connection
GET/api/platform/v1/organizations/current/provider-passthroughList Provider Passthrough
GET/api/platform/v1/organizations/current/proxy-caGet Proxy Ca
POST/api/platform/v1/organizations/current/proxy-caProvision Proxy Ca
GET/api/platform/v1/organizations/current/proxy-ca/certificateDownload Proxy Ca Certificate
GET/api/platform/v1/organizations/current/usageCurrent Organization Usage