{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Status API","type":"basic","slug":"status-api","excerpt":"","body":"The Status API provides endpoints for your application to report various kinds of status information back to the management console.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Status API Endpoint\",\n  \"body\": \"The Status API is part of the [Integration API](doc:integration-api-reference).  To discover the Integration API base endpoint, query the `REPLICATED_INTEGRATIONAPI` environment variable from inside your container.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"put\",\n  \"title\": \"/status/v1/startup\"\n}\n[/block]\nSets 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.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-2\": \"Description\",\n    \"h-1\": \"Type\",\n    \"0-0\": \"message\",\n    \"1-0\": \"severity\",\n    \"2-0\": \"attrib_names\",\n    \"3-0\": \"attrib_values\",\n    \"2-1\": \"Array\",\n    \"3-1\": \"Array\",\n    \"1-1\": \"String\",\n    \"0-1\": \"String\",\n    \"2-2\": \"An array of attribute names to associate with the audit event.\",\n    \"3-2\": \"An array of attribute values to associate with the audit event. These correspond to the indexes of names in *attrib_names*\",\n    \"0-2\": \"String to be displayed in the management console UI.\",\n    \"1-2\": \"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***\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n### Example request: \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -k -X PUT $REPLICATED_INTEGRATIONAPI/status/v1/startup -H \\\"Content-Type: application/json\\\" -d '{\\\"message\\\":\\\"Migrating data...\\\"}'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{  \\n    \\\"message\\\": \\\"Migrating data...\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n### Example response:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 204 No Content\\nDate: Tue, 16 Jun 2015 17:59:25 GMT\\nContent-Length: 0\\nContent-Type: text/plain; charset=utf-8\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5702deb796fc8d2b001a663e","project":"550f1e4021de720d005b8cbb","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Integration API","slug":"integration-api","order":7,"from_sync":false,"reference":false,"_id":"5702deb696fc8d2b001a661d","project":"550f1e4021de720d005b8cbb","version":"5702deb696fc8d2b001a6615","createdAt":"2015-03-22T20:15:45.359Z","__v":0},"__v":0,"createdAt":"2015-10-14T00:33:22.025Z","user":"551040912dd9010d0019e128","parentDoc":null,"version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5702deb696fc8d2b001a6616","5702deb696fc8d2b001a6617","5702deb696fc8d2b001a6618","5702deb696fc8d2b001a6619","5702deb696fc8d2b001a661a","5702deb696fc8d2b001a661b","5702deb696fc8d2b001a661c","5702deb696fc8d2b001a661d","5702deb696fc8d2b001a661e"],"_id":"5702deb696fc8d2b001a6615","createdAt":"2016-04-04T21:37:58.778Z","hasReference":true,"releaseDate":"2016-04-04T21:37:58.778Z","__v":1,"project":"550f1e4021de720d005b8cbb","hasDoc":true},"githubsync":""}
The Status API provides endpoints for your application to report various kinds of status information back to the management console. [block:callout] { "type": "info", "title": "Status API Endpoint", "body": "The Status API is part of the [Integration API](doc:integration-api-reference). To discover the Integration API base endpoint, query the `REPLICATED_INTEGRATIONAPI` environment variable from inside your container." } [/block] [block:api-header] { "type": "put", "title": "/status/v1/startup" } [/block] 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. [block:parameters] { "data": { "h-0": "Name", "h-2": "Description", "h-1": "Type", "0-0": "message", "1-0": "severity", "2-0": "attrib_names", "3-0": "attrib_values", "2-1": "Array", "3-1": "Array", "1-1": "String", "0-1": "String", "2-2": "An array of attribute names to associate with the audit event.", "3-2": "An array of attribute values to associate with the audit event. These correspond to the indexes of names in *attrib_names*", "0-2": "String to be displayed in the management console UI.", "1-2": "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***" }, "cols": 3, "rows": 2 } [/block] ### Example request: [block:code] { "codes": [ { "code": "curl -k -X PUT $REPLICATED_INTEGRATIONAPI/status/v1/startup -H \"Content-Type: application/json\" -d '{\"message\":\"Migrating data...\"}'", "language": "curl" } ] } [/block] [block:code] { "codes": [ { "code": "{ \n \"message\": \"Migrating data...\"\n}", "language": "json" } ] } [/block] ### Example response: [block:code] { "codes": [ { "code": "HTTP/1.1 204 No Content\nDate: Tue, 16 Jun 2015 17:59:25 GMT\nContent-Length: 0\nContent-Type: text/plain; charset=utf-8", "language": "http" } ] } [/block]