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. 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.

Name	Type	Description
message	String	String to be displayed in the management console UI.
severity	String	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

Example request:

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

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

Example response:

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