---
title: "Upgrade and Pre-Upgrade checks REST API endpoints"
canonical: "https://support.appfire.com/space/CDML/654475468/Upgrade%20and%20Pre-Upgrade%20checks%20REST%20API%20endpoints"
format: markdown
---
> Macro (aura-html)


> Macro (excerpt)
> 
> [DATA CENTER] [Document Activity REST API] [UPGRADE CHECKS REST API]
> 
> # Overview
> 
> Several upgrade checks and pre-upgrade checks REST API endpoints can be used to retrieve information or run/cancel the pre-upgrade/upgrade checks process for the document activity upgrade.
> 
> > 📝 These REST API endpoints are provided for customers and partners to manage and run
> > 📝 
> > 📝 - pre-upgrade checks
> > 📝 - upgrade checks
> > 📝 
> > 📝 It is recommended that partners have an appropriate level of scripting expertise and knowledge.
> > 📝 
> > 📝 Global administrator permissions are required to use these endpoints.
> 
> | **Pre-upgrade checks REST API endpoints** | Available in<br>- [Comala Document Management v6.17+](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649825498) for data center and server
> - [Comala Document Management v6.17.11](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649955491)+ for server
> - [Comala Document Management v7.0](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649726102)+ for data center |
> | --- | --- |
> | **Upgrade checks REST API endpoints** | Available **ONLY** in<br>- [Comala Document Management v7.0](https://appfire.atlassian.net/wiki/spaces/CDML/pages/649726102)+ for data center |

# Upgrade and pre-upgrade checks REST API endpoints

The following actions can be performed using this REST API:

- Get a list of the spaces that have workflows and their upgrade status
- Get the specific upgrade status of a space
- Run the upgrade or pre-checks of a space
- Cancel a running upgrade or pre-checks execution of a space
- Get the support package zip file of a failing upgrade or pre-checks execution of a space

## Upgrade and pre-upgrade checks REST API documentation

> Macro (excerpt)
> 
> The upgrade and pre-upgrade checks REST API is available as **Open API (Swagger) Documentation**.
> 
> This includes details of the JSON objects and response examples.
> 
> > ℹ️ The [document activity entries REST API](https://appfire.atlassian.net/wiki/spaces/CDML/pages/654246740) and the [workflow usage statistics REST API](https://appfire.atlassian.net/wiki/spaces/CDML/pages/682066395) are also available to retrieve workflow document activity information.

> Macro (open-api)