Support for Server products ended Feb. 15, 2024. Learn what this means for you.

Server

Confluence Data Center / / REST API

Space

Operations

PUT/rest/api/space/{spaceKey}/archive GET/rest/api/space/{spaceKey}/content GET/rest/api/space/{spaceKey}/trash DEL/rest/api/space/{spaceKey}/trash GET/rest/api/space/{spaceKey}/content/{type}POST/rest/api/space/personal POST/rest/api/space/_private GET/rest/api/space POST/rest/api/space GET/rest/api/space/{spaceKey}PUT/rest/api/space/{spaceKey}DEL/rest/api/space/{spaceKey}PUT/rest/api/space/{spaceKey}/restore

PUT

Archive space

Archive the given Space identified by spaceKey. This method is idempotent i.e., if the Space is already archived then no action will be taken.

Request

Path parameters

spaceKey

string

Required

Responses

No Content if the Space is archived successfully or already has status 'ARCHIVED'.

PUT/rest/api/space/{spaceKey}/archive

curl

Node.js

Java

Python

PHP

1
2

curl --request PUT \
  --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/archive'

GET

Get contents in space

Returns the content in this given space.

Example request URI:

http://example.com/confluence/rest/api/space/TEST/content?expand=history

Request

Path parameters

spaceKey

string

Required

Query parameters

expand

string

depth

string

limit

string

start

string

Responses

Returns a full JSON representation of a piece of content.

application/json

object

GET/rest/api/space/{spaceKey}/content

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/content' \
  --header 'Accept: application/json'

200Response

{
  "results": [
    {
      "id": "123456",
      "type": "page",
      "status": "current",
      "title": "My Page",
      "links": {},
      "space": {
        "id": 123456,
        "key": "TEST",
        "name": "Test Space",
        "status": "current",
        "icon": {},
        "description": {},
        "homepage": {},
        "links": {},
        "type": "global",
        "creator": {},
        "creationDate": "2024-01-01T00:00:00Z",
        "lastModifier": {},
        "lastModificationDate": "2024-01-01T00:00:00Z",
        "metadata": {
          "labels": [
            "label1",
            "label2"
          ]
        },
        "retentionPolicy": {},
        "permissions": {}
      },
      "history": {
        "previousVersion": {},
        "nextVersion": {},
        "lastUpdated": {},
        "latest": true,
        "createdBy": {},
        "createdDate": "2020-01-01T00:00:00Z",
        "contributors": {},
        "contentParentRef": {},
        "lastUpdatedRef": {},
        "nextVersionRef": {},
        "previousVersionRef": {}
      },
      "version": {
        "by": {},
        "when": "2020-01-01T00:00:00Z",
        "message": "A message",
        "number": 1,
        "minorEdit": true,
        "hidden": true,
        "syncRev": "123456",
        "content": {},
        "contentRef": {}
      },
      "ancestors": [],
      "position": 1,
      "operations": [
        {
          "operation": "read",
          "targetType": "page"
        }
      ],
      "children": {},
      "descendants": {},
      "body": {},
      "metadata": {
        "key": "value"
      },
      "extensions": {
        "key": "value"
      },
      "restrictions": {
        "use": {
          "operation": "use",
          "restrictions": []
        }
      },
      "relevantViewRestrictions": {
        "idProperties": {},
        "expanded": true
      },
      "versionRef": {
        "idProperties": {},
        "expanded": true
      },
      "containerRef": {
        "idProperties": {},
        "expanded": true
      },
      "historyRef": {
        "idProperties": {},
        "expanded": true
      },
      "spaceRef": {
        "idProperties": {},
        "expanded": true
      }
    }
  ],
  "totalCount": 2154,
  "start": 25,
  "limit": 25,
  "size": 25,
  "_links": {
    "base": "http://localhost:8085/confluence",
    "context": "confluence",
    "self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25",
    "next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50",
    "prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0"
  }
}

GET

Get trash contents of space

Returns the trash contents in this given space.

Example request URI:

http://example.com/confluence/rest/api/space/TEST/trash?limit=100&cursor=content:false:612345

Request

Path parameters

spaceKey

string

Required

Query parameters

cursor

string

expand

string

limit

string

Responses

Returns an array of full JSON representations of trash contents.

application/json

object

GET/rest/api/space/{spaceKey}/trash

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/trash' \
  --header 'Accept: application/json'

200Response

{
  "results": [
    {
      "id": "123456",
      "type": "page",
      "status": "current",
      "title": "My Page",
      "links": {},
      "space": {
        "id": 123456,
        "key": "TEST",
        "name": "Test Space",
        "status": "current",
        "icon": {},
        "description": {},
        "homepage": {},
        "links": {},
        "type": "global",
        "creator": {},
        "creationDate": "2024-01-01T00:00:00Z",
        "lastModifier": {},
        "lastModificationDate": "2024-01-01T00:00:00Z",
        "metadata": {
          "labels": [
            "label1",
            "label2"
          ]
        },
        "retentionPolicy": {},
        "permissions": {}
      },
      "history": {
        "previousVersion": {},
        "nextVersion": {},
        "lastUpdated": {},
        "latest": true,
        "createdBy": {},
        "createdDate": "2020-01-01T00:00:00Z",
        "contributors": {},
        "contentParentRef": {},
        "lastUpdatedRef": {},
        "nextVersionRef": {},
        "previousVersionRef": {}
      },
      "version": {
        "by": {},
        "when": "2020-01-01T00:00:00Z",
        "message": "A message",
        "number": 1,
        "minorEdit": true,
        "hidden": true,
        "syncRev": "123456",
        "content": {},
        "contentRef": {}
      },
      "ancestors": [],
      "position": 1,
      "operations": [
        {
          "operation": "read",
          "targetType": "page"
        }
      ],
      "children": {},
      "descendants": {},
      "body": {},
      "metadata": {
        "key": "value"
      },
      "extensions": {
        "key": "value"
      },
      "restrictions": {
        "use": {
          "operation": "use",
          "restrictions": []
        }
      },
      "relevantViewRestrictions": {
        "idProperties": {},
        "expanded": true
      },
      "versionRef": {
        "idProperties": {},
        "expanded": true
      },
      "containerRef": {
        "idProperties": {},
        "expanded": true
      },
      "historyRef": {
        "idProperties": {},
        "expanded": true
      },
      "spaceRef": {
        "idProperties": {},
        "expanded": true
      }
    }
  ],
  "nextCursor": "cursortype:false:360456",
  "prevCursor": "cursortype:true:360423",
  "totalCount": 2154,
  "cursor": "cursortype:false:360422",
  "limit": 25,
  "size": 25,
  "_links": {
    "base": "http://localhost:8085/confluence",
    "context": "confluence",
    "self": "http://localhost:8085/confluence/rest/api/..?limit=25",
    "next": "http://localhost:8085/confluence/rest/api/latest/..?limit=25&cursor=cursortype%3Afalse%3A360456",
    "prev": "http://localhost:8085/confluence/rest/api/latest/..?limit=25&cursor=cursortype%3Atrue%3A360423"
  }
}

DEL

Remove all trash contents

Remove all content from the trash in the given space, deleting them permanently.Example request URI:

http://example.com/confluence/rest/api/space/TEST/trash

Request

Path parameters

spaceKey

string

Required

Responses

Returns no content if trash is emptied successfully

DEL/rest/api/space/{spaceKey}/trash

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/trash'

GET

Get contents by type

Returns the content in this given space with the given type.

Example request URI:

http://example.com/confluence/rest/api/space/TEST/content/page?expand=history

Request

Path parameters

spaceKey

string

Required

type

string

Required

Query parameters

expand

string

depth

string

limit

string

start

string

Responses

Returns a full JSON representation of a piece of content.

application/json

object

GET/rest/api/space/{spaceKey}/content/{type}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/content/{type}' \
  --header 'Accept: application/json'

200Response

{
  "results": [
    {
      "id": "123456",
      "type": "page",
      "status": "current",
      "title": "My Page",
      "links": {},
      "space": {
        "id": 123456,
        "key": "TEST",
        "name": "Test Space",
        "status": "current",
        "icon": {},
        "description": {},
        "homepage": {},
        "links": {},
        "type": "global",
        "creator": {},
        "creationDate": "2024-01-01T00:00:00Z",
        "lastModifier": {},
        "lastModificationDate": "2024-01-01T00:00:00Z",
        "metadata": {
          "labels": [
            "label1",
            "label2"
          ]
        },
        "retentionPolicy": {},
        "permissions": {}
      },
      "history": {
        "previousVersion": {},
        "nextVersion": {},
        "lastUpdated": {},
        "latest": true,
        "createdBy": {},
        "createdDate": "2020-01-01T00:00:00Z",
        "contributors": {},
        "contentParentRef": {},
        "lastUpdatedRef": {},
        "nextVersionRef": {},
        "previousVersionRef": {}
      },
      "version": {
        "by": {},
        "when": "2020-01-01T00:00:00Z",
        "message": "A message",
        "number": 1,
        "minorEdit": true,
        "hidden": true,
        "syncRev": "123456",
        "content": {},
        "contentRef": {}
      },
      "ancestors": [],
      "position": 1,
      "operations": [
        {
          "operation": "read",
          "targetType": "page"
        }
      ],
      "children": {},
      "descendants": {},
      "body": {},
      "metadata": {
        "key": "value"
      },
      "extensions": {
        "key": "value"
      },
      "restrictions": {
        "use": {
          "operation": "use",
          "restrictions": []
        }
      },
      "relevantViewRestrictions": {
        "idProperties": {},
        "expanded": true
      },
      "versionRef": {
        "idProperties": {},
        "expanded": true
      },
      "containerRef": {
        "idProperties": {},
        "expanded": true
      },
      "historyRef": {
        "idProperties": {},
        "expanded": true
      },
      "spaceRef": {
        "idProperties": {},
        "expanded": true
      }
    }
  ],
  "totalCount": 2154,
  "start": 25,
  "limit": 25,
  "size": 25,
  "_links": {
    "base": "http://localhost:8085/confluence",
    "context": "confluence",
    "self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25",
    "next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50",
    "prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0"
  }
}

POST

Creates the personal Space for self.

Creates a personal space for self.

Example request URI:

http://example.com/confluence/rest/api/space/personal

Request

Request bodyapplication/json

The personal space to be created

description

object

isPrivate

boolean

private

boolean

Responses

Returns a full JSON representation of a space.

application/json

Space

POST/rest/api/space/personal

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'http://{baseurl}/confluence/rest/api/space/personal' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": {},
  "isPrivate": true,
  "private": true
}'

200Response

{
  "id": 123456,
  "key": "TEST",
  "name": "Test Space",
  "status": "current",
  "icon": {
    "idProperties": {},
    "expanded": true
  },
  "description": {},
  "homepage": {
    "idProperties": {},
    "expanded": true
  },
  "links": {},
  "type": "global",
  "creator": {
    "profilePicture": {
      "path": "http://www.example.com/path/to/image.png",
      "width": 16,
      "height": 16,
      "isDefault": true
    },
    "displayName": "Joe Smith",
    "type": "<string>"
  },
  "creationDate": "2024-01-01T00:00:00Z",
  "lastModifier": {
    "profilePicture": {
      "path": "http://www.example.com/path/to/image.png",
      "width": 16,
      "height": 16,
      "isDefault": true
    },
    "displayName": "Joe Smith",
    "type": "<string>"
  },
  "lastModificationDate": "2024-01-01T00:00:00Z",
  "metadata": {
    "labels": [
      "label1",
      "label2"
    ]
  },
  "retentionPolicy": {
    "idProperties": {},
    "expanded": true
  },
  "permissions": {
    "idProperties": {},
    "expanded": true
  }
}

POST

Create private space

Creates a new private Space, viewable only by its creator. The incoming Space does not include an id, but must include a Key and Name, and should include a Description.

Request

Request bodyapplication/json

The space to be created

integer

key

string

name

string

status

string

icon

ReferenceIcon

description

object

homepage

ReferenceContent

links

object

type

string

creator

Person

Responses

Returns a full JSON representation of a space.

application/json

Space

POST/rest/api/space/_private

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'http://{baseurl}/confluence/rest/api/space/_private' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 123456,
  "key": "TEST",
  "name": "Test Space",
  "status": "current",
  "icon": {
    "idProperties": {},
    "expanded": true
  },
  "description": {},
  "homepage": {
    "idProperties": {},
    "expanded": true
  },
  "links": {},
  "type": "global",
  "creator": {
    "profilePicture": {
      "path": "http://www.example.com/path/to/image.png",
      "width": 16,
      "height": 16,
      "isDefault": true
    },
    "displayName": "Joe Smith",
    "type": "<string>"
  },
  "creationDate": "2024-01-01T00:00:00Z",
  "lastModifier": {
    "profilePicture": {
      "path": "http://www.example.com/path/to/image.png",
      "width": 16,
      "height": 16,
      "isDefault": true
    },
    "displayName": "Joe Smith",
    "type": "<string>"
  },
  "lastModificationDate": "2024-01-01T00:00:00Z",
  "metadata": {
    "labels": [
      "label1",
      "label2"
    ]
  },
  "retentionPolicy": {
    "idProperties": {},
    "expanded": true
  },
  "permissions": {
    "idProperties": {},
    "expanded": true
  }
}'

200Response

{
  "id": 123456,
  "key": "TEST",
  "name": "Test Space",
  "status": "current",
  "icon": {
    "idProperties": {},
    "expanded": true
  },
  "description": {},
  "homepage": {
    "idProperties": {},
    "expanded": true
  },
  "links": {},
  "type": "global",
  "creator": {
    "profilePicture": {
      "path": "http://www.example.com/path/to/image.png",
      "width": 16,
      "height": 16,
      "isDefault": true
    },
    "displayName": "Joe Smith",
    "type": "<string>"
  },
  "creationDate": "2024-01-01T00:00:00Z",
  "lastModifier": {
    "profilePicture": {
      "path": "http://www.example.com/path/to/image.png",
      "width": 16,
      "height": 16,
      "isDefault": true
    },
    "displayName": "Joe Smith",
    "type": "<string>"
  },
  "lastModificationDate": "2024-01-01T00:00:00Z",
  "metadata": {
    "labels": [
      "label1",
      "label2"
    ]
  },
  "retentionPolicy": {
    "idProperties": {},
    "expanded": true
  },
  "permissions": {
    "idProperties": {},
    "expanded": true
  }
}

GET

Get spaces by key

Returns information about a number of spaces.

Example request URI(s):

http://example.com/confluence/rest/api/space?spaceKey=TST&spaceKey=ds

Request

Query parameters

spaceKeySingle

string

start

string

label

string

favourite

string

type

string

spaceKey

string

spaceId

array<string>

expand

string

hasRetentionPolicy

string

limit

string

Request bodyapplication/json

string

Responses

Returns an array of full JSON representations of found space.

application/json

object

GET/rest/api/space

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/confluence/rest/api/space' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '"<string>"'

200Response

{
  "results": [
    {
      "id": 123456,
      "key": "TEST",
      "name": "Test Space",
      "status": "current",
      "icon": {
        "idProperties": {},
        "expanded": true
      },
      "description": {},
      "homepage": {
        "idProperties": {},
        "expanded": true
      },
      "links": {},
      "type": "global",
      "creator": {
        "profilePicture": {},
        "displayName": "Joe Smith",
        "type": "<string>"
      },
      "creationDate": "2024-01-01T00:00:00Z",
      "lastModifier": {
        "profilePicture": {},
        "displayName": "Joe Smith",
        "type": "<string>"
      },
      "lastModificationDate": "2024-01-01T00:00:00Z",
      "metadata": {
        "labels": [
          "label1",
          "label2"
        ]
      },
      "retentionPolicy": {
        "idProperties": {},
        "expanded": true
      },
      "permissions": {
        "idProperties": {},
        "expanded": true
      }
    }
  ],
  "totalCount": 2154,
  "start": 25,
  "limit": 25,
  "size": 25,
  "_links": {
    "base": "http://localhost:8085/confluence",
    "context": "confluence",
    "self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25",
    "next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50",
    "prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0"
  }
}

POST

Creates a new Space.

Creates a new Space. The incoming Space does not include an id, but must include a Key and Name, and should include a Description.

Request

Request bodyapplication/json

The space to be created

integer

key

string

name

string

status

string

icon

ReferenceIcon

description

object

homepage

ReferenceContent

links

object

type

string

creator

Person

Responses

Returns a full JSON representation of a space.

application/json

Space

POST/rest/api/space

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'http://{baseurl}/confluence/rest/api/space' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 123456,
  "key": "TEST",
  "name": "Test Space",
  "status": "current",
  "icon": {
    "idProperties": {},
    "expanded": true
  },
  "description": {},
  "homepage": {
    "idProperties": {},
    "expanded": true
  },
  "links": {},
  "type": "global",
  "creator": {
    "profilePicture": {
      "path": "http://www.example.com/path/to/image.png",
      "width": 16,
      "height": 16,
      "isDefault": true
    },
    "displayName": "Joe Smith",
    "type": "<string>"
  },
  "creationDate": "2024-01-01T00:00:00Z",
  "lastModifier": {
    "profilePicture": {
      "path": "http://www.example.com/path/to/image.png",
      "width": 16,
      "height": 16,
      "isDefault": true
    },
    "displayName": "Joe Smith",
    "type": "<string>"
  },
  "lastModificationDate": "2024-01-01T00:00:00Z",
  "metadata": {
    "labels": [
      "label1",
      "label2"
    ]
  },
  "retentionPolicy": {
    "idProperties": {},
    "expanded": true
  },
  "permissions": {
    "idProperties": {},
    "expanded": true
  }
}'

200Response

{
  "id": 123456,
  "key": "TEST",
  "name": "Test Space",
  "status": "current",
  "icon": {
    "idProperties": {},
    "expanded": true
  },
  "description": {},
  "homepage": {
    "idProperties": {},
    "expanded": true
  },
  "links": {},
  "type": "global",
  "creator": {
    "profilePicture": {
      "path": "http://www.example.com/path/to/image.png",
      "width": 16,
      "height": 16,
      "isDefault": true
    },
    "displayName": "Joe Smith",
    "type": "<string>"
  },
  "creationDate": "2024-01-01T00:00:00Z",
  "lastModifier": {
    "profilePicture": {
      "path": "http://www.example.com/path/to/image.png",
      "width": 16,
      "height": 16,
      "isDefault": true
    },
    "displayName": "Joe Smith",
    "type": "<string>"
  },
  "lastModificationDate": "2024-01-01T00:00:00Z",
  "metadata": {
    "labels": [
      "label1",
      "label2"
    ]
  },
  "retentionPolicy": {
    "idProperties": {},
    "expanded": true
  },
  "permissions": {
    "idProperties": {},
    "expanded": true
  }
}

GET

Get space

Returns information about a space.

Example request URI:

http://example.com/confluence/rest/api/space/TST?expand=description

Request

Path parameters

spaceKey

string

Required

Query parameters

expand

string

Responses

Returns a full JSON representation of a space.

application/json

Space

GET/rest/api/space/{spaceKey}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}' \
  --header 'Accept: application/json'

200Response

{
  "id": 123456,
  "key": "TEST",
  "name": "Test Space",
  "status": "current",
  "icon": {
    "idProperties": {},
    "expanded": true
  },
  "description": {},
  "homepage": {
    "idProperties": {},
    "expanded": true
  },
  "links": {},
  "type": "global",
  "creator": {
    "profilePicture": {
      "path": "http://www.example.com/path/to/image.png",
      "width": 16,
      "height": 16,
      "isDefault": true
    },
    "displayName": "Joe Smith",
    "type": "<string>"
  },
  "creationDate": "2024-01-01T00:00:00Z",
  "lastModifier": {
    "profilePicture": {
      "path": "http://www.example.com/path/to/image.png",
      "width": 16,
      "height": 16,
      "isDefault": true
    },
    "displayName": "Joe Smith",
    "type": "<string>"
  },
  "lastModificationDate": "2024-01-01T00:00:00Z",
  "metadata": {
    "labels": [
      "label1",
      "label2"
    ]
  },
  "retentionPolicy": {
    "idProperties": {},
    "expanded": true
  },
  "permissions": {
    "idProperties": {},
    "expanded": true
  }
}

PUT

Update Space

Updates a Space. The incoming Space must include a Key and Name, and should include a Description

Request

Path parameters

spaceKey

string

Required

Request bodyapplication/json

the space being updated

integer

key

string

name

string

status

string

icon

ReferenceIcon

description

object

homepage

ReferenceContent

links

object

type

string

creator

Person

Responses

Returns a full JSON representation of a space.

application/json

Space

PUT/rest/api/space/{spaceKey}

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 123456,
  "key": "TEST",
  "name": "Test Space",
  "status": "current",
  "icon": {
    "idProperties": {},
    "expanded": true
  },
  "description": {},
  "homepage": {
    "idProperties": {},
    "expanded": true
  },
  "links": {},
  "type": "global",
  "creator": {
    "profilePicture": {
      "path": "http://www.example.com/path/to/image.png",
      "width": 16,
      "height": 16,
      "isDefault": true
    },
    "displayName": "Joe Smith",
    "type": "<string>"
  },
  "creationDate": "2024-01-01T00:00:00Z",
  "lastModifier": {
    "profilePicture": {
      "path": "http://www.example.com/path/to/image.png",
      "width": 16,
      "height": 16,
      "isDefault": true
    },
    "displayName": "Joe Smith",
    "type": "<string>"
  },
  "lastModificationDate": "2024-01-01T00:00:00Z",
  "metadata": {
    "labels": [
      "label1",
      "label2"
    ]
  },
  "retentionPolicy": {
    "idProperties": {},
    "expanded": true
  },
  "permissions": {
    "idProperties": {},
    "expanded": true
  }
}'

200Response

{
  "id": 123456,
  "key": "TEST",
  "name": "Test Space",
  "status": "current",
  "icon": {
    "idProperties": {},
    "expanded": true
  },
  "description": {},
  "homepage": {
    "idProperties": {},
    "expanded": true
  },
  "links": {},
  "type": "global",
  "creator": {
    "profilePicture": {
      "path": "http://www.example.com/path/to/image.png",
      "width": 16,
      "height": 16,
      "isDefault": true
    },
    "displayName": "Joe Smith",
    "type": "<string>"
  },
  "creationDate": "2024-01-01T00:00:00Z",
  "lastModifier": {
    "profilePicture": {
      "path": "http://www.example.com/path/to/image.png",
      "width": 16,
      "height": 16,
      "isDefault": true
    },
    "displayName": "Joe Smith",
    "type": "<string>"
  },
  "lastModificationDate": "2024-01-01T00:00:00Z",
  "metadata": {
    "labels": [
      "label1",
      "label2"
    ]
  },
  "retentionPolicy": {
    "idProperties": {},
    "expanded": true
  },
  "permissions": {
    "idProperties": {},
    "expanded": true
  }
}

DEL

Delete Space

Deletes a Space. The space is deleted in a long running task, so the space cannot be considered deleted when this resource returns. Clients can follow the status link in the response and poll it until the task completes.

Request

Path parameters

spaceKey

string

Required

Responses

Returns a pointer to the status of the space-deletion task.

application/json

LongTaskSubmission

DEL/rest/api/space/{spaceKey}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}' \
  --header 'Accept: application/json'

202Response

{
  "id": "<string>",
  "links": {
    "result": "http://localhost:8080/confluence/rest/api/longtask/123/result",
    "status": "http://localhost:8080/confluence/rest/api/longtask/123/status"
  },
  "resultPath": "result",
  "statusPath": "status"
}

PUT

Restore space

Restore the given Space identified by spaceKey. This method is idempotent i.e., if the Space is already restored then no action will be taken.

Request

Path parameters

spaceKey

string

Required

Responses

No Content if the Space is restored successfully or already has status 'CURRENT'.

PUT/rest/api/space/{spaceKey}/restore

curl

Node.js

Java

Python

PHP

1
2

curl --request PUT \
  --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/restore'