POST /rest/api/2/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.

Servers

https://your-domain.atlassian.net

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`redactions[]`	Array	No
`redactions[].redactionPosition`	Object	Yes	Represents the position of the redaction
`redactions[].redactionPosition.to`	Integer	Yes	The ending index(exclusive) for the redaction in specified content
`redactions[].redactionPosition.adfPointer`	String	No	The ADF pointer indicating the position of the text to be redacted. This is only required when redacting from rich text(ADF) fields. For plain text fields, this field can be omitted.
`redactions[].redactionPosition.expectedText`	String	Yes	The text which will be redacted, encoded using SHA256 hash and Base64 digest
`redactions[].redactionPosition.from`	Integer	Yes	The start index(inclusive) for the redaction in specified content
`redactions[].externalId`	String	Yes	Unique id for the redaction request; ID format should be of UUID
`redactions[].contentItem`	Object	Yes	Represents the content to redact
`redactions[].contentItem.id`	String	Yes	This would be the issue ID
`redactions[].contentItem.entityId`	String	Yes	The ID of the content entity. For redacting an issue field, this will be the field ID (e.g., summary, customfield_10000). For redacting a comment, this will be the comment ID. For redacting a worklog, this will be the worklog ID.
`redactions[].contentItem.entityType`	String	Yes	The type of the entity to redact; It will be one of the following: issuefieldvalue - To redact in issue fields issue-comment - To redact in issue comments. issue-worklog - To redact in issue worklogs Valid values: `"issuefieldvalue"` `"issue-comment"` `"issue-worklog"`
`redactions[].reason`	String	Yes	The reason why the content is being redacted

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.