Versions Compared

Old Version 4

changes.mady.by.user Parsa Shiva

Saved on

compared with

New Version Current

changes.mady.by.user Lena Ryzhuk

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

You can manage your Confluence shares via web API by generating API Key. To do this, perform the following steps:

...

You may also pass additional fields:

Parameter Name

Description

Default

contentType

Type of Confluence content, such as “PAGE“ or “BLOGPOST“

PAGE

spaceId

ID of the Confluence space (shortens response time if specified)

null

name

Name of the link

External Share Link

showComments

All existing comments will be visible on shared link.

false

allowAddComment

Anyone with access to the link can add comments. showComments has to be set to true.

false

showAttachments

All existing attachments will be visible on shared link.

false

allowAddAttachment

Anyone with access to the link can add attachments. showAttachments has to be set to true.

false

allowRemoveUnsupportedMacros

Unsupported macros will be removed from the Share

false

showMacrosPlaceholder

Unsupported macros will be replaced with placeholders. allowRemoveUnsupportedMacros has to be set to true

false

allowShareChildPages

Child pages will be accessible with the same permissions as this parent link

false

showLabels

All page labels will be visible on the Shared Link

false

description

Description of the link. For internal purposes only.

null

expiration

Expiration timestamp in epoch miliseconds.

null

selectedUsersConfig

Pass this object to define list of users that can access the share. You can pass the following fields in this configuration:

  1. allowed - set to true if you want to allow access only to selected users.

  2. allowedNotification - if true, users will be notified via e-mail when added to the list

  3. list - list of e-mails that may access the share. Refer to example below to see how to correctly pass the e-mails.

Code Block
"selectedUsersConfig": {
		"allowed": true,
		"allowedNotification": false, 
		"list": [{"email": "expl@expl2.com"}, {"email": "expl@expl.com"}]
	}

null

Example Call:

Code Block
languagejson
POST https://confluence.external-share.com/webapi/share
{
	"contentId": "2556174",
	"contentType": "PAGE",
	"spaceId": "213516917",
	"description": "This is internal description - not visible on share",
	"name": "Name of the link - External Share Link if left empty",
	"showComments": true,
	"allowAddComment": false,
	"showAttachments": true,
	"selectedUsersConfig": {
		"allowed": true,
		"allowedNotification": false, 
		"list": [{"email": "expl@expl2.com"}, {"email": "expl@expl.com"}]
	}
}

...

Code Block
DELETE https://jiraconfluence.external-share.com/webapi/share/{ SHARE_UUID }