databases
create
Create database
Creates a database in the space.
Permissions required: Permission to view the corresponding space. Permission to create a database in the space.
POST /databases
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
--private | string | No | The database will be private. Only the user who creates this database will have permission to view and edit one. |
Example:
cf databases createcreate-property
Create content property for database
Creates a new content property for a database.
Permissions required: Permission to update the database.
POST /databases/{id}/properties
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
--id | string | Yes | The ID of the database to create a property for. |
Example:
cf databases create-property --id <id>delete
Delete database
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 /databases/{id}
| Flag | Type | Required | Description |
|---|---|---|---|
--id | string | Yes | The ID of the database to be deleted. |
Example:
cf databases delete --id <id>delete-property-by-id
Delete content property for database by id
Deletes a content property for a database by its id.
Permissions required: Permission to edit the database.
DELETE /databases/{database-id}/properties/{property-id}
| Flag | Type | Required | Description |
|---|---|---|---|
--database-id | string | Yes | The ID of the database the property belongs to. |
--property-id | string | Yes | The ID of the property to be deleted. |
Example:
cf databases delete-property-by-id --database-id <database-id> --property-id <property-id>get-ancestors
Get all ancestors of database
Returns all ancestors for a given database by ID in top-to-bottom order (that is, the highest ancestor is the first item in the response payload). The number of results is limited by the limit parameter and additional results (if available) will be available by calling this endpoint with the ID of first ancestor in the response payload.
This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as Get database by id.
Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the database and its corresponding space
GET /databases/{id}/ancestors
| Flag | Type | Required | Description |
|---|---|---|---|
--id | string | Yes | The ID of the database. |
--limit | string | No | Maximum number of items per result to return. If more results exist, call the endpoint with the highest ancestor's ID to fetch the next set of results. |
Example:
cf databases get-ancestors --id <id>get-by-id
Get database by id
Returns a specific database.
Permissions required: Permission to view the database and its corresponding space.
GET /databases/{id}
| Flag | Type | Required | Description |
|---|---|---|---|
--id | string | Yes | The ID of the database to be returned |
--include-collaborators | string | No | Includes collaborators on the database. |
--include-direct-children | string | No | Includes direct children of the database, as defined in the ChildrenResponse object. |
--include-operations | string | No | Includes operations associated with this database in the response, as defined in the Operation object. |
| The number of results will be limited to 50 and sorted in the default sort order. | |||
A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results. | |||
--include-properties | string | No | Includes content properties associated with this database in the response. |
| The number of results will be limited to 50 and sorted in the default sort order. | |||
A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results. |
Example:
cf databases get-by-id --id <id>get-classification-level
Get database classification level
Returns the classification level for a specific database.
Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the database.
GET /databases/{id}/classification-level
| Flag | Type | Required | Description |
|---|---|---|---|
--id | string | Yes | The ID of the database for which classification level should be returned. |
Example:
cf databases get-classification-level --id <id>get-content-properties
Get content properties for database
Retrieves Content Properties tied to a specified database.
Permissions required: Permission to view the database.
GET /databases/{id}/properties
| Flag | Type | Required | Description |
|---|---|---|---|
--cursor | string | No | Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. |
--id | string | Yes | The ID of the database for which content properties should be returned. |
--key | string | No | Filters the response to return a specific content property with matching key (case sensitive). |
--limit | string | No | Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. |
--sort | string | No | Used to sort the result by a particular field. |
Example:
cf databases get-content-properties --id <id>get-content-properties-by-id
Get content property for database by id
Retrieves a specific Content Property by ID that is attached to a specified database.
Permissions required: Permission to view the database.
GET /databases/{database-id}/properties/{property-id}
| Flag | Type | Required | Description |
|---|---|---|---|
--database-id | string | Yes | The ID of the database for which content properties should be returned. |
--property-id | string | Yes | The ID of the content property being requested. |
Example:
cf databases get-content-properties-by-id --database-id <database-id> --property-id <property-id>get-descendants
Get descendants of a database
Returns descendants in the content tree for a given database by ID in top-to-bottom order (that is, the highest descendant is the first item in the response payload). The number of results is limited by the limit parameter and additional results (if available) will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth of descendants to be fetched.
The following types of content will be returned:
- Database
- Embed
- Folder
- Page
- Whiteboard
This endpoint returns minimal information about each descendant. To fetch more details, use a related endpoint based on the content type, such as:
Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the database and its corresponding space
GET /databases/{id}/descendants
| Flag | Type | Required | Description |
|---|---|---|---|
--cursor | string | No | Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. |
--depth | string | No | Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants. |
--id | string | Yes | The ID of the database. |
--limit | string | No | Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results. |
Example:
cf databases get-descendants --id <id>get-direct-children
Get direct children of a database
Returns all children for given database id in the content tree. 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.
The following types of content will be returned:
- Database
- Embed
- Folder
- Page
- Whiteboard
This endpoint returns minimal information about each child. To fetch more details, use a related endpoint based on the content type, such as:
Permissions required: Permission to access the Confluence site ('Can use' global permission). Only content that the user has permission to view will be returned.
GET /databases/{id}/direct-children
| Flag | Type | Required | Description |
|---|---|---|---|
--cursor | string | No | Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. |
--id | string | Yes | The ID of the parent database. |
--limit | string | No | Maximum number of items per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. |
--sort | string | No | Used to sort the result by a particular field. |
Example:
cf databases get-direct-children --id <id>get-operations
Get permitted operations for a database
Returns the permitted operations on specific database.
Permissions required: Permission to view the database and its corresponding space.
GET /databases/{id}/operations
| Flag | Type | Required | Description |
|---|---|---|---|
--id | string | Yes | The ID of the database for which operations should be returned. |
Example:
cf databases get-operations --id <id>post-classification-level
Reset database classification level
Resets the classification level for a specific database for the space default classification level.
Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the database.
POST /databases/{id}/classification-level/reset
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
--id | string | Yes | The ID of the database for which classification level should be updated. |
Example:
cf databases post-classification-level --id <id>put-classification-level
Update database classification level
Updates the classification level for a specific database.
Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to edit the database.
PUT /databases/{id}/classification-level
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
--id | string | Yes | The ID of the database for which classification level should be updated. |
Example:
cf databases put-classification-level --id <id>update-property-by-id
Update content property for database by id
Update a content property for a database by its id.
Permissions required: Permission to edit the database.
PUT /databases/{database-id}/properties/{property-id}
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
--database-id | string | Yes | The ID of the database the property belongs to. |
--property-id | string | Yes | The ID of the property to be updated. |
Example:
cf databases update-property-by-id --database-id <database-id> --property-id <property-id>