Skip to content

redact

get-redaction-status

Get redaction status

Retrieves the current status of a redaction job ID.

The jobStatus will be one of the following:

  • IN_PROGRESS - The redaction job is currently in progress
  • COMPLETED - The redaction job has completed successfully.
  • PENDING - The redaction job has not started yet

GET /rest/api/3/redact/status/{jobId}

FlagTypeRequiredDescription
--jobIdstringYesRedaction job id

Example:

bash
jr redact get-redaction-status --jobId <jobId>

redact

Redact

Submit a job to redact issue field data. This will trigger the redaction of the data in the specified fields asynchronously.

The redaction status can be polled using the job id.

POST /rest/api/3/redact

FlagTypeRequiredDescription
--bodystringNorequest body (JSON string, @file, or - for stdin)

Example:

bash
jr redact redact