Redacts sensitive content in a Confluence page by replacing specified text ranges with redaction markers. Each redaction in the response includes a unique UUID for restoration (except code block redactions). The response metadata items maintain the same order as the input redaction pointers, and completely overlapping redactions are merged into a single redaction with one UUID.
Note: This endpoint requires Atlassian Guard Premium.
write:page:confluenceConnect app scope required: WRITE
integer
Requiredstring
Requiredboolean
Requiredobject
object
Redaction Accepted. The response contains details about the redactions that were applied.
Response containing details of all redactions that were applied to the content. Each redaction includes a unique ID for restoration, except that code block redactions cannot be restored.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import { requestConfluence } from "@forge/bridge";
var bodyData = `{
"createdAt": "<string>",
"cleanHistory": true,
"body": {
"redactions": [
{
"redactions": [
{
"pointer": "<string>",
"from": 85,
"to": 140,
"reason": "<string>"
}
]
}
]
},
"title": {
"redactions": [
{
"redactions": [
{
"pointer": "<string>",
"from": 85,
"to": 140,
"reason": "<string>"
}
]
}
]
}
}`;
const response = await requestConfluence(`/wiki/api/v2/pages/{id}/redact`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
"body": {
"redactions": [
{
"pointer": "<string>",
"from": 52,
"to": 50,
"reason": "<string>",
"redactionId": "<string>"
}
]
},
"title": {
"redactions": [
{
"pointer": "<string>",
"from": 52,
"to": 50,
"reason": "<string>",
"redactionId": "<string>"
}
]
}
}Redacts sensitive content in a Confluence blog post by replacing specified text ranges with redaction markers. Each redaction in the response includes a unique UUID for restoration (except code block redactions). The response metadata items maintain the same order as the input redaction pointers, and completely overlapping redactions are merged into a single redaction with one UUID.
Note: This endpoint requires Atlassian Guard Premium.
write:page:confluenceConnect app scope required: WRITE
integer
Requiredstring
Requiredboolean
Requiredobject
object
Redaction Accepted. The response contains details about the redactions that were applied.
Response containing details of all redactions that were applied to the content. Each redaction includes a unique ID for restoration, except that code block redactions cannot be restored.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import { requestConfluence } from "@forge/bridge";
var bodyData = `{
"createdAt": "<string>",
"cleanHistory": true,
"body": {
"redactions": [
{
"redactions": [
{
"pointer": "<string>",
"from": 85,
"to": 140,
"reason": "<string>"
}
]
}
]
},
"title": {
"redactions": [
{
"redactions": [
{
"pointer": "<string>",
"from": 85,
"to": 140,
"reason": "<string>"
}
]
}
]
}
}`;
const response = await requestConfluence(`/wiki/api/v2/blogposts/{id}/redact`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
"body": {
"redactions": [
{
"pointer": "<string>",
"from": 52,
"to": 50,
"reason": "<string>",
"redactionId": "<string>"
}
]
},
"title": {
"redactions": [
{
"pointer": "<string>",
"from": 52,
"to": 50,
"reason": "<string>",
"redactionId": "<string>"
}
]
}
}Rate this page: