whiteboards

add-permissions

Add whiteboard permissions

Adds or replaces direct content permissions for the specified principals on a whiteboard. Permissions for other principals are preserved; use PUT to replace all permissions at once.

A principal can hold only one read or update permission. Adding read for a principal that currently has update downgrades that principal to read; adding update upgrades them. If the same request contains both operations for a principal, update takes precedence.

Reasserting a principal's existing permission is idempotent and returns a successful response without creating a duplicate entry.

Permissions required: Permission to edit the whiteboard or administer the space.

POST /whiteboards/{id}/permissions

Flag	Type	Required	Description
--allow-self-lockout	string	No	If false (default), the request is rejected when it would remove the calling user's own edit access.
Set to true to allow the operation even when it locks out the caller.
--body	string	No	request body (JSON string, @file, or - for stdin)
--id	string	Yes	The ID of the whiteboard.

Example:

cf whiteboards add-permissions --id <id>

create

Create whiteboard

Creates a whiteboard in the space.

Permissions required: Permission to view the corresponding space. Permission to create a whiteboard in the space.

POST /whiteboards

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--private	string	No	The whiteboard will be private. Only the user who creates this whiteboard will have permission to view and edit one.

Example:

cf whiteboards create

create-property

Create content property for whiteboard

Creates a new content property for a whiteboard.

Permissions required: Permission to update the whiteboard.

POST /whiteboards/{id}/properties

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--id	string	Yes	The ID of the whiteboard to create a property for.

Example:

cf whiteboards create-property --id <id>

delete

Delete whiteboard

Delete a whiteboard by id.

Deleting a whiteboard moves the whiteboard to the trash, where it can be restored later

Permissions required: Permission to view the whiteboard and its corresponding space. Permission to delete whiteboards in the space.

DELETE /whiteboards/{id}

Flag	Type	Required	Description
--id	string	Yes	The ID of the whiteboard to be deleted.

Example:

cf whiteboards delete --id <id>

delete-permissions

Delete whiteboard permissions

Deletes direct content permissions from a whiteboard. See DELETE /pages/{id}/permissions for filter semantics.

Permissions required: Permission to edit the whiteboard or administer the space.

DELETE /whiteboards/{id}/permissions

Flag	Type	Required	Description
--allow-self-lockout	string	No	If false (default), the request is rejected when it would remove the calling user's own edit access.
Set to true to allow the operation even when it locks out the caller.
--id	string	Yes	The ID of the whiteboard.
--operation	string	No	Filter by operation. Must be provided together with principal-type and principal-id.
--principal-id	string	No	Filter by principal ID. Must be provided together with principal-type.
--principal-type	string	No	Filter by principal type. Must be provided together with principal-id.

Example:

cf whiteboards delete-permissions --id <id>

delete-property-by-id

Delete content property for whiteboard by id

Deletes a content property for a whiteboard by its id.

Permissions required: Permission to edit the whiteboard.

DELETE /whiteboards/{whiteboard-id}/properties/{property-id}

Flag	Type	Required	Description
--property-id	string	Yes	The ID of the property to be deleted.
--whiteboard-id	string	Yes	The ID of the whiteboard the property belongs to.

Example:

cf whiteboards delete-property-by-id --property-id <property-id> --whiteboard-id <whiteboard-id>

get-ancestors

Get all ancestors of whiteboard

Returns all ancestors for a given whiteboard 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 whiteboard by id.

Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the whiteboard and its corresponding space

GET /whiteboards/{id}/ancestors

Flag	Type	Required	Description
--id	string	Yes	The ID of the whiteboard.
--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 whiteboards get-ancestors --id <id>

get-by-id

Get whiteboard by id

Returns a specific whiteboard.

Permissions required: Permission to view the whiteboard and its corresponding space.

GET /whiteboards/{id}

Flag	Type	Required	Description
--id	string	Yes	The ID of the whiteboard to be returned
--include-collaborators	string	No	Includes collaborators on the whiteboard.
--include-direct-children	string	No	Includes direct children of the whiteboard, as defined in the ChildrenResponse object.
--include-operations	string	No	Includes operations associated with this whiteboard 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 whiteboard 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 whiteboards get-by-id --id <id>

get-classification-level

Get whiteboard classification level

Returns the classification level for a specific whiteboard.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the whiteboard.

GET /whiteboards/{id}/classification-level

Flag	Type	Required	Description
--id	string	Yes	The ID of the whiteboard for which classification level should be returned.

Example:

cf whiteboards get-classification-level --id <id>

get-content-properties

Get content properties for whiteboard

Retrieves Content Properties tied to a specified whiteboard.

Permissions required: Permission to view the whiteboard.

GET /whiteboards/{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 whiteboard 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 whiteboards get-content-properties --id <id>

get-content-properties-by-id

Get content property for whiteboard by id

Retrieves a specific Content Property by ID that is attached to a specified whiteboard.

Permissions required: Permission to view the whiteboard.

GET /whiteboards/{whiteboard-id}/properties/{property-id}

Flag	Type	Required	Description
--property-id	string	Yes	The ID of the content property being requested.
--whiteboard-id	string	Yes	The ID of the whiteboard for which content properties should be returned.

Example:

cf whiteboards get-content-properties-by-id --property-id <property-id> --whiteboard-id <whiteboard-id>

get-descendants

Get descendants of a whiteboard

Returns descendants in the content tree for a given whiteboard 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:

• Get database by id
• Get embed by id
• Get folder by id
• Get page by id
• Get whiteboard by id.

Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the whiteboard and its corresponding space

GET /whiteboards/{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 whiteboard.
--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 whiteboards get-descendants --id <id>

get-direct-children

Get direct children of a whiteboard

Returns all children for given whiteboard 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:

• Get database by id
• Get embed by id
• Get folder by id
• Get page by id
• Get whiteboard by id.

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 /whiteboards/{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 whiteboard.
--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 whiteboards get-direct-children --id <id>

get-operations

Get permitted operations for a whiteboard

Returns the permitted operations on specific whiteboard.

Permissions required: Permission to view the whiteboard and its corresponding space.

GET /whiteboards/{id}/operations

Flag	Type	Required	Description
--id	string	Yes	The ID of the whiteboard for which operations should be returned.

Example:

cf whiteboards get-operations --id <id>

get-permissions

Get whiteboard permissions

Returns the direct content permissions on a whiteboard with optional filtering. Results are cursor-paginated (max 250 per page).

Permissions required: Permission to view the whiteboard.

GET /whiteboards/{id}/permissions

Flag	Type	Required	Description
--cursor	string	No	Opaque cursor for pagination. Use the value from the previous response's _links.next.
--id	string	Yes	The ID of the whiteboard.
--limit	string	No	Maximum number of permission entries to return. Must be between 1 and 250.
--operation	string	No	Filter by operation (read or update).
--principal-id	string	No	Filter by principal ID. Must be provided together with principal-type.
--principal-type	string	No	Filter by principal type (user or group). May be used without principal-id to return all permissions for that type.

Example:

cf whiteboards get-permissions --id <id>

get-restriction-state

Get whiteboard restriction state

Returns the restriction state of a whiteboard.

Permissions required: Permission to view the whiteboard.

GET /whiteboards/{id}/restriction-state

Flag	Type	Required	Description
--id	string	Yes	The ID of the whiteboard.

Example:

cf whiteboards get-restriction-state --id <id>

post-classification-level

Reset whiteboard classification level

Resets the classification level for a specific whiteboard for the space default classification level.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to view the whiteboard.

POST /whiteboards/{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 whiteboard for which classification level should be updated.

Example:

cf whiteboards post-classification-level --id <id>

put-classification-level

Update whiteboard classification level

Updates the classification level for a specific whiteboard.

Permissions required: 'Permission to access the Confluence site ('Can use' global permission) and permission to edit the whiteboard.

PUT /whiteboards/{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 whiteboard for which classification level should be updated.

Example:

cf whiteboards put-classification-level --id <id>

set-permissions

Set whiteboard permissions

Replaces all direct content permissions on a whiteboard with the provided set.

Permissions required: Permission to edit the whiteboard or administer the space.

PUT /whiteboards/{id}/permissions

Flag	Type	Required	Description
--allow-self-lockout	string	No	If false (default), the request is rejected when it would remove the calling user's own edit access.
Set to true to allow the operation even when it locks out the caller.
--body	string	No	request body (JSON string, @file, or - for stdin)
--id	string	Yes	The ID of the whiteboard.

Example:

cf whiteboards set-permissions --id <id>

set-restriction-state

Set whiteboard restriction state

Sets the restriction state of a whiteboard.

Permissions required: Permission to edit the whiteboard or administer the space.

PUT /whiteboards/{id}/restriction-state

Flag	Type	Required	Description
--allow-self-lockout	string	No	If false (default), the request is rejected when it would remove the calling user's own edit access.
Set to true to allow the operation even when it locks out the caller.
--body	string	No	request body (JSON string, @file, or - for stdin)
--id	string	Yes	The ID of the whiteboard.

Example:

cf whiteboards set-restriction-state --id <id>

update-property-by-id

Update content property for whiteboard by id

Update a content property for a whiteboard by its id.

Permissions required: Permission to edit the whiteboard.

PUT /whiteboards/{whiteboard-id}/properties/{property-id}

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--property-id	string	Yes	The ID of the property to be updated.
--whiteboard-id	string	Yes	The ID of the whiteboard the property belongs to.

Example:

cf whiteboards update-property-by-id --property-id <property-id> --whiteboard-id <whiteboard-id>