{"type":"doc","content":[{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"5c9106c7-bb7d-4dc9-8749-3c1d237d68fe"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"87edaae5-bb75-40f0-8c52-69cf23984db0"}},{"type":"paragraph","content":[{"type":"hardBreak"},{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"This section is a quick introduction to the Abiquo REST API and link navigation starting from the Abiquo user interface.","type":"text"}]}]},{"type":"paragraph"},{"type":"rule"},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Introduction","type":"text"}]},{"type":"paragraph","content":[{"text":"Welcome to the REST API of the Abiquo cloud platform. Yes, the Abiquo API really is a HATEOAS REST API. ","type":"text"}]},{"type":"paragraph","content":[{"text":"So, there are links everywhere, for navigation, to perform actions, and even to define the configuration of cloud entities.","type":"text"}]},{"type":"paragraph","content":[{"text":"Fortunately, the Abiquo UI is a client of the Abiquo public REST API, so it's easy to look in your browser tools and find out how the UI performs any API request. ","type":"text"}]},{"type":"paragraph","content":[{"text":"In this tutorial you will:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a VM with the UI and the API","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Get a VM and deploy it","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Get a group of VMs with the API","type":"text"},{"type":"hardBreak"}]}]}]},{"type":"rule"},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Requirements","type":"text"}]},{"type":"paragraph","content":[{"text":"You will need to be familiar with your browser tools. We used Google Chrome.","type":"text"}]},{"type":"paragraph","content":[{"text":"To complete this tutorial and part 2, you will need a working Abiquo platform with: ","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Private cloud infrastructure ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A virtual datacenter with a virtual appliance inside","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"An Abiquo private network in the virtual datacenter with two IP addresses in it","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"To become familiar with the UI and create the required entities:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If your test environment already has infrastructure, work through the ","type":"text"},{"text":"Abiquo quick walkthrough of private cloud","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/doc/pages/311362588"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If your test environment does not have infrastructure, work through the ","type":"text"},{"text":"Abiquo quick tutorial","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/doc/pages/311372993"}}]},{"type":"hardBreak"},{"type":"hardBreak"},{"type":"hardBreak"}]}]}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Authentication","type":"text"}]},{"type":"paragraph","content":[{"text":"You will need to authenticate with your own credentials as appropriate in your environment. For a complete guide, see ","type":"text"},{"text":"Authentication","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/doc/pages/311374303"}}]},{"text":". For this tutorial you could use:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Token authentication: ","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Send a ","type":"text"},{"text":"GET","type":"text","marks":[{"type":"code"}]},{"text":" request with basic authentication to the login resource of your API, for example, ","type":"text"},{"text":"https://abiquo.example.com/api/login","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Get the token from the ","type":"text"},{"text":"X-Abiquo-Token header ","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In your request, use the format of ","type":"text"},{"text":"Authentication: Token XXXXXXXX","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Basic authentication: in a securely isolated test environment only","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use ","type":"text"},{"text":"Authentication: Basic XXXXX","type":"text","marks":[{"type":"code"}]},{"text":" with the format ","type":"text"},{"text":"user:password","type":"text","marks":[{"type":"code"}]},{"text":" in base64 encoding","type":"text"},{"type":"hardBreak"},{"text":"Or in the request line use the option ","type":"text"},{"text":"-u user:password","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In your test environment you may also need to add the insecure ","type":"text"},{"text":"-k","type":"text","marks":[{"type":"code"}]},{"text":" option to the request. ","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"OAuth authentication. See ","type":"text"},{"text":"Authentication","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/doc/pages/311374303"}}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Create a VM with the UI and obtain the POST request","type":"text"}]},{"type":"paragraph","content":[{"text":"Create a VM with the UI to obtain the API method link and data object.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Log in to Abiquo and open your browser console to the ","type":"text"},{"text":"Network tab","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Record browser actions","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a VM in the UI. The UI will send a ","type":"text"},{"text":"POST","type":"text","marks":[{"type":"code"}]},{"text":" request to the API","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the browser console, find the ","type":"text"},{"text":"POST request","type":"text","marks":[{"type":"strong"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Tips when using Chrome:","type":"text","marks":[{"type":"strong"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To display the ","type":"text"},{"text":"Method","type":"text","marks":[{"type":"strong"}]},{"text":" column to easily identify the ","type":"text"},{"text":"POST","type":"text","marks":[{"type":"code"}]},{"text":" request, right-click on the ","type":"text"},{"text":"header","type":"text","marks":[{"type":"strong"}]},{"text":" row to display the ","type":"text"},{"text":"header options","type":"text","marks":[{"type":"strong"}]},{"text":" list, then select ","type":"text"},{"text":"Method","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To copy the request directly from the UI, right-click on the request","type":"text"},{"text":" URL","type":"text","marks":[{"type":"strong"}]},{"text":" and select ","type":"text"},{"text":"Copy as cURL","type":"text","marks":[{"type":"strong"}]},{"text":" and delete UI cache details from the URL before you run it","type":"text"}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"From ","type":"text"},{"text":"Headers","type":"text","marks":[{"type":"strong"}]},{"text":", ","type":"text"},{"text":"Response Headers","type":"text","marks":[{"type":"strong"}]},{"text":" find the ","type":"text"},{"text":"location.","type":"text","marks":[{"type":"strong"}]},{"text":" This is the VM link where you will send requests to modify the VM ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"From the ","type":"text"},{"text":"Payload,","type":"text","marks":[{"type":"strong"}]},{"text":" click ","type":"text"},{"text":"view source","type":"text","marks":[{"type":"strong"}]},{"text":", and right-click and copy, then format with a JSON formatter. This is the VM object that you can modify and use in the next request to create a VM","type":"text"}]}]}]},{"type":"paragraph"},{"type":"mediaSingle","attrs":{"layout":"center","width":50.0},"content":[{"type":"media","attrs":{"width":1280,"alt":"Screenshot from Chrome - the POST request to create a VM is selected.","id":"59bf6e33-bc17-4a12-809b-e13cdc122e97","collection":"contentId-311374290","type":"file","height":726}},{"type":"caption","content":[{"text":"Screenshot from Chrome - the POST request to create a VM is selected.","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Analyze the post request","type":"text"}]},{"type":"paragraph","content":[{"text":"This section explains the request to create the VM in a bit more detail.","type":"text"}]},{"type":"paragraph","content":[{"text":"When you created the VM:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The UI sent the ","type":"text"},{"text":"POST","type":"text","marks":[{"type":"code"}]},{"text":" request to the ","type":"text"},{"text":"virtualmachines","type":"text","marks":[{"type":"code"}]},{"text":" link of the virtual appliance. The link contains the IDs of the virtual datacenter and virtual appliance.","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://abiquo.lab.example.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines","type":"text"}]},{"type":"paragraph"},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You can use this link to create another VM","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In this case, the ID values are ","type":"text"},{"text":"12","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"4","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"Request Payload","type":"text","marks":[{"type":"strong"}]},{"text":" contains the basic VM object with a ","type":"text"},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" and a link to a VM template, and an option to enable remote access to the VM.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"name\":\"vmapihowto\",\n \"links\":[\n {\n \"title\":\"yVM\",\n \"rel\":\"virtualmachinetemplate\",\n \"type\":\"application/vnd.abiquo.virtualmachinetemplate+json\",\n \"href\":\"https://abiquo.lab.example.com:443/api/admin/enterprises/1/datacenterrepositories/2/virtualmachinetemplates/145\"\n }\n ],\n \"vdrpEnabled\":true\n} ","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You can copy this object and modify it to create another VM","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"After the POST request is successful, the ","type":"text"},{"text":"Location","type":"text","marks":[{"type":"strong"}]},{"text":" link, which you can obtain from the ","type":"text"},{"text":"Request headers","type":"text","marks":[{"type":"strong"}]},{"text":" is the URL of the VM in the API.","type":"text"}]},{"type":"codeBlock","content":[{"text":" https://abiquo.lab.example.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines/304","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You can use this link to manage the VM in the API","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The last element of the URL is the ID of the VM, which has a value of ","type":"text"},{"text":"304","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Create a VM using the API","type":"text"}]},{"type":"paragraph","content":[{"text":"To create a new VM:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a ","type":"text"},{"text":"POST","type":"text","marks":[{"type":"code"}]},{"text":" request to the ","type":"text"},{"text":"virtualmachines","type":"text","marks":[{"type":"code"}]},{"text":" link","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add headers to describe your JSON data objects ","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"Content-Type","type":"text","marks":[{"type":"code"}]},{"text":" header refers to the VM object you are sending. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"Accept","type":"text","marks":[{"type":"code"}]},{"text":" header refers to the API response you will receive","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add your authentication (see the Authentication section above)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"As request ","type":"text"},{"text":"data","type":"text","marks":[{"type":"code"}]},{"text":", you can add the VM entity from the previous step and change the ","type":"text"},{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":" attribute, e.g., change ","type":"text"},{"text":"vmapihowto","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"vmapihowto2","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You can use a tool such as ","type":"text"},{"text":"jq","type":"text","marks":[{"type":"em"}]},{"text":" to format the API response","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl -X POST 'https://abiquo.lab.example.com/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines' \\\n-H 'Accept: application/vnd.abiquo.virtualmachine+json;version=6.1' \\\n-H 'Authorization: Token XXXXXX' \\\n-H 'Content-Type: application/vnd.abiquo.virtualmachine+json;version=6.1' \\\n--data-raw '{\"name\":\"vmapihowto2\",\"links\":[{\"title\":\"yVM\",\"rel\":\"virtualmachinetemplate\",\"type\":\"application/vnd.abiquo.virtualmachinetemplate+json\",\"href\":\"https://abiquo.lab.example.com:443/api/admin/enterprises/1/datacenterrepositories/2/virtualmachinetemplates/145\"}],\"vdrpEnabled\":true}' \\\n--insecure --verbose | jq .","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Send the ","type":"text"},{"text":"POST","type":"text","marks":[{"type":"code"}]},{"text":" request ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"If the API creates the machine successfully, the response code is 201 and the body contains the VM object.","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Obtain VM links","type":"text"}]},{"type":"paragraph","content":[{"text":"To manage the VM, you will send requests to VM links, so you should now save some links from the VM object. It is also useful to know the ID of the VM in the API.","type":"text"}]},{"type":"paragraph","content":[{"text":"From the VM object:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Get the link with a ","type":"text"},{"text":"rel","type":"text","marks":[{"type":"code"}]},{"text":" key that has a value of ","type":"text"},{"text":"edit","type":"text","marks":[{"type":"code"}]},{"text":". Also note that in the example the VM has an ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" of ","type":"text"},{"text":"305","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"codeBlock","content":[{"text":"...\n{ \n \"links\":[\n...\n {\n \"title\": \"vmapihowto2\",\n \"rel\": \"edit\",\n \"type\": \"application/vnd.abiquo.virtualmachine+json\",\n \"href\": \"https://abiquo.lab.example.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines/305\"\n },\n...","type":"text"}]},{"type":"paragraph"}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Also get the link with a ","type":"text"},{"text":"rel","type":"text","marks":[{"type":"code"}]},{"text":" key that has a value of ","type":"text"},{"text":"deploy","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"codeBlock","content":[{"text":"...\n {\n \"title\": \"virtual machine deploy\",\n \"rel\": \"deploy\",\n \"type\": \"application/vnd.abiquo.acceptedrequest+json\",\n \"href\": \"https://abiquo.lab.example.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines/305/action/deploy\"\n },\n...","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Display the VM in the UI","type":"text"}]},{"type":"paragraph","content":[{"text":"When you've created the VM, return to the UI and you should be able to find the new VM! ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":50.0},"content":[{"type":"media","attrs":{"width":1280,"alt":"Display the VM you created with the API in the Abiquo user interface","id":"10faf323-1e88-48dd-a6b4-060947598356","collection":"contentId-311374290","type":"file","height":726}},{"type":"caption","content":[{"text":"Display the VM you created with the API in the Abiquo user interface","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Get the new VM using the API","type":"text"}]},{"type":"paragraph","content":[{"text":"To retrieve the details of the VM you just created, perform a ","type":"text"},{"text":"GET","type":"text","marks":[{"type":"code"}]},{"text":" request to the ","type":"text"},{"text":"edit","type":"text","marks":[{"type":"code"}]},{"text":" link of the VM.","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl --verbose 'https://abiquo.lab.example.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines/305' \\\n\t-H 'Accept: application/vnd.abiquo.virtualmachine+json; version=6.1' \\\n\t-u user:password -k | jq .","type":"text"}]},{"type":"paragraph","content":[{"text":"The result of this query is a VM data object in JSON format. To shorten the data object we replaced many of the links with an ellipsis (...).","type":"text"}]},{"type":"codeBlock","content":[{"text":"√ ~ % curl --verbose 'https://abiquo.lab.example.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines/305' \\ \n -H 'Accept: application/vnd.abiquo.virtualmachine+json; version=6.1' \\\n -u user:password -k | jq .\n % Total % Received % Xferd Average Speed Time Time Time Current\n Dload Upload Total Spent Left Speed\n 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- \n> GET /api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines/305 HTTP/1.1\n> Host: abiquo.lab.example.com\n> Authorization: Basic XXXXXXXXX\n> User-Agent: curl/7.82.0\n> Accept: application/vnd.abiquo.virtualmachine+json; version=6.1\n> \n{ [5 bytes data]\n* Mark bundle as not supporting multiuse\n< HTTP/1.1 200 200\n< Date: Tue, 06 Jun 2023 09:44:33 GMT\n< Server: Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips\n< Set-Cookie: ABQSESSIONID=5894817455706476983; Max-Age=1800; Expires=Tue, 06-Jun-2023 10:14:33 GMT; Path=/; Secure; HttpOnly; SameSite=strict\n< X-Abiquo-TracerContext: 7a0c3949-f905-4eea-a071-12b783ed180e\n< X-Abiquo-Token: XXXXXXXXXXXX\n< Cache-Control: no-cache, no-store, max-age=0, must-revalidate\n< Pragma: no-cache\n< Expires: 0\n< Strict-Transport-Security: max-age=31536000 ; includeSubDomains\n< X-XSS-Protection: 1; mode=block\n< X-Frame-Options: DENY\n< X-Content-Type-Options: nosniff\n< Content-Type: application/vnd.abiquo.virtualmachine+json; version=6.1\n< Transfer-Encoding: chunked\n< \n 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0{ [5 bytes data]\n100 9452 0 9452 0 0 14513 0 --:--:-- --:--:-- --:--:-- 14496\n* Connection #0 to host abiquo.lab.example.com left intact\n{\n \"id\": 305,\n \"uuid\": \"eb613c22-ffa1-4498-827a-ccaf37385c2e\",\n \"description\": \"A virtual machine\",\n \"coresPerSocket\": 1,\n \"idState\": 1,\n \"idType\": 0,\n \"type\": \"MANAGED\",\n \"highDisponibility\": 0,\n \"monitored\": false,\n \"protected\": false,\n \"variables\": {},\n \"backuppolicies\": [],\n \"generateGuestInitialPassword\": false,\n \"natrules\": [],\n \"vdrpEnabled\": true,\n \"vdrpPort\": 0,\n \"password\": \"6t51rgZ9\",\n \"deallocated\": false,\n \"name\": \"vmapihowto2\",\n \"ram\": 48,\n \"cpu\": 1,\n \"state\": \"NOT_ALLOCATED\",\n \"creationTimestamp\": 1686042455000,\n \"birthTimestamp\": 1686042455000,\n \"links\": [\n {\n \"title\": \"Abiquo\",\n \"rel\": \"enterprise\",\n \"type\": \"application/vnd.abiquo.enterprise+json\",\n \"href\": \"https://abiquo.lab.example.com:443/api/admin/enterprises/1\"\n },\n {\n \"title\": \"vmapihowto2\",\n \"rel\": \"edit\",\n \"type\": \"application/vnd.abiquo.virtualmachine+json\",\n \"href\": \"https://abiquo.lab.example.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines/305\"\n },\n ...\n {\n \"title\": \"yVM\",\n \"rel\": \"virtualmachinetemplate\",\n \"type\": \"application/vnd.abiquo.virtualmachinetemplate+json\",\n \"href\": \"https://abiquo.lab.example.com:443/api/admin/enterprises/1/datacenterrepositories/2/virtualmachinetemplates/145\"\n },\n {\n \"title\": \"Others\",\n \"rel\": \"category\",\n \"type\": \"application/vnd.abiquo.category+json\",\n \"href\": \"https://abiquo.lab.example.com:443/api/config/categories/1\"\n }\n ],\n \"usageStatistics\": []\n}\n\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Get a group of VMs with the API","type":"text"}]},{"type":"paragraph","content":[{"text":"To retrieve the collection of VMs in a virtual appliance, send a ","type":"text"},{"text":"GET","type":"text","marks":[{"type":"code"}]},{"text":" request to the ","type":"text"},{"text":"virtualmachines","type":"text","marks":[{"type":"code"}]},{"text":" link of the virtual appliance.","type":"text"}]},{"type":"paragraph","content":[{"text":"Change the ","type":"text"},{"text":"Accept","type":"text","marks":[{"type":"code"}]},{"text":" header of the request to the virtual machines data object to receive a collection of virtual machines.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"codeBlock","content":[{"text":"√ ~ % curl --verbose 'https://abiquo.lab.example.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines' \\ \n -H 'Accept: application/vnd.abiquo.virtualmachines+json; version=6.1' \\\n -u user:password -k | jq .","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"The response contains metadata about the size of the collection and the default paging links with some paging query parameters.","type":"text"}]},{"type":"paragraph","content":[{"text":"When you getting a collection of objects, you can also use query parameters to filter the response, for example, the ","type":"text"},{"text":"has","type":"text","marks":[{"type":"code"}]},{"text":" parameter can filter names by text.","type":"text"}]},{"type":"paragraph","content":[{"text":"Again, to reduce the size of the example, we replaced most of the VM links with an ellipsis (","type":"text"},{"text":"...","type":"text","marks":[{"type":"code"}]},{"text":").","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"totalSize\": 2,\n \"links\": [\n {\n \"rel\": \"first\",\n \"href\": \"https://abiquo.lab.example.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines?limit=25&by=name&asc=true\"\n },\n {\n \"rel\": \"last\",\n \"href\": \"https://abiquo.lab.example.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines?startwith=0&limit=25&by=name&asc=true\"\n }\n ],\n \"collection\": [\n {\n \"id\": 304,\n \"uuid\": \"1979e77f-32b1-430d-9b92-9f6347dbd416\",\n \"description\": \"A virtual machine\",\n \"coresPerSocket\": 1,\n \"idState\": 1,\n \"idType\": 0,\n \"type\": \"MANAGED\",\n \"highDisponibility\": 0,\n \"monitored\": false,\n \"protected\": false,\n \"variables\": {},\n \"backuppolicies\": [],\n \"generateGuestInitialPassword\": false,\n \"natrules\": [],\n \"vdrpEnabled\": true,\n \"vdrpPort\": 0,\n \"password\": \"uvlgwyFx\",\n \"deallocated\": false,\n \"name\": \"vmapihowto\",\n \"ram\": 48,\n \"cpu\": 1,\n \"state\": \"NOT_ALLOCATED\",\n \"creationTimestamp\": 1686039246000,\n \"birthTimestamp\": 1686039246000,\n \"links\": [\n {\n \"title\": \"Abiquo\",\n \"rel\": \"enterprise\",\n \"type\": \"application/vnd.abiquo.enterprise+json\",\n \"href\": \"https://abiquo.lab.example.com:443/api/admin/enterprises/1\"\n },\n {\n \"title\": \"vmapihowto\",\n \"rel\": \"edit\",\n \"type\": \"application/vnd.abiquo.virtualmachine+json\",\n \"href\": \"https://abiquo.lab.example.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines/304\"\n },\n ...\n ],\n \"usageStatistics\": []\n },\n {\n \"id\": 305,\n \"uuid\": \"eb613c22-ffa1-4498-827a-ccaf37385c2e\",\n \"description\": \"A virtual machine\",\n \"coresPerSocket\": 1,\n \"idState\": 1,\n \"idType\": 0,\n \"type\": \"MANAGED\",\n \"highDisponibility\": 0,\n \"monitored\": false,\n \"protected\": false,\n \"variables\": {},\n \"backuppolicies\": [],\n \"generateGuestInitialPassword\": false,\n \"natrules\": [],\n \"vdrpEnabled\": true,\n \"vdrpPort\": 0,\n \"password\": \"6t51rgZ9\",\n \"deallocated\": false,\n \"name\": \"vmapihowto2\",\n \"ram\": 48,\n \"cpu\": 1,\n \"state\": \"NOT_ALLOCATED\",\n \"creationTimestamp\": 1686042455000,\n \"birthTimestamp\": 1686042455000,\n \"links\": [\n {\n \"title\": \"Abiquo\",\n \"rel\": \"enterprise\",\n \"type\": \"application/vnd.abiquo.enterprise+json\",\n \"href\": \"https://abiquo.lab.example.com:443/api/admin/enterprises/1\"\n },\n {\n \"title\": \"vmapihowto2\",\n \"rel\": \"edit\",\n \"type\": \"application/vnd.abiquo.virtualmachine+json\",\n \"href\": \"https://abiquo.lab.example.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines/305\"\n },\n ...\n }\n ],\n \"usageStatistics\": []\n }\n ]\n}\n ","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Deploy your VM","type":"text"}]},{"type":"paragraph","content":[{"text":"To deploy the VM you created, send a ","type":"text"},{"text":"POST","type":"text","marks":[{"type":"code"}]},{"text":" request to the ","type":"text"},{"text":"deploy","type":"text","marks":[{"type":"code"}]},{"text":" link of the VM.","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl --verbose -X POST 'https://abiquo.lab.example.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines/305/action/deploy' \\\n-u user:password -k","type":"text"}]},{"type":"paragraph","content":[{"text":"The API will respond with an accepted request object and a link.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"message\":\"You can keep track of the progress in the link\",\n \"links\":[\n {\n \"title\":\"status\",\n \"rel\":\"status\",\n \"type\":\"application/vnd.abiquo.task+json\",\n \"href\":\"https://abiquo.lab.example.com:443/api/cloud/virtualdatacenters/12/virtualappliances/4/virtualmachines/305/tasks/d18178fd-6a95-494c-8257-adda5c53f26f\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"To check the progress of the deploy, send a ","type":"text"},{"text":"GET","type":"text","marks":[{"type":"code"}]},{"text":" request to the above link.","type":"text"}]},{"type":"paragraph","content":[{"text":"Of course, you can also just switch back to the UI and watch the VM deploy!","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":52.0},"content":[{"type":"media","attrs":{"width":1280,"alt":"The VM you created with the API is deployed in the Abiquo user interface","id":"73137f73-d4f9-405b-9fad-853e0fbbab4b","collection":"contentId-311374290","type":"file","height":688}},{"type":"caption","content":[{"text":"The VM you created with the API is deployed in the Abiquo user interface","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Conclusion","type":"text"}]},{"type":"paragraph","content":[{"text":"Congratulations, you have created a VM and deployed a VM with the API.","type":"text"}]},{"type":"paragraph","content":[{"text":"You have also retrieved an entity and a collection of entities, and you can apply this method to any entity, using the entity link and a ","type":"text"},{"text":"GET","type":"text","marks":[{"type":"code"}]},{"text":" request.","type":"text"}]},{"type":"paragraph","content":[{"text":"To work through how to modify and delete entities, see ","type":"text"},{"text":"Get Started with the Abiquo API part 2","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/doc/pages/311373739"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"Related links","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Basic behaviors","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/doc/pages/311374188"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"API How Tos","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/doc/pages/311374195"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"API reference documentation","type":"text","marks":[{"type":"link","attrs":{"href":"https://wiki.abiquo.com/api/latest"}}]}]}]}]}],"version":1}

Browser not supported