{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Console API","type":"basic","slug":"console-api","excerpt":"","body":"Console API provides API functionality against console settings.\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"/console/v1/option\"\n}\n[/block]\nReturns values corresponding to the given console option name.\n\n### Request paramerters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"String\",\n    \"0-2\": \"Option name\",\n    \"0-0\": \"name\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n### Response Status\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"200\",\n    \"0-1\": \"Success\",\n    \"1-0\": \"400\",\n    \"1-1\": \"Bad request\",\n    \"h-0\": \"Status\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n### Response body\n\nOption value (string)\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"/console/v1/auth\"\n}\n[/block]\nAuthenticates against the console authentication settings. \n\n### Request payload\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"username\",\n    \"1-0\": \"password\",\n    \"0-1\": \"String\",\n    \"1-1\": \"String\",\n    \"h-1\": \"Type\",\n    \"0-2\": \"Username (required only for authentication type LDAP)\",\n    \"1-2\": \"Password\",\n    \"h-2\": \"Description\",\n    \"h-0\": \"Name\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n### Response Status\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"200\",\n    \"h-0\": \"Status\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"Authentication successful\",\n    \"2-0\": \"401\",\n    \"2-1\": \"Invalid authentication credentials\",\n    \"1-0\": \"400\",\n    \"1-1\": \"Bad request\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n### Response body\n\nno content","updates":[],"order":8,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"57080e88eec9610e003ebde6","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},"user":"551040a92dd9010d0019e129","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},"createdAt":"2016-04-08T20:03:20.877Z","githubsync":"","parentDoc":null,"__v":6}
Console API provides API functionality against console settings. [block:api-header] { "type": "get", "title": "/console/v1/option" } [/block] Returns values corresponding to the given console option name. ### Request paramerters [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-1": "String", "0-2": "Option name", "0-0": "name" }, "cols": 3, "rows": 1 } [/block] ### Response Status [block:parameters] { "data": { "0-0": "200", "0-1": "Success", "1-0": "400", "1-1": "Bad request", "h-0": "Status", "h-1": "Description" }, "cols": 2, "rows": 2 } [/block] ### Response body Option value (string) [block:api-header] { "type": "post", "title": "/console/v1/auth" } [/block] Authenticates against the console authentication settings. ### Request payload [block:parameters] { "data": { "0-0": "username", "1-0": "password", "0-1": "String", "1-1": "String", "h-1": "Type", "0-2": "Username (required only for authentication type LDAP)", "1-2": "Password", "h-2": "Description", "h-0": "Name" }, "cols": 3, "rows": 2 } [/block] ### Response Status [block:parameters] { "data": { "0-0": "200", "h-0": "Status", "h-1": "Description", "0-1": "Authentication successful", "2-0": "401", "2-1": "Invalid authentication credentials", "1-0": "400", "1-1": "Bad request" }, "cols": 2, "rows": 3 } [/block] ### Response body no content