---
updatedAt: 2025-04-03T21:41:27.000Z
agentTools:
  projectIndex: https://replicated.readme.io/llms.txt
---

# Status API

The Status API provides endpoints for your application to report various kinds of status information back to the management console.

> 📘 Status API Endpoint
>
> The Status API is part of the [Integration API](https://replicated.readme.io/docs/integration-api-reference).  To discover the Integration API base endpoint, query the `REPLICATED_INTEGRATIONAPI` environment variable from inside your container.

## /status/v1/startup

Sets the app's startup progress text to any arbitrary string. The string will be displayed in the "app status" tile of the management console, allowing you to provide real-time feedback about your app's startup progress to the end user.

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Name
      </th>

      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        message
      </td>

      <td>
        String
      </td>

      <td>
        String to be displayed in the management console UI.
      </td>
    </tr>

    <tr>
      <td>
        severity
      </td>

      <td>
        String
      </td>

      <td>
        Optional attribute that can be set.  If you pass `error` into this Replicated will stop starting your all of your containers and show the message on the dashboard. ***supported as of replicated\_api\_version: 1.3.2***
      </td>
    </tr>
  </tbody>
</Table>

### Example request:

```curl
curl -k -X PUT $REPLICATED_INTEGRATIONAPI/status/v1/startup -H "Content-Type: application/json" -d '{"message":"Migrating data..."}'
```

```json
{  
    "message": "Migrating data..."
}
```

### Example response:

```http
HTTP/1.1 204 No Content
Date: Tue, 16 Jun 2015 17:59:25 GMT
Content-Length: 0
Content-Type: text/plain; charset=utf-8
```