List all redaction jobs Preview

GET / v1 / privacy / redaction_jobs

Returns a list of redaction jobs.

Parameters

• status enum If provided, only RedactionJob objects with the given status will be returned. Possible enum values canceled The job is canceled. No objects are redacted. canceling The job is canceling and no objects will be redacted. created This job is newly created and will begin validating shortly. failed The job failed to validate. View the job’s validation errors for more information. ready The job is ready to run or cancel. redacting The job is running. It is redacting the job’s specified objects. succeeded The job is complete. The job’s objects are redacted. validating The job is checking if the objects are eligible for redaction.

More parameters

• ending _ before string
• limit integer
• starting _ after string

Returns

Returns a list of RedactionJob objects.

Response

Cancel a redaction job Preview

POST / v1 / privacy / redaction_jobs /:id / cancel

You can cancel a redaction job when it’s in one of these statuses: ready, failed.

Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.

Parameters

• job string Required RedactionJob object identifier

Returns

Returns the RedactionJob object if successful. Otherwise, returns an error.

Response

{ "id": "prj_123", "object": "privacy.redaction_job", "created": 1234567890, "livemode": true, "status": "canceling", "validation_behavior": "error"}

Run a redaction job Preview

POST / v1 / privacy / redaction_jobs /:id / run

Run a redaction job in a ready status.

When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.

The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job’s validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.

Parameters

• job string Required RedactionJob object identifier

Returns

Returns the RedactionJob object if successful. Otherwise, returns an error.

Response

{ "id": "prj_123", "object": "privacy.redaction_job", "created": 1234567890, "livemode": true, "status": "redacting", "validation_behavior": "error"}