{"_id":"57fcc4870312b20e00ac6517","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"},"project":"5435687035740020002a1c04","user":"54497cce27b7fc140078d9a5","__v":0,"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"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-31T23:08:00.742Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"language":"lua","code":"output.url = \"https://telemetryapp.com/images/partners/google-partners-badge.png\"\noutput.mode = \"scale\"","name":"Agent Lua"}]},"method":"post","results":{"codes":[]},"auth":"required","params":[{"_id":"567b1ea293919f0d00c97aac","ref":"","in":"path","required":true,"desc":"The flow tag","default":"","type":"string","name":"image_flow_tag"},{"_id":"567b1ea293919f0d00c97aab","ref":"","in":"body","required":true,"desc":"The URL of the Image.  *Must* be https,  plain http not supported.","default":"","type":"string","name":"url"},{"_id":"567b1ea293919f0d00c97aaa","ref":"","in":"body","required":false,"desc":"How the image should fit the container.  One of: \"fit\", \"scale\", \"fill\"","default":"","type":"string","name":"mode"}],"url":"/flows/:image_flow_tag/metrics"},"isReference":false,"order":8,"body":"[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/BvwLaAq5QA6sM9ufE2w9_image.png\",\n        \"image.png\",\n        \"800\",\n        \"215\",\n        \"#b06f26\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"Image data flow displays, well, an image.","slug":"image","type":"endpoint","title":"Image"}

postImage

Image data flow displays, well, an image.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

image_flow_tag:
required
string
The flow tag

Body Params

url:
required
string
The URL of the Image. *Must* be https, plain http not supported.
mode:
string
How the image should fit the container. One of: "fit", "scale", "fill"

Examples


Documentation

[block:image] { "images": [ { "image": [ "https://files.readme.io/BvwLaAq5QA6sM9ufE2w9_image.png", "image.png", "800", "215", "#b06f26", "" ] } ] } [/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 }}