{"_id":"57fcc4870312b20e00ac6524","category":{"_id":"57fcc4860312b20e00ac64ca","version":"57fcc4860312b20e00ac64c0","__v":0,"project":"5435687035740020002a1c04","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-30T22:39:02.374Z","from_sync":false,"order":9,"slug":"flow-data-structures","title":"Flow Data Structures"},"project":"5435687035740020002a1c04","__v":0,"version":{"_id":"57fcc4860312b20e00ac64c0","project":"5435687035740020002a1c04","__v":1,"createdAt":"2016-10-11T10:52:54.637Z","releaseDate":"2016-10-11T10:52:54.637Z","categories":["57fcc4860312b20e00ac64c1","57fcc4860312b20e00ac64c2","57fcc4860312b20e00ac64c3","57fcc4860312b20e00ac64c4","57fcc4860312b20e00ac64c5","57fcc4860312b20e00ac64c6","57fcc4860312b20e00ac64c7","57fcc4860312b20e00ac64c8","57fcc4860312b20e00ac64c9","57fcc4860312b20e00ac64ca","57fcc4860312b20e00ac64cb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"[APP-1265], [APP-1035]","version_clean":"5.2.0","version":"5.2"},"user":"54497cce27b7fc140078d9a5","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-31T23:14:38.862Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"errors\": [\n    ],\n    \"skipped\": [\n    ],\n    \"updated\": [\n    \t\"your_flow_tag\"\n    ]\n}","name":""},{"status":400,"language":"json","code":"{\n    \"errors\": [\n        \"error description\"\n    ],\n    \"skipped\": [\n    \t\"your_flow_tag\"\n    ],\n    \"updated\": [\n    ]\n}","name":""}]},"settings":"","examples":{"codes":[{"code":"output.up = array({\n  \"First Server\", \"Second Server\"\n})","language":"lua","name":"Agent Lua"}]},"method":"post","auth":"required","params":[{"_id":"5682d85258a01e0d001eea64","ref":"","in":"path","required":true,"desc":"The flow tag","default":"","type":"string","name":"upstatus_flow_tag"},{"_id":"5682d8c4aad86d0d00b9f379","ref":"","in":"body","required":false,"desc":"An array of hostname strings for the hosts that are down.","default":"","type":"array_string","name":"down"},{"_id":"5682d8c4aad86d0d00b9f378","ref":"","in":"body","required":false,"desc":"An array of hostname strings for the hosts that are up.","default":"","type":"array_string","name":"up"},{"_id":"5682d8c4aad86d0d00b9f377","ref":"","in":"body","required":false,"desc":"The optional uptime percentage to be displayed, expressed as a float. For example 99.997. Only shown when up (instead of the word \"up\").","default":"","type":"double","name":"uptime"},{"_id":"5682d8c4aad86d0d00b9f376","ref":"","in":"body","required":false,"desc":"CSS Color of the Up arrow","default":"","type":"string","name":"up_color"},{"_id":"5682d8c4aad86d0d00b9f375","ref":"","in":"body","required":false,"desc":"CSS Color of the Down arrow","default":"","type":"string","name":"down_color"}],"url":"/flows/:upstatus_flow_tag/metrics"},"isReference":false,"order":21,"body":"[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/pFyeCkJ3TCa9c9cmfQu3_upstatus.png\",\n        \"upstatus.png\",\n        \"800\",\n        \"215\",\n        \"#d75c4d\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"Up status is designed to show an Up or Down based on the status of hosts given to it. If there are any hosts that are down it will show them in a ticker tape​ fashion. Send an array of up and down hosts. An optional uptime and last_down may be provided and displayed as well.","slug":"upstatus","type":"endpoint","title":"Up Status"}

postUp Status

Up status is designed to show an Up or Down based on the status of hosts given to it. If there are any hosts that are down it will show them in a ticker tape​ fashion. Send an array of up and down hosts. An optional uptime and last_down may be provided and displayed as well.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

upstatus_flow_tag:
required
string
The flow tag

Body Params

down:
array of strings
An array of hostname strings for the hosts that are down.
up:
array of strings
An array of hostname strings for the hosts that are up.
uptime:
double
The optional uptime percentage to be displayed, expressed as a float. For example 99.997. Only shown when up (instead of the word "up").
up_color:
string
CSS Color of the Up arrow
down_color:
string
CSS Color of the Down arrow

Examples


Result Format


Documentation

[block:image] { "images": [ { "image": [ "https://files.readme.io/pFyeCkJ3TCa9c9cmfQu3_upstatus.png", "upstatus.png", "800", "215", "#d75c4d", "" ] } ] } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}