• Admin Key
  • Attachment
  • Ancestors
  • Blog Post
  • Children
  • Classification Level
  • Comment
  • Content
  • Content Properties
  • Custom Content
  • Database
  • Data Policies
  • Descendants
  • Folder
  • Label
  • Like
  • Operation
  • Page
  • Redactions
  • Space
  • Space Permissions
  • Space Properties
  • Space Roles
  • Task
  • User
  • Version
  • Whiteboard
Cloud
Confluence Cloud / Reference / REST API v2

Admin Key

Postman Collection
OpenAPI
GET

Get Admin Key

Returns information about the admin key if one is currently enabled for the calling user within the site.

Permissions required: User must be an organization or site admin.

Scopes

Forge and OAuth2 apps cannot access this REST resource.

Connect apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Returned if an admin key is currently enabled for the calling user.

application/json

AdminKeyResponse
GET/admin-key
1 2 3 curl --request GET \ --url 'https://{your-domain}/wiki/api/v2/admin-key' \ --header 'Accept: application/json'
200Response
1 2 3 4 { "accountId": "<string>", "expirationTime": "<string>" }
POST

Enable Admin Key

Enables admin key access for the calling user within the site. If an admin key already exists for the user, a new one will be issued with an updated expiration time.

Note: The durationInMinutes field within the request body is optional. If the request body is empty or if the durationInMinutes is set to 0 minutes, a new admin key will be issued to the calling user with a default duration of 10 minutes.

Permissions required: User must be an organization or site admin.

Scopes

Forge and OAuth2 apps cannot access this REST resource.

Connect apps cannot access this REST resource.

Request

Request bodyapplication/json

durationInMinutes

integer

Responses

Returned if a new admin key is successfully issued for the calling user.

application/json

AdminKeyResponse
POST/admin-key
1 2 3 4 5 6 7 curl --request POST \ --url 'https://{your-domain}/wiki/api/v2/admin-key' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "durationInMinutes": 60 }'
200Response
1 2 3 4 { "accountId": "<string>", "expirationTime": "<string>" }
DEL

Disable Admin Key

Disables admin key access for the calling user within the site.

Permissions required: User must be an organization or site admin.

Scopes

Forge and OAuth2 apps cannot access this REST resource.

Connect apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Returned if admin key access was successfully disabled for the calling user or if the user did not have an admin key in the first place.

DEL/admin-key
1 2 curl --request DELETE \ --url 'https://{your-domain}/wiki/api/v2/admin-key'

Rate this page: