How to remotely set Space Status via XML-RPC

Still need help?

The Atlassian Community is here for you.

Ask the community


Platform Notice: Server and Data Center Only - This article only applies to Atlassian products on the server and data center platforms.

Purpose


This guide demonstrates a way to change your space status from "Current" to "Archived", or vice versa. We will be utilizing the setSpaceStatus from Remote Confluence methods to change the status of the target space.

(warning) Please do keep in mind that the XML-RPC and SOAP APIs are deprecated since Confluence 5.5. However, the setSpaceStatus will work for us in this particular case.


Solution

On the Confluence server, open up command-line interface and execute the following cURL command:

curl --user $USRNAME:$USRPWD -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d "{ \"jsonrpc\" : \"2.0\", \"method\" : \"setSpaceStatus\", \"params\" : [ \"$SPACEKEY\", \"$STATUS\"] , \"id\": 1 }" $CONFURL/rpc/json-rpc/confluenceservice-v2?os_authType=basic 2>/dev/null | python -mjson.tool 

(info) You will need to fill in the following argument according to your environment:

  • $USRNAME:$USRPWD as the username and password (seperated by a colon) of an administrator user
  • $SPACEKEY as the target space key 
  • $STATUS as either "CURRENT" and "ARCHIVED". (Set "CURRENT" to have the space in active state, Set "ARCHIEVED" to archive the space)
  • $CONFURL as the URL of your Confluence Server

Example and expected result:

Last modified on Jun 17, 2021

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.