Retrieve a redaction job Preview

GET / v1 / privacy / redaction_jobs /:id

Retrieves the details of a previously created redaction job.

Returns the RedactionJob object.

Response

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

List all redaction jobs Preview

GET / v1 / privacy / redaction_jobs

Returns a list of redaction jobs.

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.

Returns a list of RedactionJob objects.

Response

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.

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"}