<?xml version="1.0" encoding="UTF-8"?><rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0"><channel><title><![CDATA[REST API]]></title><description><![CDATA[<p dir="auto">Hello,</p>
<p dir="auto">We start using the REST API.<br />
As I did not see evolution on it since some months, I would like to know what is the status and what are the plan of this API?</p>
<p dir="auto">Today the most problematic part I have is the lack of rights in the API : the user must be an admin and have read/write access (even if for now the write access is quite limited as it is only "VDI Import"), and so have access to all ressources.</p>
<p dir="auto">We are only using Collections for now to get VM list, and VM info (ram, disk, cpu), and so far so good <img src="https://xcp-ng.org/forum/assets/plugins/nodebb-plugin-emoji/emoji/android/1f609.png?v=bbd7a2dd886" class="not-responsive emoji emoji-android emoji--wink" style="height:23px;width:auto;vertical-align:middle" title=";-)" alt="😉" /></p>
<p dir="auto">Regards,</p>
]]></description><link>https://xcp-ng.org/forum/topic/6516/rest-api</link><generator>RSS for Node</generator><lastBuildDate>Thu, 14 May 2026 10:57:16 GMT</lastBuildDate><atom:link href="https://xcp-ng.org/forum/topic/6516.rss" rel="self" type="application/rss+xml"/><pubDate>Thu, 03 Nov 2022 17:48:12 GMT</pubDate><ttl>60</ttl><item><title><![CDATA[Reply to REST API on Wed, 14 Dec 2022 15:37:56 GMT]]></title><description><![CDATA[<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="/forum/user/olivierlambert" aria-label="Profile: olivierlambert">@<bdi>olivierlambert</bdi></a> <img src="https://xcp-ng.org/forum/assets/plugins/nodebb-plugin-emoji/emoji/android/1f44c.png?v=bbd7a2dd886" class="not-responsive emoji emoji-android emoji--ok_hand" style="height:23px;width:auto;vertical-align:middle" title=":ok_hand:" alt="👌" /></p>
]]></description><link>https://xcp-ng.org/forum/post/56180</link><guid isPermaLink="true">https://xcp-ng.org/forum/post/56180</guid><dc:creator><![CDATA[marcungeschikts]]></dc:creator><pubDate>Wed, 14 Dec 2022 15:37:56 GMT</pubDate></item><item><title><![CDATA[Reply to REST API on Wed, 14 Dec 2022 13:54:38 GMT]]></title><description><![CDATA[<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="/forum/user/marcungeschikts" aria-label="Profile: marcungeschikts">@<bdi>marcungeschikts</bdi></a> we need to get that in the planning, at least initial <code>POST</code> feature before the end of Q1 <img src="https://xcp-ng.org/forum/assets/plugins/nodebb-plugin-emoji/emoji/android/1f642.png?v=bbd7a2dd886" class="not-responsive emoji emoji-android emoji--slightly_smiling_face" style="height:23px;width:auto;vertical-align:middle" title=":)" alt="🙂" /></p>
]]></description><link>https://xcp-ng.org/forum/post/56173</link><guid isPermaLink="true">https://xcp-ng.org/forum/post/56173</guid><dc:creator><![CDATA[olivierlambert]]></dc:creator><pubDate>Wed, 14 Dec 2022 13:54:38 GMT</pubDate></item><item><title><![CDATA[Reply to REST API on Wed, 14 Dec 2022 13:45:24 GMT]]></title><description><![CDATA[<p dir="auto">There's no <code>POST</code> possible at the moment, only <code>GET</code> to read what you need. However, it's planned to add actions, and tags might be one of the easiest (but before, we need to finish our new task system and create a "queue" for the REST API for all async tasks)</p>
]]></description><link>https://xcp-ng.org/forum/post/56171</link><guid isPermaLink="true">https://xcp-ng.org/forum/post/56171</guid><dc:creator><![CDATA[olivierlambert]]></dc:creator><pubDate>Wed, 14 Dec 2022 13:45:24 GMT</pubDate></item><item><title><![CDATA[Reply to REST API on Wed, 14 Dec 2022 13:14:26 GMT]]></title><description><![CDATA[<p dir="auto">Hello guys!</p>
<p dir="auto">There is a way on rest api to change vms tags?</p>
<p dir="auto">I tried something like this:</p>
<p dir="auto">curl -b authenticationToken=MYTOKEN -X POST -d "{"tags":"MYTAG"}" <a href="https://ENDPOINT/rest/v0/vms/UUID" target="_blank" rel="noopener noreferrer nofollow ugc">https://ENDPOINT/rest/v0/vms/UUID</a></p>
<p dir="auto">and i got this error:</p>
<p dir="auto">&lt;pre&gt;Cannot POST /rest/v0/vms/UUID&lt;/pre&gt;</p>
<p dir="auto">Thanks!</p>
]]></description><link>https://xcp-ng.org/forum/post/56166</link><guid isPermaLink="true">https://xcp-ng.org/forum/post/56166</guid><dc:creator><![CDATA[r0123456789]]></dc:creator><pubDate>Wed, 14 Dec 2022 13:14:26 GMT</pubDate></item><item><title><![CDATA[Reply to REST API on Thu, 10 Nov 2022 23:00:08 GMT]]></title><description><![CDATA[<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="/forum/user/olivierlambert" aria-label="Profile: olivierlambert">@<bdi>olivierlambert</bdi></a> said in <a href="/forum/post/54823">REST API</a>:</p>
<blockquote>
<p dir="auto">For the last point, I invite you stay tuned being read carefully each XO release blog post. It's available in XO 5.72 since last June,  see <a href="https://xen-orchestra.com/blog/xen-orchestra-5-72/#-rest-api-token-generation" target="_blank" rel="noopener noreferrer nofollow ugc">https://xen-orchestra.com/blog/xen-orchestra-5-72/#-rest-api-token-generation</a></p>
</blockquote>
<p dir="auto">I forgot it or miss it <img src="https://xcp-ng.org/forum/assets/plugins/nodebb-plugin-emoji/emoji/android/1f61e.png?v=bbd7a2dd886" class="not-responsive emoji emoji-android emoji--disappointed" style="height:23px;width:auto;vertical-align:middle" title=":(" alt="😞" /><br />
Thank you!</p>
<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="/forum/user/olivierlambert" aria-label="Profile: olivierlambert">@<bdi>olivierlambert</bdi></a> said in <a href="/forum/post/54823">REST API</a>:</p>
<blockquote>
<p dir="auto">However, there's a big gap with POST actions (doing "actions" in short). Since almost all operations are async, like disk or VM creation, REST needs to be tuned for that. I would say it's the "hard" part in REST vs a connected API like xo-cli with websockets and its persistent connection. We will probably use a "queue" system you can request to get the status of the task and the answer. Eg the UUID of the freshly created VM. All in all, it's more complex and can't be done quickly like adding "GET" actions</p>
</blockquote>
<p dir="auto">I hope you will find something that it is not too complicated to implement in your side!</p>
<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="/forum/user/olivierlambert" aria-label="Profile: olivierlambert">@<bdi>olivierlambert</bdi></a> said in <a href="/forum/post/54823">REST API</a>:</p>
<blockquote>
<p dir="auto">Finally, the permissions IMHO are even more complex, we need to discuss that with <a class="plugin-mentions-user plugin-mentions-a" href="/forum/user/julien-f" aria-label="Profile: julien-f">@<bdi>julien-f</bdi></a></p>
</blockquote>
<p dir="auto">Yes permissions are always a big thing.</p>
]]></description><link>https://xcp-ng.org/forum/post/54878</link><guid isPermaLink="true">https://xcp-ng.org/forum/post/54878</guid><dc:creator><![CDATA[delaf]]></dc:creator><pubDate>Thu, 10 Nov 2022 23:00:08 GMT</pubDate></item><item><title><![CDATA[Reply to REST API on Thu, 10 Nov 2022 11:04:41 GMT]]></title><description><![CDATA[<p dir="auto">Hi!</p>
<p dir="auto">For the last point, I invite you stay tuned being read carefully each XO release blog post. It's available in XO 5.72 since last June,  see <a href="https://xen-orchestra.com/blog/xen-orchestra-5-72/#%F0%9F%93%A1-rest-api-token-generation" target="_blank" rel="noopener noreferrer nofollow ugc">https://xen-orchestra.com/blog/xen-orchestra-5-72/#<img src="https://xcp-ng.org/forum/assets/plugins/nodebb-plugin-emoji/emoji/android/1f4e1.png?v=bbd7a2dd886" class="not-responsive emoji emoji-android emoji--satellite_antenna" style="height:23px;width:auto;vertical-align:middle" title="📡" alt="📡" />-rest-api-token-generation</a></p>
<p dir="auto">For the REST API, we recently added (but not published in a blog post, will be for November release) GET on snapshots (VM and VDI) + VM templates. So more objects to view from there <img src="https://xcp-ng.org/forum/assets/plugins/nodebb-plugin-emoji/emoji/android/1f642.png?v=bbd7a2dd886" class="not-responsive emoji emoji-android emoji--slightly_smiling_face" style="height:23px;width:auto;vertical-align:middle" title=":)" alt="🙂" /></p>
<p dir="auto">However, there's a big gap with POST actions (doing "actions" in short). Since almost all operations are async, like disk or VM creation, REST needs to be tuned for that. I would say it's the "hard" part in REST vs a connected API like <code>xo-cli</code> with websockets and its persistent connection. We will probably use a "queue" system you can request to get the status of the task and the answer. Eg the UUID of the freshly created VM. All in all, it's more complex and can't be done quickly like adding "GET" actions <img src="https://xcp-ng.org/forum/assets/plugins/nodebb-plugin-emoji/emoji/android/1f642.png?v=bbd7a2dd886" class="not-responsive emoji emoji-android emoji--slightly_smiling_face" style="height:23px;width:auto;vertical-align:middle" title=":)" alt="🙂" /></p>
<p dir="auto">Finally, the permissions IMHO are even more complex, we need to discuss that with <a class="plugin-mentions-user plugin-mentions-a" href="/forum/user/julien-f" aria-label="Profile: julien-f">@<bdi>julien-f</bdi></a></p>
]]></description><link>https://xcp-ng.org/forum/post/54823</link><guid isPermaLink="true">https://xcp-ng.org/forum/post/54823</guid><dc:creator><![CDATA[olivierlambert]]></dc:creator><pubDate>Thu, 10 Nov 2022 11:04:41 GMT</pubDate></item><item><title><![CDATA[Reply to REST API on Thu, 10 Nov 2022 09:47:39 GMT]]></title><description><![CDATA[<p dir="auto"><a class="plugin-mentions-user plugin-mentions-a" href="/forum/user/olivierlambert" aria-label="Profile: olivierlambert">@<bdi>olivierlambert</bdi></a><br />
For now, we are using the REST API to integrate information about VM into our ERP. We are tracking changes over time and are providing an up to date inventory to our customers.</p>
<p dir="auto">Next step for us, would be able to create VM directly through the REST API (and not via <code>xo-cli</code>, or <code>xe</code>).<br />
But on the security side, we will need to be able to restrict API users to some objects as the system must not be able to view/modify some objects (mostly do not be able to get/set info for some pools). Even further, we could imagine that each customer has 2 API KEY (one read, the other read/write) that will be restricted to the customer pool or customer VM.</p>
<p dir="auto">To help people to use the REST API, it would be nice if xo-web can generate the API KEY.</p>
<p dir="auto">Regards,</p>
]]></description><link>https://xcp-ng.org/forum/post/54818</link><guid isPermaLink="true">https://xcp-ng.org/forum/post/54818</guid><dc:creator><![CDATA[delaf]]></dc:creator><pubDate>Thu, 10 Nov 2022 09:47:39 GMT</pubDate></item><item><title><![CDATA[Reply to REST API on Thu, 03 Nov 2022 18:20:19 GMT]]></title><description><![CDATA[<p dir="auto">Hi!</p>
<ol>
<li>The plan is to add more feature as users ask. So this is user driven, since we can't guess priorities without people asking <img src="https://xcp-ng.org/forum/assets/plugins/nodebb-plugin-emoji/emoji/android/1f642.png?v=bbd7a2dd886" class="not-responsive emoji emoji-android emoji--slightly_smiling_face" style="height:23px;width:auto;vertical-align:middle" title=":)" alt="🙂" /></li>
<li>What do you expects concretely in terms of features? Can you please provide actual use cases?</li>
</ol>
]]></description><link>https://xcp-ng.org/forum/post/54523</link><guid isPermaLink="true">https://xcp-ng.org/forum/post/54523</guid><dc:creator><![CDATA[olivierlambert]]></dc:creator><pubDate>Thu, 03 Nov 2022 18:20:19 GMT</pubDate></item></channel></rss>