{"_id":"55be547efb412237002167bc","user":"5579fd9534ca680d00fc4217","category":{"_id":"55be547efb412237002167ac","__v":1,"pages":["55be547efb412237002167bb","55be547efb412237002167bc"],"project":"5579fdb734ca680d00fc4218","version":"55be547dfb412237002167ab","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-06-11T21:29:28.121Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"parentDoc":null,"project":"5579fdb734ca680d00fc4218","version":{"_id":"55be547dfb412237002167ab","project":"5579fdb734ca680d00fc4218","__v":3,"createdAt":"2015-08-02T17:33:49.399Z","releaseDate":"2015-08-02T17:33:49.399Z","categories":["55be547efb412237002167ac","55be547efb412237002167ad","55be547efb412237002167ae","55be547efb412237002167af","55be547efb412237002167b0","55be547efb412237002167b1","55be547efb412237002167b2","55be547efb412237002167b3","55be547efb412237002167b4","55be547efb412237002167b5","55be547efb412237002167b6","55be547efb412237002167b7","55be547efb412237002167b8","55be547efb412237002167b9","55be547efb412237002167ba","584a4b989aedb00f001446b7","584a4ba509124c0f004c15bc"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Product name change","version_clean":"1.0.0","version":"1.0"},"__v":2,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-30T10:22:05.093Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"HyperCloud Portal provides a RESTful interface to integrate with other applications. The REST APIs provide programmatic access to your resources on the HyperCloud Portal platform. The supported  resources include VMs, Containers, Data Centers, Plugins, and so on, as well as user profiles, groups, and security features. The portal allows you to perform operations such as  read/write/update/delete/search/list, and more. The REST APIs are for developers looking to integrate HyperCloud Portal into their application, and for administrators to script interactions with the resources on the HyperCloud Portal platform.\n\nThis document describes the REST API and resources provided by HyperCloud Portal. To use a REST API, your application makes an HTTP request and parses the response. The response format is JSON. Your methods are the standard HTTP methods, such as GET, PUT, POST, and DELETE.\n\nBecause the REST API is based on open standards, you can use any web development language to access the API.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"REST Endpoints\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Resource\",\n    \"h-1\": \"URL\",\n    \"0-0\": \"Docker Servers\",\n    \"0-1\": \"http://52.8.141.31:7070/api/v1/dockerservers\",\n    \"1-0\": \"Data Centers\",\n    \"1-1\": \"http://52.8.141.31:7070/api/v1/datacenters\",\n    \"2-0\": \"Application Provisioning\",\n    \"2-1\": \"http://52.8.141.31:7070/api/v1/apps\",\n    \"3-0\": \"Plugins\",\n    \"3-1\": \"http:/52.8.141.31:7070/api/v1/plugins\",\n    \"4-0\": \"Blueprints\",\n    \"4-1\": \"http://52.8.141.31:7070/api/v1/blueprints\",\n    \"5-0\": \"Builds\",\n    \"5-1\": \"http://52.8.141.31:7070/api/v1/build\",\n    \"6-0\": \"Messages\",\n    \"6-1\": \"http://52.8.141.31:7070/api/v1/messages\",\n    \"7-0\": \"Cloud Providers\",\n    \"7-1\": \"http://52.8.141.31:7070/api/v1/cloudproviders\",\n    \"8-0\": \"Registry Account\",\n    \"8-1\": \"http:/52.8.141.31:7070/api/v1/registryaccounts\",\n    \"9-0\": \"Organization\",\n    \"9-1\": \"http://52.8.141.31:7070/api/v1/organization\",\n    \"10-0\": \"Profile\",\n    \"10-1\": \"http://52.8.141.31:7070/api/v1/profile\",\n    \"11-0\": \"User\",\n    \"11-1\": \"http://52.8.141.31:7070/api/v1/user\",\n    \"12-0\": \"User Group\",\n    \"12-1\": \"http://52.8.141.31:7070/api/v1/usergroup\",\n    \"13-0\": \"Settings\",\n    \"13-1\": \"http://52.8.141.31:7070/api/v1/settings\"\n  },\n  \"cols\": 2,\n  \"rows\": 14\n}\n[/block]","excerpt":"RESTful API for HyperCloud Portal","slug":"rest-api","type":"basic","title":"REST API"}

REST API

RESTful API for HyperCloud Portal

HyperCloud Portal provides a RESTful interface to integrate with other applications. The REST APIs provide programmatic access to your resources on the HyperCloud Portal platform. The supported resources include VMs, Containers, Data Centers, Plugins, and so on, as well as user profiles, groups, and security features. The portal allows you to perform operations such as read/write/update/delete/search/list, and more. The REST APIs are for developers looking to integrate HyperCloud Portal into their application, and for administrators to script interactions with the resources on the HyperCloud Portal platform. This document describes the REST API and resources provided by HyperCloud Portal. To use a REST API, your application makes an HTTP request and parses the response. The response format is JSON. Your methods are the standard HTTP methods, such as GET, PUT, POST, and DELETE. Because the REST API is based on open standards, you can use any web development language to access the API. [block:api-header] { "type": "basic", "title": "REST Endpoints" } [/block] [block:parameters] { "data": { "h-0": "Resource", "h-1": "URL", "0-0": "Docker Servers", "0-1": "http://52.8.141.31:7070/api/v1/dockerservers", "1-0": "Data Centers", "1-1": "http://52.8.141.31:7070/api/v1/datacenters", "2-0": "Application Provisioning", "2-1": "http://52.8.141.31:7070/api/v1/apps", "3-0": "Plugins", "3-1": "http:/52.8.141.31:7070/api/v1/plugins", "4-0": "Blueprints", "4-1": "http://52.8.141.31:7070/api/v1/blueprints", "5-0": "Builds", "5-1": "http://52.8.141.31:7070/api/v1/build", "6-0": "Messages", "6-1": "http://52.8.141.31:7070/api/v1/messages", "7-0": "Cloud Providers", "7-1": "http://52.8.141.31:7070/api/v1/cloudproviders", "8-0": "Registry Account", "8-1": "http:/52.8.141.31:7070/api/v1/registryaccounts", "9-0": "Organization", "9-1": "http://52.8.141.31:7070/api/v1/organization", "10-0": "Profile", "10-1": "http://52.8.141.31:7070/api/v1/profile", "11-0": "User", "11-1": "http://52.8.141.31:7070/api/v1/user", "12-0": "User Group", "12-1": "http://52.8.141.31:7070/api/v1/usergroup", "13-0": "Settings", "13-1": "http://52.8.141.31:7070/api/v1/settings" }, "cols": 2, "rows": 14 } [/block]