Creates a database in the space.
Permissions required: Permission to view the corresponding space. Permission to create a database in the space.
write:database:confluenceConnect app scope required: WRITE
boolean
string
Requiredstring
string
Returned if the database was successfully created.
allOf [DatabaseSingle, object]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import { requestConfluence } from "@forge/bridge";
var bodyData = `{
"spaceId": "<string>",
"title": "<string>",
"parentId": "<string>"
}`;
const response = await requestConfluence(`/wiki/api/v2/databases`, {
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
{
"id": "<string>",
"type": "<string>",
"status": "current",
"title": "<string>",
"parentId": "<string>",
"parentType": "page",
"position": 59,
"authorId": "<string>",
"ownerId": "<string>",
"createdAt": "<string>",
"spaceId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"_links": {
"base": "<string>"
}
}Returns a specific database.
Permissions required: Permission to view the database and its corresponding space.
read:database:confluenceConnect app scope required: READ
integer
Requiredboolean
boolean
boolean
boolean
Returned if the requested database is returned.
allOf [DatabaseSingle, 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 { requestConfluence } from "@forge/bridge";
const response = await requestConfluence(`/wiki/api/v2/databases/{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
{
"id": "<string>",
"type": "<string>",
"status": "current",
"title": "<string>",
"parentId": "<string>",
"parentType": "page",
"position": 59,
"authorId": "<string>",
"ownerId": "<string>",
"createdAt": "<string>",
"spaceId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"_links": {
"base": "<string>"
}
}Delete a database by id.
Deleting a database moves the database to the trash, where it can be restored later
Permissions required: Permission to view the database and its corresponding space. Permission to delete databases in the space.
delete:database:confluenceConnect app scope required: DELETE
integer
RequiredReturned if the database 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 { requestConfluence } from "@forge/bridge";
const response = await requestConfluence(`/wiki/api/v2/databases/{id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Returns the field definitions (schema) for a database, ordered by the user-defined column order, using cursor-based pagination.
Consistency: Responses may not immediately reflect recent changes. Clients requiring read-after-write confirmation should poll with bounded backoff.
Experimental: This operation is experimental and may change in backwards-incompatible ways without notice.
Permissions required: Permission to view the database and its corresponding space.
read:database:confluenceConnect app scope required: READ
string
Requiredinteger
string
string
Returned if the requested database fields are returned.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import { requestConfluence } from "@forge/bridge";
const response = await requestConfluence(`/wiki/api/v2/databases/{id}/fields`, {
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
{
"results": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "text",
"settings": {
"richText": true
}
}
],
"_links": {
"self": "<string>",
"base": "<string>",
"next": "<string>"
},
"meta": {
"pageSize": 46,
"cursor": "<string>",
"hasMore": true
}
}Returns the views defined on a database using cursor-based pagination. Only view IDs, names, and types are returned; view configuration is not exposed.
Consistency: Responses may not immediately reflect recent changes. Clients requiring read-after-write confirmation should poll with bounded backoff.
Experimental: This operation is experimental and may change in backwards-incompatible ways without notice.
Permissions required: Permission to view the database and its corresponding space.
read:database:confluenceConnect app scope required: READ
string
Requiredinteger
string
string
Returned if the requested database views are returned.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import { requestConfluence } from "@forge/bridge";
const response = await requestConfluence(`/wiki/api/v2/databases/{id}/views`, {
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
{
"results": [
{
"id": "<string>",
"name": "<string>",
"type": "table"
}
],
"_links": {
"self": "<string>",
"base": "<string>",
"next": "<string>"
},
"meta": {
"pageSize": 46,
"cursor": "<string>",
"hasMore": true
}
}Returns the entries (rows) of a database, with optional filtering, sorting,
and cursor-based pagination. Entry values are keyed by field ID; use
Get fields for database (GET /databases/{id}/fields) to map field IDs to
names.
Filtering is expressed with bracket-scoped query parameters keyed on field
ID. The exact operators vary by field type and are documented on the
filter parameter. Multiple filters are combined with AND. Unsupported
operators and non-filterable fields return distinct structured 400
responses.
Pagination uses opaque, offset-based continuation tokens and is best effort while a database is changing. Concurrent inserts, deletes, or changes to a sort value can cause duplicate or omitted rows across pages. Restart from the first page when a consistent export is required.
Results are based on the database, not a particular view. A view's filters, sorting, grouping, and field visibility do not affect the response.
Consistency: Responses may not immediately reflect recent changes. Clients requiring read-after-write confirmation should poll with bounded backoff.
Experimental: This operation is experimental and may change in backwards-incompatible ways without notice.
Permissions required: Permission to view the database and its corresponding space.
read:database:confluenceConnect app scope required: READ
string
Requiredinteger
string
string
object
string
Returned if the requested database entries are returned.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import { requestConfluence } from "@forge/bridge";
const response = await requestConfluence(`/wiki/api/v2/databases/{id}/entries`, {
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
{
"results": [
{
"id": "<string>",
"databaseId": "<string>",
"values": {}
}
],
"_links": {
"self": "<string>",
"base": "<string>",
"next": "<string>"
},
"meta": {
"pageSize": 46,
"cursor": "<string>",
"hasMore": true
}
}Returns a single entry (row) from a database by ID.
Consistency: Responses may not immediately reflect recent changes. Clients requiring read-after-write confirmation should poll with bounded backoff.
Experimental: This operation is experimental and may change in backwards-incompatible ways without notice.
Permissions required: Permission to view the database and its corresponding space.
read:database:confluenceConnect app scope required: READ
string
Requiredstring
Requiredstring
Returned if the requested database entry is returned.
A single entry, not wrapped in a results array, with a _links.self
path and an absolute _links.base URL.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import { requestConfluence } from "@forge/bridge";
const response = await requestConfluence(`/wiki/api/v2/databases/{id}/entries/{entryId}`, {
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
{
"id": "<string>",
"databaseId": "<string>",
"values": {},
"_links": {
"self": "<string>",
"base": "<string>",
"next": "<string>"
}
}Rate this page: