custom-content

create-custom-content

Create custom content with storage format body

POST /custom-content

Flag	Type	Required	Description
--body	string	No	Custom content body in storage format XML (required)
--space-id	string	No	Space ID to create custom content in (required)
--title	string	No	Custom content title (required)
--type	string	No	Custom content type (required, e.g. ac:app:type)

Example:

cf custom-content create-custom-content

create-custom-content-property

Create content property for custom content

Creates a new content property for a piece of custom content.

Permissions required: Permission to update the custom content.

POST /custom-content/{custom-content-id}/properties

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

Example:

cf custom-content create-custom-content-property --custom-content-id <custom-content-id>

delete-custom-content

Delete custom content (moves to trash)

DELETE /custom-content/{id}

Flag	Type	Required	Description
--id	string	No	Custom content ID to delete (required)

Example:

cf custom-content delete-custom-content

delete-custom-content-property-by-id

Delete content property for custom content by id

Deletes a content property for a piece of custom content by its id.

Permissions required: Permission to edit the custom content.

DELETE /custom-content/{custom-content-id}/properties/{property-id}

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

Example:

cf custom-content delete-custom-content-property-by-id --custom-content-id <custom-content-id> --property-id <property-id>

get-child-custom-content

Get child custom content

Returns all child custom content for given custom content id. 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 access the Confluence site ('Can use' global permission). Only custom content that the user has permission to view will be returned.

GET /custom-content/{id}/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 custom content. If you don't know the custom content ID, use Get custom-content and filter the results.
--limit	string	No	Maximum number of pages 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 custom-content get-child-custom-content --id <id>

get-custom-content-attachments

Get attachments for custom content

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.

GET /custom-content/{id}/attachments

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.
--filename	string	No	Filters on the file-name of attachments. Only one may be specified.
--id	string	Yes	The ID of the custom content for which attachments should be returned.
--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.
--mediaType	string	No	Filters on the mediaType of attachments. Only one may be specified.
--sort	string	No	Used to sort the result by a particular field.
--status	string	No	Filter the results to attachments based on their status. By default, current and archived are used.

Example:

cf custom-content get-custom-content-attachments --id <id>

get-custom-content-by-id

Get custom content by ID with storage body

GET /custom-content/{id}

Flag	Type	Required	Description
--body-format	string	No	Body format (default: storage)
--id	string	No	Custom content ID (required)

Example:

cf custom-content get-custom-content-by-id

get-custom-content-by-type

Get custom content by type

GET /custom-content

Flag	Type	Required	Description
--space-id	string	No	Filter by space ID
--type	string	No	Custom content type (required, e.g. ac:app:type)

Example:

cf custom-content get-custom-content-by-type

get-custom-content-comments

Get custom content comments

Returns the comments of the 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 custom content and its corresponding containers.

GET /custom-content/{id}/footer-comments

Flag	Type	Required	Description
--body-format	string	No	The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
--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 custom content for which comments should be returned.
--limit	string	No	Maximum number of comments 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 custom-content get-custom-content-comments --id <id>

get-custom-content-content-properties

Get content properties for custom content

Retrieves Content Properties tied to a specified custom content.

Permissions required: Permission to view the custom content.

GET /custom-content/{custom-content-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.
--custom-content-id	string	Yes	The ID of the custom content 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 custom-content get-custom-content-content-properties --custom-content-id <custom-content-id>

get-custom-content-content-properties-by-id

Get content property for custom content by id

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

Permissions required: Permission to view the page.

GET /custom-content/{custom-content-id}/properties/{property-id}

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

Example:

cf custom-content get-custom-content-content-properties-by-id --custom-content-id <custom-content-id> --property-id <property-id>

get-custom-content-labels

Get labels for custom content

Returns the labels for a specific piece of 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 custom content and its corresponding space. Only labels that the user has permission to view will be returned.

GET /custom-content/{id}/labels

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 custom content for which labels should be returned.
--limit	string	No	Maximum number of labels 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.
--prefix	string	No	Filter the results to labels based on their prefix.
--sort	string	No	Used to sort the result by a particular field.

Example:

cf custom-content get-custom-content-labels --id <id>

get-custom-content-operations

Get permitted operations for custom content

Returns the permitted operations on specific custom content.

Permissions required: Permission to view the parent content of the custom content and its corresponding space.

GET /custom-content/{id}/operations

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

Example:

cf custom-content get-custom-content-operations --id <id>

get-custom-content-version-details

Get version details for custom content version

Retrieves version details for the specified custom content and version number.

Permissions required: Permission to view the page.

GET /custom-content/{custom-content-id}/versions/{version-number}

Flag	Type	Required	Description
--custom-content-id	string	Yes	The ID of the custom content for which version details should be returned.
--version-number	string	Yes	The version number of the custom content to be returned.

Example:

cf custom-content get-custom-content-version-details --custom-content-id <custom-content-id> --version-number <version-number>

get-custom-content-versions

Get custom content versions

Returns the versions of specific custom content.

Permissions required: Permission to view the custom content and its corresponding page and space.

GET /custom-content/{custom-content-id}/versions

Flag	Type	Required	Description
--body-format	string	No	The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.

Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned. | | --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. | | --custom-content-id | string | Yes | The ID of the custom content to be queried for its versions. If you don't know the custom content ID, use Get custom-content by type and filter the results. | | --limit | string | No | Maximum number of versions 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 custom-content get-custom-content-versions --custom-content-id <custom-content-id>

update-custom-content

Update custom content with automatic version increment

PUT /custom-content/{id}

Flag	Type	Required	Description
--body	string	No	Custom content body in storage format XML (required)
--id	string	No	Custom content ID to update (required)
--title	string	No	Custom content title (required)
--type	string	No	Custom content type (optional; auto-detected from existing item if omitted)

Example:

cf custom-content update-custom-content

update-custom-content-property-by-id

Update content property for custom content by id

Update a content property for a piece of custom content by its id.

Permissions required: Permission to edit the custom content.

PUT /custom-content/{custom-content-id}/properties/{property-id}

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

Example:

cf custom-content update-custom-content-property-by-id --custom-content-id <custom-content-id> --property-id <property-id>