nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Using the REST API, I need to get a list of all spaces with the status if archived or not

Robert Gottesman

I need to get a list of all spaces and included if archived (or not).

I have successfully retrieved a list of all of my spaces using

url = ... rest/api/space
url = ... rest/spacedirectory/1/search?type=global

Both cases do not return the status value if archived or not. I've tried adding 'status' to expand but that doesn't help.

So, how can I tell if the space is archived or not?

Accepted answers

unknown

Filter the search results using the status parameter. Its value can be either 'archived' or 'current'

IE /wiki/rest/api/space?status=archived

Refer to this section of the Confluence REST API documentation for more info.

All comments

unknown

Filter the search results using the status parameter. Its value can be either 'archived' or 'current'

IE /wiki/rest/api/space?status=archived

Refer to this section of the Confluence REST API documentation for more info.

Robert Gottesman

Hi Dave,

Well, you were close. I really wanted to retrieve all Spaces then see each space's status value. However, reading your link, all I have to do is put status in the expand to see the status value.

However, my focus right now is on Confluence Server and the link you sent does not work for Server. The confluence server documentation is not as robust as cloud and reading it does not give me an obvious way to get the 'status' field back with each space.

This is the page I'm looking at for the server REST API - Space

unknown

The query for Confluence Server and Cloud look to be identical to me. Both have an identical endpoint "/rest/api/space" and both support the use of the status= parameter to filter the results.

When you submit a request to http://your_confluence_url/confluence/rest/api/space?status=archived , as per the Confluence Server documentation, does it or does it not return list of archived spaces?

According to the documentation, that endpoint can return the value of the status of the content of a space, but you have to ask for it specifically using the expand= parameter. On the documentation page, click the button 'schema' to see all the properties that can be returned. A few lines down down you'll see:

"content": {
  "title": "Content",
  "type": "object",
  "properties": {
    "status": {
      "title": "Content Status",
      "type": "object"
    },
} <br>

If you provide http://your_confluence_url/confluence/rest/api/space?expand then you should be given a list of what properties can be expanded.

So, I'm guessing the expanded request would be http://your_confluence_url/confluence/rest/api/space?expand=definitions or http://your_confluence_url/confluence/rest/api/space?expand=definitions.content

Sorry, I don't have access to a Confluence Server ATM to test this, so just report your result.

Robert Gottesman

Hi Dave,

OK, my Server query does work correctly when I use

http://your_confluence_url/confluence/rest/api/space?status=archived

Where the Cloud and Server separate is on the results. I've tried many expand combinations but I can't get anything from the content structure.

As a side note, for the server query, _expandable returns

"_expandable":{"metadata":"","icon":"","description":"","homepage":"/rest/api/content/15nnnn"}}

I can expand on only those values (like homepage) and get the expected results.

I've tried expanding with: 'defintions', 'defintions.content', 'content', 'content.status', etc. .. all have no effect.

The good news .. I can just search the specific status value and combine as needed. But this is just a haunting curiosity why I can't retrieve back any of values under content.

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

confluence

server

confluence-server

rest-api

atl-gruland