# Status API


Use the Status API to monitor system health. Retrieve status information to verify system health and view system statistics.

## Authentication

To use the Status API, you need:

- The URL of your Content Hub server. You can get this from your Content Hub
  Administrator. Enter this URL in the <b>{{server}}</b> variable by hovering your mouse
  over the variable in the <b>Try it</b> pane and then clicking <b>Edit</b>.

- An access token and the client ID. Both are sent with every request. You 
  can create a token through the [Content Hub
  interface](https://doc.sitecore.com/ch/en/users/content-hub/create-an-oauth-client.html) 
  or by [requesting one to the API
  itself](https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#grant-flows).


Version: v1.0
License: closed source
Metadata:
  - product: Content Hub

## Servers

```
https://{server}
```

Variables:
- `server`
Default: "your-server"

## Security

### OAuth2

Type: oauth2

## Download OpenAPI description

[Status API](https://api-docs.sitecore.com/_bundle/ch/status-api/index.yaml)

## Status

The status endpoint is used to retrieve information about the health and status of the system.

### Retrieve overall system status

 - [GET /api/status](https://api-docs.sitecore.com/ch/status-api/status/status.md): Retrieves a summary of Content Hub system health, including minimal aggregated service status and links to detailed status resources. You do not need to authenticate to use this endpoint.

### Retrieve the status for a specific message using its ID

 - [GET /api/status/messages/{id}](https://api-docs.sitecore.com/ch/status-api/status/messagedetail.md): Retrieves detailed status information for a message, including the channel, creation time, priority, type, payload, and processing statuses. {% admonition type="info" name="Note" %} To use this endpoint, you must have the MonitorSystemStatus privilege. {% /admonition %}

### Retrieve the status of messages in a queue

 - [GET /api/status/queues/{queueName}/{status}](https://api-docs.sitecore.com/ch/status-api/status/queuedetail.md): Lists messages for a specific queue and status, including links for paging and message details.

### Retrieve status information for all message queues

 - [GET /api/status/queues](https://api-docs.sitecore.com/ch/status-api/status/queues.md): Lists status information for all message queues, including statistics and links to detailed queue status resources.

### Retrieve the status of jobs within a specific retention period

 - [GET /api/status/jobs/{retentionPeriod}](https://api-docs.sitecore.com/ch/status-api/status/jobstatus.md): Retrieves the status of jobs that occurred within a set time period.

### Retrieve the user status

 - [GET /api/status/users](https://api-docs.sitecore.com/ch/status-api/status/usersstatus.md): Retrieves the total user count and related user status information.

### Retrieve a hierarchical view of the system status

 - [GET /api/status/servicestatus](https://api-docs.sitecore.com/ch/status-api/status/servicestatus.md): Retrieves the current status, message, and downstream service statuses for troubleshooting and diagnostics.

### Retrieve the status and statistics for data storage

 - [GET /api/status/datastorage](https://api-docs.sitecore.com/ch/status-api/status/datastoragestatus.md): Retrieves statistics and status information for the data storage layer.

### Retrieve the status and statistics for media storage

 - [GET /api/status/mediastorage](https://api-docs.sitecore.com/ch/status-api/status/mediastorage.md): Retrieves the status and related statistics for the media storage layer.

### Retrieve statistics for a specific tenant and time period

 - [GET /api/status/videoindexing](https://api-docs.sitecore.com/ch/status-api/status/videoindexing.md): Retrieves the total number of seconds spent indexing videos for the specified period. If no dates are provided, the last calendar month is used.

### Retrieve the status and statistics for the search service

 - [GET /api/status/search](https://api-docs.sitecore.com/ch/status-api/status/searchstatus.md): Retrieves statistics and health information for the search layer. This is useful for monitoring and diagnostics.

### Retrieve the status and statistics for the graph service

 - [GET /api/status/graph](https://api-docs.sitecore.com/ch/status-api/status/graphstatus.md): Retrieves the status and statistics for the graph server and its workers. Use forceRefresh to bypass cached data if required.

### Retrieve the system status (deprecated)

 - [GET /api/status/system](https://api-docs.sitecore.com/ch/status-api/status/systemstatus.md): Retrieves status information about the system, including search and data storage statistics. This endpoint is deprecated.  Use the graph, data storage, or search resource endpoints instead.