{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Content Properties API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Content Properties", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Get Content Properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/property", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to be queried for its properties." }, { "name": "key", "value": "", "type": "query", "description": "The key of the content property." }, { "name": "expand", "value": "", "type": "query", "description": "A multi-value parameter indicating which properties of the content to\nexpand. By default, the `version` object is expanded.\n\n- `content` returns the content that the property is stored against.\n- `version` returns information about the version of the property, such\nas the version number, when it was created, etc." }, { "name": "start", "value": "", "type": "query", "description": "The starting index of the returned properties." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of properties to return per page.\nNote, this may be restricted by fixed system limits." } ] }, "docs": "Returns the properties for a piece of content. For more information
about content properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
'View' permission for the space, and permission to view the content if it is a page." }, { "info": { "name": "Atlassian Create Content Property", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/property", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to add the property to." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a property for an existing piece of content. For more information
about content properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).

This is the same as [Create content property for key](#api-content-id-property-key-post)
except that the key is specified in the request body instead of as a
path parameter.

Content properties can also be added when creating a new piece of content
by includi" }, { "info": { "name": "Atlassian Get Content Property", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/property/:key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to be queried for the property." }, { "name": "key", "value": "", "type": "path", "description": "The key of the content property." }, { "name": "expand", "value": "", "type": "query", "description": "A multi-value parameter indicating which properties of the content to\nexpand. By default, the `version` object is expanded.\n\n- `content` returns the content that the property is stored against.\n- `version` returns information about the version of the property, such\nas the version number, when it was created, etc." }, { "name": "status", "value": "", "type": "query", "description": "Filter the results to a set of content based on their status. If set to `any`,\ncontent with any status is returned. By default it will fetch current and archived statuses `?status=current&status=archived`.\nAll supported statuses\n\n- any\n- archived\n- current\n- deleted\n- draft\n- trashed" } ] }, "docs": "Returns a content property for a piece of content. For more information, see
[Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
'View' permission for the space, and permission to view the content if it is a page." }, { "info": { "name": "Atlassian Create Content Property For Key", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/property/:key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to add the property to." }, { "name": "key", "value": "", "type": "path", "description": "The key of the content property. Required." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a property for an existing piece of content. For more information
about content properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).

This is the same as [Create content property](#api-content-id-property-post)
except that the key is specified as a path parameter instead of in the
request body.

Content properties can also be added when creating a new piece of content
by including them in t" }, { "info": { "name": "Atlassian Update Content Property", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/property/:key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content that the property belongs to." }, { "name": "key", "value": "", "type": "path", "description": "The key of the property." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing content property. This method will also create a new
property for a piece of content, if the property key does not exist and
the property version is 1. For more information about content properties, see
[Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to update the content." }, { "info": { "name": "Atlassian Delete Content Property", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/property/:key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content that the property belongs to." }, { "name": "key", "value": "", "type": "path", "description": "The key of the property." } ] }, "docs": "Deletes a content property. For more information about content properties, see
[Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to update the content." } ] } ], "bundled": true }