/programs/{program_id}/frameworks/{framework_id}/anonymizeStart anonymization
Starts the anonymization process for an anonymized framework that is in the initialized, error, or anonymized state. This will apply all defined masking rules to anonymize sensitive data in the framework registers. The framework must be an anonymized framework to start anonymization.
Note: This endpoint is currently in Beta.
Quick start
curl "https://api.optitech.com/v1/programs/$PROGRAM_ID/frameworks/$FRAMEWORK_ID/anonymize" \
-X POST \
-H "Authorization: Bearer $OPTITECH_API_KEY"Every field below is optional. An empty body works too.
import { createOptiTechClient, raw } from '@optitech/sdk';
const optitech = createOptiTechClient({ apiKey: process.env.OPTITECH_API_KEY });
const { data } = await raw.startAnonymization({
client: optitech.client,
path: {
program_id: process.env.PROGRAM_ID,
framework_id: process.env.FRAMEWORK_ID
}
});Parameters
program_idThe OptiTech program ID
framework_idThe framework ID
Response
200Anonymization started successfully
Errors
General error
This endpoint can return the standard OptiTech API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.