Returns all attachments. The number of results is limited by the limit parameter and additional results (if available)
will be available through the next URL present in the Link response header.
Permissions required: Permission to view the container of the attachment.
read:attachment:confluenceConnect app scope required: READ
AttachmentSortOrder
string
array<string>
string
string
integer
Returned if the requested attachments are returned.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/attachments`, {
headers: {
'Accept': 'application/json'
}
});
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
25
26
27
28
29
30
31
32
33
34
35
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"createdAt": "<string>",
"pageId": "<string>",
"blogPostId": "<string>",
"customContentId": "<string>",
"mediaType": "<string>",
"mediaTypeDescription": "<string>",
"comment": "<string>",
"fileId": "<string>",
"fileSize": 28,
"webuiLink": "<string>",
"downloadLink": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"_links": {
"webui": "<string>",
"download": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns a specific attachment.
Permissions required: Permission to view the attachment's container.
read:attachment:confluenceConnect app scope required: READ
string
Requiredinteger
boolean
boolean
boolean
boolean
boolean
boolean
Returned if the requested attachment is returned.
allOf [AttachmentSingle, object]
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/attachments/{id}`, {
headers: {
'Accept': 'application/json'
}
});
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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
{
"id": "<string>",
"status": "current",
"title": "<string>",
"createdAt": "<string>",
"pageId": "<string>",
"blogPostId": "<string>",
"customContentId": "<string>",
"mediaType": "<string>",
"mediaTypeDescription": "<string>",
"comment": "<string>",
"fileId": "<string>",
"fileSize": 28,
"webuiLink": "<string>",
"downloadLink": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"labels": {
"results": [
{
"id": "<string>",
"name": "<string>",
"prefix": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"properties": {
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {}
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"operations": {
"results": [
{
"operation": "<string>",
"targetType": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"versions": {
"results": [
{
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"_links": {
"base": "<string>"
}
}Delete an attachment by id.
Deleting an attachment moves the attachment to the trash, where it can be restored later. To permanently delete an attachment (or "purge" it),
the endpoint must be called on a trashed attachment with the following param purge=true.
Permissions required: Permission to view the container of the attachment. Permission to delete attachments in the space. Permission to administer the space (if attempting to purge).
delete:attachment:confluenceConnect app scope required: DELETE
integer
Requiredboolean
Returned if the attachment was successfully deleted.
1
2
3
4
5
6
7
8
9
10
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/attachments/{id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Returns the attachments of specific blog post. The number of results is limited by the limit parameter and additional results (if available)
will be available through the next URL present in the Link response header.
Permissions required: Permission to view the content of the blog post and its corresponding space.
read:attachment:confluenceConnect app scope required: READ
integer
RequiredAttachmentSortOrder
string
array<string>
string
string
integer
Returned if the requested attachments are returned.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/blogposts/{id}/attachments`, {
headers: {
'Accept': 'application/json'
}
});
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
25
26
27
28
29
30
31
32
33
34
35
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"createdAt": "<string>",
"pageId": "<string>",
"blogPostId": "<string>",
"customContentId": "<string>",
"mediaType": "<string>",
"mediaTypeDescription": "<string>",
"comment": "<string>",
"fileId": "<string>",
"fileSize": 28,
"webuiLink": "<string>",
"downloadLink": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"_links": {
"webui": "<string>",
"download": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns the attachments of specific custom content. The number of results is limited by the limit parameter and additional results (if available)
will be available through the next URL present in the Link response header.
Permissions required: Permission to view the content of the custom content and its corresponding space.
read:attachment:confluenceConnect app scope required: READ
integer
RequiredAttachmentSortOrder
string
array<string>
string
string
integer
Returned if the requested attachments are returned.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/custom-content/{id}/attachments`, {
headers: {
'Accept': 'application/json'
}
});
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
25
26
27
28
29
30
31
32
33
34
35
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"createdAt": "<string>",
"pageId": "<string>",
"blogPostId": "<string>",
"customContentId": "<string>",
"mediaType": "<string>",
"mediaTypeDescription": "<string>",
"comment": "<string>",
"fileId": "<string>",
"fileSize": 28,
"webuiLink": "<string>",
"downloadLink": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"_links": {
"webui": "<string>",
"download": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns the attachments of specified label. The number of results is limited by the limit parameter and additional results (if available)
will be available through the next URL present in the Link response header.
Permissions required: Permission to view the attachment and its corresponding space.
read:attachment:confluenceConnect app scope required: READ
integer
RequiredAttachmentSortOrder
string
integer
Returned if the requested attachments for specified label were successfully fetched.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/labels/{id}/attachments`, {
headers: {
'Accept': 'application/json'
}
});
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
25
26
27
28
29
30
31
32
33
34
35
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"createdAt": "<string>",
"pageId": "<string>",
"blogPostId": "<string>",
"customContentId": "<string>",
"mediaType": "<string>",
"mediaTypeDescription": "<string>",
"comment": "<string>",
"fileId": "<string>",
"fileSize": 28,
"webuiLink": "<string>",
"downloadLink": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"_links": {
"webui": "<string>",
"download": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns the attachments of specific page. The number of results is limited by the limit parameter and additional results (if available)
will be available through the next URL present in the Link response header.
Permissions required: Permission to view the content of the page and its corresponding space.
read:attachment:confluenceConnect app scope required: READ
integer
RequiredAttachmentSortOrder
string
array<string>
string
string
integer
Returned if the requested attachments are returned.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/pages/{id}/attachments`, {
headers: {
'Accept': 'application/json'
}
});
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
25
26
27
28
29
30
31
32
33
34
35
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"createdAt": "<string>",
"pageId": "<string>",
"blogPostId": "<string>",
"customContentId": "<string>",
"mediaType": "<string>",
"mediaTypeDescription": "<string>",
"comment": "<string>",
"fileId": "<string>",
"fileSize": 28,
"webuiLink": "<string>",
"downloadLink": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"_links": {
"webui": "<string>",
"download": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Rate this page: