Atlassian Content Restrictions API

The Content Restrictions API from Atlassian — 6 operation(s) for content restrictions.

Documentation GitHub OpenAPI

Operations 15

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /wiki/rest/api/content/{id}/restriction List the restrictions on a page · Atlassian Get Restrictions #

Ask an LLM

“Who is allowed to view or edit a restricted Confluence page?”

“What read and update restrictions are on a piece of content?”

Tell an agent

Show every restriction currently on content {id}.

List up to {limit} users and groups restricted on page {id}.

PUT /wiki/rest/api/content/{id}/restriction Replace the restrictions on a page · Atlassian Update Restrictions #

Ask an LLM

“Can I overwrite all existing view and edit restrictions on a page at once?”

“How do I replace a page's restrictions instead of adding to them?”

Tell an agent

Replace the restrictions on content {id}.

Overwrite the existing read and update restrictions on page {id}.

POST /wiki/rest/api/content/{id}/restriction Add restrictions to a page · Atlassian Add Restrictions #

Ask an LLM

“Can I add more restrictions to a page without wiping the current ones?”

“Which permission do I need to add restrictions to content?”

Tell an agent

Add restrictions to content {id}.

Add new restrictions to page {id} while keeping the existing ones.

DELETE /wiki/rest/api/content/{id}/restriction Remove all restrictions from a page · Atlassian Delete Restrictions #

Ask an LLM

“How do I make a restricted page open to everyone again?”

“Can I clear every read and update restriction on content in one step?”

Tell an agent destructive · confirm first

Remove all restrictions from content {id}.

Clear every view and edit restriction on page {id}.

GET /wiki/rest/api/content/{id}/restriction/byOperation Get a page's restrictions grouped by operation · Atlassian Get Restrictions By Operation #

Ask an LLM

“Can I see a page's read and update restrictions keyed by operation?”

“What does each operation's restriction look like on a piece of content?”

Tell an agent

Show the restrictions on content {id} grouped by operation.

Get page {id}'s restrictions keyed by read and update.

GET /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey} Get a page's restrictions for one operation · Atlassian Get Restrictions For Operation #

Ask an LLM

“Who is restricted from editing a particular page?”

“What are only the read restrictions on a piece of content?”

Tell an agent

Show only the {operationKey} restriction details for content {id}.

List up to {limit} users and groups in the {operationKey} restriction for page {id}.

GET /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName} Check a group's page restriction by name (deprecated) · Atlassian Get Content Restriction Status For Group #

Ask an LLM

“Does a restriction apply to a group I know only by its group name?”

“Is there a legacy name-based way to check a group against a page restriction?”

Tell an agent

Check by group name whether {groupName} is in the {operationKey} restriction on content {id}.

Use the deprecated name lookup to see if group {groupName} has {operationKey} on page {id}.

PUT /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName} Add a group to a page restriction by name (deprecated) · Atlassian Add Group To Content Restriction #

Ask an LLM

“Can I still grant a group page access using its name instead of its ID?”

“Is the group-name version of adding a restriction deprecated?”

Tell an agent

Add group named {groupName} to the {operationKey} restriction on content {id}.

Using the legacy name endpoint, grant {groupName} {operationKey} on page {id}.

DELETE /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName} Remove a group from a page restriction by name · Atlassian Remove Group From Content Restriction #

Ask an LLM

“How do I drop a group from a page restriction when I only know the group name?”

“Is removing a group by name from content restrictions still supported?”

Tell an agent destructive · confirm first

Remove group named {groupName} from the {operationKey} restriction on content {id}.

Via the deprecated name endpoint, revoke {groupName}'s {operationKey} access to page {id}.

GET /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId} Check if a group ID is in a page restriction · Atlassian Get Content Restriction Status For Group #

Ask an LLM

“Does a page's read restriction include a group with a given group ID?”

“Can I verify by group ID whether a group may update a piece of content?”

Tell an agent

Check whether group ID {groupId} is in the {operationKey} restriction on content {id}.

Tell me if group {groupId} holds {operationKey} on page {id}.

PUT /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId} Add a group to a page restriction by group ID · Atlassian Add Group To Content Restriction #

Ask an LLM

“How do I give a group read access to a restricted page using its group ID?”

“Can I grant a group update permission on one piece of content?”

Tell an agent

Add group ID {groupId} to the {operationKey} restriction on content {id}.

Grant group {groupId} {operationKey} permission on page {id}.

DELETE /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId} Remove a group from a page restriction by group ID · Atlassian Remove Group From Content Restriction #

Ask an LLM

“How do I take away a group's update permission on a page using its group ID?”

“Can I remove a group ID from a page's read restriction?”

Tell an agent destructive · confirm first

Remove group ID {groupId} from the {operationKey} restriction on content {id}.

Revoke group {groupId}'s {operationKey} permission on page {id}.

GET /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user Check if a user is in a page restriction · Atlassian Get Content Restriction Status For User #

Ask an LLM

“Is a particular person included in a page's read restriction?”

“Can I check by account ID whether someone may edit restricted content?”

Tell an agent

Check whether user {accountId} is in the {operationKey} restriction on content {id}.

Tell me if account {accountId} holds {operationKey} on page {id}.

PUT /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user Add a user to a page restriction · Atlassian Add User To Content Restriction #

Ask an LLM

“How do I let one specific person view a restricted Confluence page?”

“Can I grant an individual user edit rights on restricted content?”

Tell an agent

Add user {accountId} to the {operationKey} restriction on content {id}.

Grant account {accountId} {operationKey} permission on page {id}.

DELETE /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user Remove a user from a page restriction · Atlassian Remove User From Content Restriction #

Ask an LLM

“How do I take one person off a page's restriction list?”

“Can I revoke an individual user's edit rights on restricted content?”

Tell an agent destructive · confirm first

Remove user {accountId} from the {operationKey} restriction on content {id}.

Revoke account {accountId}'s {operationKey} permission on page {id}.

Atlassian Content Restrictions API

Operations 15

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification