{"info":{"_postman_id":"9400d38b-5829-4453-a9a7-6286f22710f6","name":"Warren.io - Admin API doc","description":"

Do not hesitate to contact Warren team if you don't find the endpoint you are looking for!

This API doc is intended for Warren.io platform admins. In order to be able to use these queries you need to have admin priviliges set to your user account. Contact the dev team for that.

After your user account has been given admin priviliges any of your API keys can be used in these requests, all keys act as admin keys

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2599901","collectionId":"9400d38b-5829-4453-a9a7-6286f22710f6","publishedId":"RznLEagg","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-01-12T13:15:18.000Z"},"item":[{"name":"Users","item":[{"name":"Get all Users","id":"3c13e032-edbc-4d1a-8d49-237428cc3087","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}"}],"url":"{{url}}/v1/user-resource/user/all","description":"

Returns a list of all users created at platform.

\n","urlObject":{"path":["v1","user-resource","user","all"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"469c3d91-3ad5-4296-a754-46e2f578b72f","name":"Get all users","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}"}],"url":"{{url}}/v1/user-resource/user/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15260"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn/19.6.0"},{"key":"Date","value":"Wed, 16 Jan 2019 13:52:17 GMT"},{"key":"x-warren-correlation-id","value":"urs-wgqf1ei8"},{"key":"X-Kong-Upstream-Latency","value":"1026"},{"key":"X-Kong-Proxy-Latency","value":"42"},{"key":"Via","value":"kong/0.13.0"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"admin\": true,\n \"cookie_id\": \"3388946312d44599aad1c4c165c62321\",\n \"encrypted_auth_state\": null,\n \"id\": 2,\n \"last_activity\": \"2018-09-19 11:41:26\",\n \"name\": \"qm\",\n \"profile\": null,\n \"profile_data\": null,\n \"state\": {}\n },\n {\n \"admin\": false,\n \"cookie_id\": \"112f7172c3da4098af4013cffd214a14\",\n \"id\": 29,\n \"last_activity\": \"2019-01-16 13:26:58\",\n \"name\": \"kadri+shared-test@oyenetwork.com\",\n \"profile_data\": {\n \"updated_at\": \"2018-11-01 13:04:30.721404\",\n \"avatar\": \"https://s.gravatar.com/avatar/fd4321788d33bd44cc1a206dcf0f00d5?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fka.png\",\n \"last_name\": null,\n \"user_id\": 29,\n \"created_at\": \"2018-11-01 13:04:30.706940\",\n \"email\": \"kadri+shared-test@oyenetwork.com\",\n \"first_name\": null,\n \"id\": 23\n },\n \"state\": {}\n }\n]"}],"_postman_id":"3c13e032-edbc-4d1a-8d49-237428cc3087"},{"name":"Get all Admin Users/Consumers","id":"64c2b245-2e69-4e11-8730-ed11625ca2eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}"}],"url":"{{url}}/v1/user-resource/admin/admin_consumers","description":"

Returns a list of all Kong consumers (users) that belong to the admin group.

\n","urlObject":{"path":["v1","user-resource","admin","admin_consumers"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"96c6478c-9d03-43a3-b77b-dd87f2179ecc","name":"Get all Admin Users/Consumers","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}"}],"url":"{{url}}/v1/user-resource/admin/admin_consumers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Expose-Headers","value":"x-warren-correlation-id,X-Warren-Correlation-Id"},{"key":"Content-Length","value":"2899"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 03 Oct 2023 11:54:28 GMT"},{"key":"Server","value":"gunicorn/19.9.0"},{"key":"Via","value":"kong/0.13.1"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"X-Kong-Upstream-Latency","value":"2282"},{"key":"X-Warren-Correlation-Id","value":"usr-xdivlx77"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"custom_id\": \"136\",\n \"created_at\": 1570005812000,\n \"username\": \"alice@oyenetwork.com\",\n \"id\": \"f837d1ff-d614-4076-86ad-fa2ef2685337\"\n },\n {\n \"custom_id\": \"129\",\n \"created_at\": 1569317504000,\n \"username\": \"bob@warren.io\",\n \"id\": \"32c4071d-bda2-4153-a291-5fc51f004afe\"\n },\n {\n \"custom_id\": \"15\",\n \"created_at\": 1537777370000,\n \"username\": \"carol@gmail.com\",\n \"id\": \"2dd18290-88a3-451c-81c6-18860a3c6c50\"\n }\n]"}],"_postman_id":"64c2b245-2e69-4e11-8730-ed11625ca2eb"},{"name":"Get User signups' statistics","id":"ef2705b0-8f7b-4831-97d8-92fbce32ef9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}"}],"url":"{{url}}/v1/user-resource/admin/user_signups?limit_months=12","description":"

Returns statistics of user accounts created on platform.

total_signups : total user account count created on platform

last_x_days_signups : accounts created during last x days where x is days count in the element {\"days\" : 30, \"users\": 123}

monthly_signups: user accounts created monthly, each month presented in element {\"month\" : \"2022-06-01 00:00:00\", \"users\": 2345}

Optional parameters:

limit_months - Stats calculations will be limited to this many months in the past. Note that `total_signups` value is not dependent on this parameter

\n","urlObject":{"path":["v1","user-resource","admin","user_signups"],"host":["{{url}}"],"query":[{"description":{"content":"

Stats calculations will be limited to this many months in the past. Note that total_signups value is not dependent on this parameter

\n","type":"text/plain"},"key":"limit_months","value":"12"}],"variable":[]}},"response":[{"id":"8efd7683-813a-479c-80a4-4d74a01d704a","name":"Get User signups' statistics","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}"}],"url":{"raw":"{{url}}/v1/user-resource/admin/user_signups?limit_months=12","host":["{{url}}"],"path":["v1","user-resource","admin","user_signups"],"query":[{"key":"limit_months","value":"12"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15260"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn/19.6.0"},{"key":"Date","value":"Wed, 16 Jan 2019 13:52:17 GMT"},{"key":"x-warren-correlation-id","value":"urs-wgqf1ei8"},{"key":"X-Kong-Upstream-Latency","value":"1026"},{"key":"X-Kong-Proxy-Latency","value":"42"},{"key":"Via","value":"kong/0.13.0"}],"cookie":[],"responseTime":null,"body":"{\n \"total_signups\": 40591,\n \"last_x_days_signups\": [\n {\n \"days\": 30,\n \"users\": 2837\n },\n {\n \"days\": 60,\n \"users\": 5791\n }\n ],\n \"monthly_signups\": [\n {\n \"month\": \"2022-06-01 00:00:00\",\n \"users\": 1956\n },\n {\n \"month\": \"2022-05-01 00:00:00\",\n \"users\": 2710\n },\n {\n \"month\": \"2022-04-01 00:00:00\",\n \"users\": 4039\n },\n {\n \"month\": \"2022-03-01 00:00:00\",\n \"users\": 3973\n },\n {\n \"month\": \"2022-02-01 00:00:00\",\n \"users\": 1808\n },\n {\n \"month\": \"2022-01-01 00:00:00\",\n \"users\": 3945\n },\n {\n \"month\": \"2021-12-01 00:00:00\",\n \"users\": 2800\n },\n {\n \"month\": \"2021-11-01 00:00:00\",\n \"users\": 2531\n },\n {\n \"month\": \"2021-10-01 00:00:00\",\n \"users\": 2473\n },\n {\n \"month\": \"2021-09-01 00:00:00\",\n \"users\": 2496\n },\n {\n \"month\": \"2021-08-01 00:00:00\",\n \"users\": 1996\n },\n {\n \"month\": \"2021-07-01 00:00:00\",\n \"users\": 1787\n },\n {\n \"month\": \"2021-06-01 00:00:00\",\n \"users\": 1820\n }\n ]\n}"}],"_postman_id":"ef2705b0-8f7b-4831-97d8-92fbce32ef9f"},{"name":"Get user's MFA status","id":"e25386e5-20ba-4176-8766-240719e3d554","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}"}],"url":"{{url}}/v1/user-resource/admin/mfa/is_active?user_id=1234","description":"

Returns MFA status of a user.

Parameters:

user_id - The ID of the specific user whose information is requested

\n","urlObject":{"path":["v1","user-resource","admin","mfa","is_active"],"host":["{{url}}"],"query":[{"key":"user_id","value":"1234"}],"variable":[]}},"response":[{"id":"a2b70faa-8202-4caa-bbed-d534c6d8eba7","name":"Successful request","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}"}],"url":{"raw":"{{url}}/v1/user-resource/admin/mfa/is_active?user_id=1234","host":["{{url}}"],"path":["v1","user-resource","admin","mfa","is_active"],"query":[{"key":"user_id","value":"1234"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true\r\n}"}],"_postman_id":"e25386e5-20ba-4176-8766-240719e3d554"},{"name":"Reset user's MFA","id":"b241033d-9c46-4a18-a6c3-878364f9c080","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"user_id","value":"1234","type":"text","uuid":"2dd1b1f9-4f73-4adc-9cd9-fb300a656316"}]},"url":"{{url}}/v1/user-resource/admin/mfa/reset","description":"

Reset the user's MFA. This action deactivates MFA for the user, allowing them to start the enrollment process again from the UI.

Parameters:

user_id - The ID of the specific user whose MFA needs to be reset

\n","urlObject":{"path":["v1","user-resource","admin","mfa","reset"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"4817bbad-81da-435c-8885-cd097ec44883","name":"Successful request","originalRequest":{"method":"POST","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"user_id","value":"1234","type":"text","uuid":"10e7a4da-ce8c-436d-9f55-defa4cfe8cd9"}]},"url":"{{url}}/v1/user-resource/admin/mfa/reset"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true\r\n}"}],"_postman_id":"b241033d-9c46-4a18-a6c3-878364f9c080"}],"id":"22517cab-1b06-4cdf-b070-f077b742c28a","_postman_id":"22517cab-1b06-4cdf-b070-f077b742c28a","description":""},{"name":"Virtual Machines","item":[{"name":"Get all VMs","id":"5a8b0ab5-df36-4779-a11d-f6d8d984c3cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}"}],"url":"{{url}}/v1/user-resource/vm/all","description":"

Returns a list of all VMs created at platform.

Not advised to use unless you know what you are doing, will return *a lot* of VMs. See GraphQL API for paging support.

Parameters:

status: running/stopped/creating/deleted
- example: status=running&status=stopped returns only running and stopped vm's
\n
deleted_cutoff_date: 2019-10-01
- example: status=running&status=stopped&status=deleted&deleted_cutoff_date=2019-10-01 returns all VMs except vms deleted before 2019-10-01
\n

\n","urlObject":{"path":["v1","user-resource","vm","all"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5a8b0ab5-df36-4779-a11d-f6d8d984c3cb"},{"name":"Get VM stats","id":"872e1f15-f24e-498d-a1cb-375d8bf9acb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}"}],"url":"{{url}}/v1/base-operator/admin/vm/statistics/chart","description":"

Returns statistics about VMs running and stopped on the platform.

Response contains three sections: by_cpu, by_mem and by_os. Each sections shows the number of running and stopped VMs that have a particular configuration related to the section.

An example of by_mem section: there is 1 stopped VM with 512 MB of RAM, 6 running VMs with 1 GB of RAM, and 2 running and 2 stopped VMs with 2 GB of RAM.

    \"by_mem\": {\n        \"0.5\": {\n            \"running\": 0,\n            \"stopped\": 1\n        },\n        \"1.0\": {\n            \"running\": 6,\n            \"stopped\": 0\n        },\n        \"2.0\": {\n            \"running\": 2,\n            \"stopped\": 2\n        }\n    }\n

\n","urlObject":{"path":["v1","base-operator","admin","vm","statistics","chart"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"9e140f57-8417-41a3-810d-b8ab75a4b1e2","name":"Get VM stats","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}"}],"url":"{{url}}/v1/base-operator/admin/vm/statistics/chart"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Expose-Headers","value":"x-warren-correlation-id,X-Warren-Correlation-Id"},{"key":"Content-Length","value":"715"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 13 Feb 2025 10:30:57 GMT"},{"key":"Server","value":"gunicorn/19.9.0"},{"key":"Via","value":"kong/0.13.1"},{"key":"X-Kong-Proxy-Latency","value":"75"},{"key":"X-Kong-Upstream-Latency","value":"24"},{"key":"X-Warren-Correlation-Id","value":"bop-56u81lqew"}],"cookie":[],"responseTime":null,"body":"{\n \"by_cpu\": {\n \"1\": {\n \"running\": 10,\n \"stopped\": 17\n },\n \"2\": {\n \"running\": 23,\n \"stopped\": 21\n },\n \"24\": {\n \"running\": 0,\n \"stopped\": 1\n }\n },\n \"by_mem\": {\n \"2.0\": {\n \"running\": 2,\n \"stopped\": 5\n },\n \"12.0\": {\n \"running\": 0,\n \"stopped\": 1\n },\n \"1.0\": {\n \"running\": 30,\n \"stopped\": 23\n },\n \"0.5\": {\n \"running\": 1,\n \"stopped\": 0\n },\n \"1.95312\": {\n \"running\": 0,\n \"stopped\": 6\n },\n \"4.0\": {\n \"running\": 0,\n \"stopped\": 2\n },\n \"0.999023\": {\n \"running\": 0,\n \"stopped\": 2\n }\n },\n \"by_os\": {\n \"debian\": {\n \"running\": 3,\n \"stopped\": 4\n },\n \"service\": {\n \"running\": 16,\n \"stopped\": 19\n },\n \"pfsense\": {\n \"running\": 2,\n \"stopped\": 2\n },\n \"fedora\": {\n \"running\": 1,\n \"stopped\": 0\n },\n \"ubuntu\": {\n \"running\": 11,\n \"stopped\": 11\n },\n \"windows_unlicensed\": {\n \"running\": 0,\n \"stopped\": 1\n },\n \"windows\": {\n \"running\": 0,\n \"stopped\": 2\n }\n }\n}"}],"_postman_id":"872e1f15-f24e-498d-a1cb-375d8bf9acb5"},{"name":"Get one VM","id":"379c3242-c29c-4cc3-be62-a31ddf4fb468","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}"}],"url":"{{url}}/v1/user-resource/admin/vm?uuid=d1e7fcc3-e7b1-415d-9e51-ccf6a4ab11f3","description":"

Returns one VM

\n","urlObject":{"path":["v1","user-resource","admin","vm"],"host":["{{url}}"],"query":[{"key":"uuid","value":"d1e7fcc3-e7b1-415d-9e51-ccf6a4ab11f3"}],"variable":[]}},"response":[{"id":"39bc50de-2edd-438b-87be-4320f633f94c","name":"Get one VM","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}"}],"url":{"raw":"{{url}}/v1/user-resource/admin/vm?uuid=d1e7fcc3-e7b1-415d-9e51-ccf6a4ab11f3","host":["{{url}}"],"path":["v1","user-resource","admin","vm"],"query":[{"key":"uuid","value":"d1e7fcc3-e7b1-415d-9e51-ccf6a4ab11f3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Expose-Headers","value":"x-warren-correlation-id,X-Warren-Correlation-Id"},{"key":"Content-Length","value":"1016"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 19 Jun 2023 10:14:41 GMT"},{"key":"Server","value":"gunicorn/19.9.0"},{"key":"Via","value":"kong/0.13.0"},{"key":"X-Kong-Proxy-Latency","value":"51"},{"key":"X-Kong-Upstream-Latency","value":"79"},{"key":"X-Warren-Correlation-Id","value":"bop-1srkpv0u"}],"cookie":[],"responseTime":null,"body":"{\n \"backup\": false,\n \"billing_account\": 130079,\n \"created_at\": \"2023-06-19 09:27:22\",\n \"deleted_at\": \"2023-06-19 09:50:29\",\n \"description\": \"\",\n \"hostname\": \"shoot--local--lgsw31ltnahfhst0-worker-9uvla-tll01-5bfcb-klgrc\",\n \"license_type\": \"WINDOWS\",\n \"is_current_pool_visible\": false,\n \"is_designated_pool_visible\": false,\n \"latest_host_pool_uuid\": \"d2fc6881-9316-46d7-b515-b6cddaeee927\",\n \"mac\": \"52:54:00:97:2b:1b\",\n \"memory\": 4096,\n \"name\": \"shoot--local--lgsw31ltnahfhst0-worker-9uvla-tll01-5bfcb-klgrc\",\n \"os_name\": \"windows\",\n \"os_version\": \"2022\",\n \"private_ipv4\": \"10.6.167.238\",\n \"public_ipv6\": \"2a05:1cc0:10:3::cb:fffc\",\n \"service_uuid\": \"45e1dbdb-42c6-480c-a799-c103f6351aff\",\n \"status\": \"deleted\",\n \"storage\": [\n {\n \"created_at\": \"2023-06-19 09:27:25\",\n \"name\": \"vda\",\n \"pool\": \"n/a\",\n \"primary\": true,\n \"replica\": [],\n \"shared\": false,\n \"size\": 40,\n \"type\": \"n/a\",\n \"user_id\": 268,\n \"uuid\": \"668ce84d-0be2-46ef-bc25-6ddc7f63117d\"\n }\n ],\n \"updated_at\": \"2023-06-19 09:50:29\",\n \"user_id\": 268,\n \"username\": \"administrator\",\n \"uuid\": \"d1e7fcc3-e7b1-415d-9e51-ccf6a4ab11f3\",\n \"vcpu\": 4\n}"}],"_postman_id":"379c3242-c29c-4cc3-be62-a31ddf4fb468"},{"name":"Migrate a VM","event":[{"listen":"test","script":{"id":"f3d2c681-b837-4729-8a62-a85a10e8196b","exec":[""],"type":"text/javascript"}}],"id":"755147b8-be77-4002-a784-60dd1c53bed0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"uuid","type":"text","value":"e8685589-74cb-46ba-b9b6-468bc15d38bb"},{"key":"hv_uuid","type":"text","value":"f575f90f-491f-4ad4-b50e-d27219051f67"},{"key":"pool_uuid","value":"d2fc6881-9316-46d7-b515-b6cddaeee927","type":"text"}]},"url":"{{url}}/v1/base-operator/migrate","description":"

Migrate a VM to another hypervisor/host.

Either pool_uuid or hv_uuid can be specified to select a target for migration:

when hv_uuid is specified, the corresponding Host is the migration target (pool_uuid parameter is ignored).
when pool_uuid is specified (but not hv_uuid) an arbitrary Host is chosen from corresponding Pool
when neither of these parameters is provided, the target will be chosen from the Host Pool that VM is currently allocated to.

\n","urlObject":{"path":["v1","base-operator","migrate"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ceec37e1-9b2e-4e40-b6b4-e4fb526c010d","name":"Migrate VM","originalRequest":{"method":"POST","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"uuid","value":"e8685589-74cb-46ba-b9b6-468bc15d38bb","type":"text"},{"key":"hv_uuid","value":"f575f90f-491f-4ad4-b50e-d27219051f67","type":"text"}]},"url":"{{url}}/v1/base-operator/migrate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"17"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn/19.9.0"},{"key":"Date","value":"Tue, 03 Nov 2020 05:46:22 GMT"},{"key":"x-warren-correlation-id","value":"bop-ut5x7skt75"},{"key":"Access-Control-Expose-Headers","value":"x-warren-correlation-id,X-Warren-Correlation-Id"},{"key":"X-Kong-Upstream-Latency","value":"8336"},{"key":"X-Kong-Proxy-Latency","value":"16"},{"key":"Via","value":"kong/0.13.0"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"755147b8-be77-4002-a784-60dd1c53bed0"},{"name":"Migrate VM license","event":[{"listen":"test","script":{"id":"f3d2c681-b837-4729-8a62-a85a10e8196b","exec":[""],"type":"text/javascript","packages":{}}}],"id":"65fe3ed5-9490-421c-ad73-7cea3efad294","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"{\n \"os_name\": \"windows\",\n \"license_type\": \"WINDOWS\"\n}"},"url":"{{url}}/v1/{{slug}}/user-resource/admin/vm/license_type","description":"

Allows to change designated Host Pool for given VM.

See also Host Pools

\n","urlObject":{"path":["v1","base-operator","admin","vm","designated_pool"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"a18f66c0-ee83-406c-b8aa-93459904e2a7","name":"Set designated Pool for VM","originalRequest":{"method":"PATCH","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"uuid","type":"text","value":"e8685589-74cb-46ba-b9b6-468bc15d38bb"},{"key":"designated_pool_uuid","type":"text","value":"2b230480-6483-4336-8e70-f66939e80e84"}]},"url":"{{url}}/v1/base-operator/admin/vm/designated_pool"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"backup\": true,\n \"billing_account\": 129725,\n \"created_at\": \"2022-12-13 08:16:44\",\n \"description\": \"Good VM\",\n \"designated_pool_name\": \"General purpose\",\n \"designated_pool_uuid\": \"d2fc6881-9316-46d7-b515-b6cddaeee927\",\n \"hostname\": \"DevServer\",\n \"hypervisor_uuid\": \"37313436-3934-5a43-3335-323231364841\",\n \"mac\": \"52:54:00:b0:7c:02\",\n \"memory\": 4096,\n \"name\": \"Dev Server\",\n \"os_name\": \"linux\",\n \"os_version\": \"custom\",\n \"private_ipv4\": \"10.7.58.210\",\n \"public_ipv6\": \"2a05:1cc0:10:3::8:fffe\",\n \"status\": \"stopped\",\n \"storage\": [\n {\n \"created_at\": \"2022-12-13 08:16:46\",\n \"name\": \"vda\",\n \"pool\": \"n/a\",\n \"primary\": true,\n \"replica\": [],\n \"shared\": false,\n \"size\": 60,\n \"type\": \"n/a\",\n \"user_id\": 8,\n \"uuid\": \"da344d7d-0e31-4308-a1ac-bb0220bf09d6\"\n }\n ],\n \"updated_at\": \"2022-12-13 08:16:48\",\n \"user_id\": 8,\n \"username\": \"user\",\n \"uuid\": \"b9178639-a850-45ba-9dfd-4e0a42cedc02\",\n \"vcpu\": 2\n}"}],"_postman_id":"f1d12a11-a66b-49c3-85ed-10d113f165d5"},{"name":"Get VM Action Log","event":[{"listen":"test","script":{"id":"45d75838-6860-4db7-a010-d614b6e6d1ee","exec":[""],"type":"text/javascript"}}],"id":"f971df7a-b4db-478e-8545-a2b07658448f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}"}],"url":"{{url}}/v1/base-operator/admin/action_log?since=2020-11-16 00:00:00&hypervisor_uuid=32393735-3733-5a43-4a30-3436305a3838&guest_uuid=b00f40f3-fb61-4c08-85d8-18f50a333b3f","description":"

Retrieve the log of Virtual Machine actions like start, stop, migrate etc. The parameters hypervisor_uuid and guest_uuid are optional.

\n","urlObject":{"path":["v1","base-operator","admin","action_log"],"host":["{{url}}"],"query":[{"description":{"content":"

Only show actions after this date and time, format is 'YYYY-MM-DD HH:MI:SS'

\n","type":"text/plain"},"key":"since","value":"2020-11-16 00:00:00"},{"description":{"content":"

UUID of hypervisor, optional

\n","type":"text/plain"},"key":"hypervisor_uuid","value":"32393735-3733-5a43-4a30-3436305a3838"},{"description":{"content":"

UUID of Virtual Machine, optional

\n","type":"text/plain"},"key":"guest_uuid","value":"b00f40f3-fb61-4c08-85d8-18f50a333b3f"}],"variable":[]}},"response":[{"id":"843bbd10-1bd7-42d0-a031-d21408160d8d","name":"Get VM Action Log","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}"}],"url":{"raw":"{{url}}/v1/base-operator/admin/action_log?hypervisor_uuid=32393735-3733-5a43-4a30-3436305a3838&since=2020-11-16 00:00:00&guest_uuid=b00f40f3-fb61-4c08-85d8-18f50a333b3f","host":["{{url}}"],"path":["v1","base-operator","admin","action_log"],"query":[{"key":"hypervisor_uuid","value":"32393735-3733-5a43-4a30-3436305a3838","description":"UUID of hypervisor, optional"},{"key":"since","value":"2020-11-16 00:00:00","description":"Only show actions after this date and time, format is 'YYYY-MM-DD HH:MI:SS'"},{"key":"guest_uuid","value":"b00f40f3-fb61-4c08-85d8-18f50a333b3f","description":"UUID of Virtual Machine, optional"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"749"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn/19.9.0"},{"key":"Date","value":"Tue, 17 Nov 2020 07:52:01 GMT"},{"key":"x-warren-correlation-id","value":"bop-h5rqga6bnp"},{"key":"Access-Control-Expose-Headers","value":"x-warren-correlation-id,X-Warren-Correlation-Id"},{"key":"X-Kong-Upstream-Latency","value":"390"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/0.13.0"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"action\": \"delete\",\n \"created_at\": \"2020-11-16 05:22:21\",\n \"guest_uuid\": \"b00f40f3-fb61-4c08-85d8-18f50a333b3f\",\n \"acting_user_id\": 35,\n \"host_uuid\": \"99824a1a-02cf-4dca-90f1-3899884999fd\",\n \"hypervisor_uuid\": \"99824a1a-02cf-4dca-90f1-3899884999fd\"\n },\n {\n \"action\": \"migrate_to\",\n \"created_at\": \"2020-11-16 03:47:24\",\n \"guest_uuid\": \"b00f40f3-fb61-4c08-85d8-18f50a333b3f\",\n \"acting_user_id\": 1397,\n \"host_uuid\": \"99824a1a-02cf-4dca-90f1-3899884999fd\",\n \"hypervisor_uuid\": \"99824a1a-02cf-4dca-90f1-3899884999fd\"\n },\n {\n \"action\": \"migrate_from\",\n \"created_at\": \"2020-11-16 03:47:24\",\n \"guest_uuid\": \"b00f40f3-fb61-4c08-85d8-18f50a333b3f\",\n \"acting_user_id\": 1397,\n \"host_uuid\": \"32393735-3733-5a43-4a30-3436305a3838\",\n \"hypervisor_uuid\": \"99824a1a-02cf-4dca-90f1-3899884999fd\"\n },\n {\n \"action\": \"start\",\n \"created_at\": \"2020-11-16 03:33:04\",\n \"guest_uuid\": \"b00f40f3-fb61-4c08-85d8-18f50a333b3f\",\n \"acting_user_id\": 35,\n \"host_uuid\": \"32393735-3733-5a43-4a30-3436305a3838\",\n \"hypervisor_uuid\": \"99824a1a-02cf-4dca-90f1-3899884999fd\"\n },\n {\n \"action\": \"stop\",\n \"created_at\": \"2020-11-16 03:26:33\",\n \"guest_uuid\": \"b00f40f3-fb61-4c08-85d8-18f50a333b3f\",\n \"acting_user_id\": 35,\n \"host_uuid\": \"32393735-3733-5a43-4a30-3436305a3838\",\n \"hypervisor_uuid\": \"99824a1a-02cf-4dca-90f1-3899884999fd\"\n },\n {\n \"action\": \"create\",\n \"created_at\": \"2020-11-16 03:26:17\",\n \"guest_uuid\": \"b00f40f3-fb61-4c08-85d8-18f50a333b3f\",\n \"acting_user_id\": 35,\n \"host_uuid\": \"32393735-3733-5a43-4a30-3436305a3838\",\n \"hypervisor_uuid\": \"99824a1a-02cf-4dca-90f1-3899884999fd\"\n }\n]"}],"_postman_id":"f971df7a-b4db-478e-8545-a2b07658448f"},{"name":"Create Virtual Machine","id":"6a0ee154-5b97-4b87-af4c-3f9b56dffc4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apikey","type":"text","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"user_id","value":"{{user_id}}","type":"text"},{"key":"billing_account_id","value":"{{billing_account_id}}","type":"text"},{"key":"name","value":"Dev Server","type":"text","description":"

Descriptive name of VM

\n"},{"key":"description","value":"Good VM","type":"text","description":"

Same as in user API

\n"},{"key":"vcpu","value":"2","type":"text"},{"key":"ram","value":"4096","type":"text"},{"key":"username","value":"user","type":"text","description":"

Will be provided to VM in cloud init user data

\n"},{"key":"password","value":"57db1253b68b6802","type":"text","description":"

Will be provided to VM in cloud init user data

\n"},{"key":"disk_uuid","value":"da344d7d-0e31-4308-a1ac-bb0220bf09d6","type":"text","description":"

VM will be created with this as boot disk

\n"},{"key":"os_name","value":"fedora","type":"text","description":"

Has mostly descriptive function

\n"},{"key":"os_version","value":"37","type":"text","description":"

Has mostly descriptive function

\n"},{"key":"public_key","value":"ssh-rsa AAAAB3...","type":"text","description":"

Will be provided to VM in cloud init user data

\n"},{"key":"backup","value":"true","type":"text"},{"key":"network_uuid","value":"768bc192-913d-468c-ad11-d5d10256df52","type":"text"},{"key":"cloud_init","value":"{\"runcmd\": [\"/firstboot\"], \"write_files\": [{\"path\": \"/firstboot\", \"content\": \"IyEvYmluL2Jhc2gKZWNobyBOb3cgQm9vdGluZwoK\", \"permissions\": \"0755\", \"encoding\": \"b64\"}]}","type":"text"},{"key":"host_pool_uuid","value":"d2fc6881-9316-46d7-b515-b6cddaeee927","description":"

Resource pool to allocate this VM into.

\n","type":"text"}]},"url":"{{url}}/v1/user-resource/admin/vm","description":"

Create a Virtual Machine on behalf of the user. See user API documentation for more information.

Restrictions compared to user API:

VM can only be created with an existing disk, i.e. disk_uuid is mandatory. As a result, os_name and os_version have mostly descriptive function.
Floating IP can not be created and assigned with this request, it has to be done separately. Effectively same as calling Create VM in user API with reserve_public_ip=false.
Virtual Machine will not be started after creation, Start VM must be called separately.
username, password and public_key are only provided to VM as cloud init user data. If cloud-init has already initialised the OS on disk then these values might not have effect. It is up to cloud-init inside the OS to decide how to react. It might be safer to specify a username that does not already exist inside the OS on the disk.

\n","urlObject":{"path":["v1","user-resource","admin","vm"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"da67d671-c506-4cbe-9d0d-9c78d9f679fe","name":"Create Virtual Machine","originalRequest":{"method":"POST","header":[{"key":"apikey","type":"text","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"user_id","value":"{{user_id}}","type":"text"},{"key":"billing_account_id","value":"{{billing_account_id}}","type":"text"},{"key":"name","value":"Dev Server","type":"text","description":"Descriptive name of VM"},{"key":"description","value":"Good VM","type":"text","description":"Same as in user API"},{"key":"vcpu","value":"2","type":"text"},{"key":"ram","value":"4096","type":"text"},{"key":"username","value":"user","type":"text","description":"Will be provided to VM in cloud init user data"},{"key":"password","value":"57db1253b68b6802","type":"text","description":"Will be provided to VM in cloud init user data"},{"key":"disk_uuid","value":"da344d7d-0e31-4308-a1ac-bb0220bf09d6","type":"text","description":"VM will be created with this as boot disk"},{"key":"os_name","value":"fedora","type":"text","description":"Has mostly descriptive function"},{"key":"os_version","value":"37","type":"text","description":"Has mostly descriptive function"},{"key":"public_key","value":"ssh-rsa AAAAB3...","type":"text","description":"Will be provided to VM in cloud init user data"},{"key":"backup","value":"true","type":"text"},{"key":"network_uuid","value":"768bc192-913d-468c-ad11-d5d10256df52","type":"text"},{"key":"cloud_init","value":"{\"runcmd\": [\"/firstboot\"], \"write_files\": [{\"path\": \"/firstboot\", \"content\": \"IyEvYmluL2Jhc2gKZWNobyBOb3cgQm9vdGluZwoK\", \"permissions\": \"0755\", \"encoding\": \"b64\"}]}","type":"text"},{"key":"host_pool_uuid","value":"d2fc6881-9316-46d7-b515-b6cddaeee927","type":"text"}]},"url":"{{url}}/v1/user-resource/admin/vm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Expose-Headers","value":"x-warren-correlation-id,X-Warren-Correlation-Id"},{"key":"Content-Length","value":"743"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 13 Dec 2022 08:16:48 GMT"},{"key":"Server","value":"gunicorn/19.9.0"},{"key":"Via","value":"kong/0.13.0"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"X-Kong-Upstream-Latency","value":"3428"},{"key":"X-Warren-Correlation-Id","value":"bop-1pjzojixkl"}],"cookie":[],"responseTime":null,"body":"{\n \"backup\": true,\n \"billing_account\": 129725,\n \"created_at\": \"2022-12-13 08:16:44\",\n \"description\": \"Good VM\",\n \"designated_pool_name\": \"General purpose\",\n \"designated_pool_uuid\": \"d2fc6881-9316-46d7-b515-b6cddaeee927\", \n \"hostname\": \"DevServer\",\n \"hypervisor_uuid\": \"37313436-3934-5a43-3335-323231364841\",\n \"mac\": \"52:54:00:b0:7c:02\",\n \"memory\": 4096,\n \"name\": \"Dev Server\",\n \"os_name\": \"linux\",\n \"os_version\": \"custom\",\n \"private_ipv4\": \"10.7.58.210\",\n \"public_ipv6\": \"2a05:1cc0:10:3::8:fffe\",\n \"status\": \"stopped\",\n \"storage\": [\n {\n \"created_at\": \"2022-12-13 08:16:46\",\n \"name\": \"vda\",\n \"pool\": \"n/a\",\n \"primary\": true,\n \"replica\": [],\n \"shared\": false,\n \"size\": 60,\n \"type\": \"n/a\",\n \"user_id\": 8,\n \"uuid\": \"da344d7d-0e31-4308-a1ac-bb0220bf09d6\"\n }\n ],\n \"updated_at\": \"2022-12-13 08:16:48\",\n \"user_id\": 8,\n \"username\": \"user\",\n \"uuid\": \"b9178639-a850-45ba-9dfd-4e0a42cedc02\",\n \"vcpu\": 2\n}"}],"_postman_id":"6a0ee154-5b97-4b87-af4c-3f9b56dffc4f"},{"name":"Start VM","event":[{"listen":"test","script":{"id":"056c37a3-9e30-4009-a31f-76314d23b3e0","exec":[""],"type":"text/javascript"}}],"id":"05186739-6ddc-4ba7-acba-0355d1683f73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"

UUID of Virtual Machine

\n","key":"uuid","type":"text","value":"b00f40f3-fb61-4c08-85d8-18f50a333b3f"}]},"url":"{{url}}/v1/user-resource/admin/vm/start","description":"

Start any VM.

\n","urlObject":{"path":["v1","user-resource","admin","vm","start"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"05186739-6ddc-4ba7-acba-0355d1683f73"},{"name":"Migrate VM license","event":[{"listen":"test","script":{"id":"056c37a3-9e30-4009-a31f-76314d23b3e0","exec":[""],"type":"text/javascript"}}],"id":"6fca38e7-3842-475c-bdaa-90cfc6db1fdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"

UUID of Virtual Machine

\n","key":"uuid","type":"text","value":"b00f40f3-fb61-4c08-85d8-18f50a333b3f"}]},"url":"{{url}}/v1/user-resource/admin/vm/start","description":"

Start any VM.

\n","urlObject":{"path":["v1","user-resource","admin","vm","start"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6fca38e7-3842-475c-bdaa-90cfc6db1fdf"},{"name":"Stop VM","event":[{"listen":"test","script":{"id":"4bdba9e6-629d-43d1-80b0-d22c8d44d5a4","exec":[""],"type":"text/javascript"}}],"id":"329a6bbd-050b-4b1f-88b4-9abbb7774058","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"

UUID of Virtual Machine

\n","key":"uuid","type":"text","value":"b00f40f3-fb61-4c08-85d8-18f50a333b3f"},{"description":"

Use true here for a non-graceful immediate poweroff, optional

\n","key":"force","type":"text","value":"false"}]},"url":"{{url}}/v1/user-resource/admin/vm/stop","description":"

Stop any VM. See end user API doc for more information about the force flag.

\n","urlObject":{"path":["v1","user-resource","admin","vm","stop"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"329a6bbd-050b-4b1f-88b4-9abbb7774058"},{"name":"Attach Disk to VM","event":[{"listen":"test","script":{"id":"056c37a3-9e30-4009-a31f-76314d23b3e0","exec":[""],"type":"text/javascript"}}],"id":"60e48563-c63b-4799-803a-3ad8ae36cd11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"

UUID of Virtual Machine

\n","key":"uuid","type":"text","value":"591b5ea1-f6bc-4e2f-bf93-b04e7584de06"},{"key":"storage_uuid","value":"da344d7d-0e31-4308-a1ac-bb0220bf09d6","description":"

UUID of Disk to attach

\n","type":"text"}]},"url":"{{url}}/v1/user-resource/admin/vm/storage/attach","description":"

Attach a Disk to a Virtual Machine. The Disk and VM must belong to the same user.

\n","urlObject":{"path":["v1","user-resource","admin","vm","storage","attach"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"73f3eafb-172a-46d5-afd6-cb0df6f3a3b2","name":"Attach Disk to VM","originalRequest":{"method":"POST","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"UUID of Virtual Machine","key":"uuid","type":"text","value":"591b5ea1-f6bc-4e2f-bf93-b04e7584de06"},{"key":"storage_uuid","value":"da344d7d-0e31-4308-a1ac-bb0220bf09d6","description":"UUID of Disk to attach","type":"text"}]},"url":"{{url}}/v1/user-resource/admin/vm/storage/attach"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Expose-Headers","value":"x-warren-correlation-id,X-Warren-Correlation-Id"},{"key":"Content-Length","value":"206"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 13 Dec 2022 07:44:43 GMT"},{"key":"Server","value":"gunicorn/19.9.0"},{"key":"Via","value":"kong/0.13.0"},{"key":"X-Kong-Proxy-Latency","value":"33"},{"key":"X-Kong-Upstream-Latency","value":"140"},{"key":"X-Warren-Correlation-Id","value":"bop-qa7cgujbf"}],"cookie":[],"responseTime":null,"body":"{\n \"created_at\": \"2022-12-12 15:52:44\",\n \"name\": \"vdb\",\n \"pool\": \"n/a\",\n \"primary\": false,\n \"replica\": [],\n \"shared\": false,\n \"size\": 60,\n \"type\": \"n/a\",\n \"user_id\": 8,\n \"uuid\": \"da344d7d-0e31-4308-a1ac-bb0220bf09d6\"\n}"}],"_postman_id":"60e48563-c63b-4799-803a-3ad8ae36cd11"},{"name":"Detach Disk from VM","event":[{"listen":"test","script":{"id":"056c37a3-9e30-4009-a31f-76314d23b3e0","exec":[""],"type":"text/javascript"}}],"id":"7da63e66-e50c-4e0c-8e55-733a78194dd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"

UUID of Virtual Machine

\n","key":"uuid","type":"text","value":"591b5ea1-f6bc-4e2f-bf93-b04e7584de06"},{"key":"storage_uuid","value":"da344d7d-0e31-4308-a1ac-bb0220bf09d6","description":"

UUID of Disk to detach

\n","type":"text"}]},"url":"{{url}}/v1/user-resource/admin/vm/storage/detach","description":"

Detach a Disk from a Virtual Machine.

\n","urlObject":{"path":["v1","user-resource","admin","vm","storage","detach"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"26ac31c7-8fc9-4700-852c-b99d178f4677","name":"Detach Disk from VM","originalRequest":{"method":"POST","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"UUID of Virtual Machine","key":"uuid","type":"text","value":"591b5ea1-f6bc-4e2f-bf93-b04e7584de06"},{"key":"storage_uuid","value":"da344d7d-0e31-4308-a1ac-bb0220bf09d6","description":"UUID of Disk to detach","type":"text"}]},"url":"{{url}}/v1/user-resource/admin/vm/storage/detach"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Expose-Headers","value":"x-warren-correlation-id,X-Warren-Correlation-Id"},{"key":"Content-Length","value":"17"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 13 Dec 2022 07:48:27 GMT"},{"key":"Server","value":"gunicorn/19.9.0"},{"key":"Via","value":"kong/0.13.0"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"X-Kong-Upstream-Latency","value":"51"},{"key":"X-Warren-Correlation-Id","value":"bop-1ttgb1w6vi"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"7da63e66-e50c-4e0c-8e55-733a78194dd0"},{"name":"Delete VM","event":[{"listen":"test","script":{"id":"4bdba9e6-629d-43d1-80b0-d22c8d44d5a4","exec":[""],"type":"text/javascript"}}],"id":"3a7fafe2-c06d-4a88-835f-bd1a5fc2b36f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"

UUID of Virtual Machine

\n","key":"uuid","type":"text","value":"591b5ea1-f6bc-4e2f-bf93-b04e7584de06"}]},"url":"{{url}}/v1/user-resource/admin/vm","description":"

Delete any VM.

\n","urlObject":{"path":["v1","user-resource","admin","vm"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"305b96e9-f079-435d-acde-20149bc2d60e","name":"Delete VM","originalRequest":{"method":"DELETE","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"UUID of Virtual Machine","key":"uuid","type":"text","value":"591b5ea1-f6bc-4e2f-bf93-b04e7584de06"}]},"url":"{{url}}/v1/user-resource/admin/vm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Expose-Headers","value":"x-warren-correlation-id,X-Warren-Correlation-Id"},{"key":"Content-Length","value":"17"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 23 Feb 2023 08:13:27 GMT"},{"key":"Server","value":"gunicorn/19.9.0"},{"key":"Via","value":"kong/0.13.0"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"X-Kong-Upstream-Latency","value":"363"},{"key":"X-Warren-Correlation-Id","value":"bop-1uo8cw7df"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"3a7fafe2-c06d-4a88-835f-bd1a5fc2b36f"},{"name":"Modify VM","id":"4fe54dad-d668-44ef-a85a-e0731f911526","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/v1/{{location}}/base-operator/admin/vm?uuid=49c039db-7bcd-4f20-9358-88c4618c547a&vcpu=2&ram=2048","description":"

#location-specific

Rescale the VM resource

Do note that vcpu and ram can only be changed when the machine is in stopped state.

Form Parameters:

uuid (string): VM instance ID
ram (whole number): Size of RAM in MBs
vcpu (whole number): Number of vCPUs

\n","urlObject":{"path":["v1","{{location}}","base-operator","admin","vm"],"host":["{{url}}"],"query":[{"key":"uuid","value":"49c039db-7bcd-4f20-9358-88c4618c547a"},{"key":"vcpu","value":"2"},{"key":"ram","value":"2048"}],"variable":[]}},"response":[{"id":"f72abefb-0039-4d91-8509-7c6da916038c","name":"Modify VM","originalRequest":{"method":"PATCH","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{url}}/v1/{{location}}/base-operator/admin/vm?uuid=49c039db-7bcd-4f20-9358-88c4618c547a&vcpu=2&ram=2048","host":["{{url}}"],"path":["v1","{{location}}","base-operator","admin","vm"],"query":[{"key":"uuid","value":"49c039db-7bcd-4f20-9358-88c4618c547a"},{"key":"vcpu","value":"2"},{"key":"ram","value":"2048"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Expose-Headers","value":"x-warren-correlation-id,X-Warren-Correlation-Id"},{"key":"Content-Length","value":"1587"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 26 May 2022 12:53:41 GMT"},{"key":"Server","value":"gunicorn/19.9.0"},{"key":"Via","value":"kong/0.13.0"},{"key":"X-Kong-Proxy-Latency","value":"31"},{"key":"X-Kong-Upstream-Latency","value":"88"},{"key":"X-Warren-Correlation-Id","value":"bop-e08cgjdsq"}],"cookie":[],"responseTime":null,"body":"{\n \"backup\": true,\n \"billing_account\": 129188,\n \"created_at\": \"2021-03-01 13:42:03\",\n \"description\": \"ubuntu-from-snap\",\n \"hostname\": \"ubuntu-from-snap\",\n \"mac\": \"52:54:00:ee:81:fb\",\n \"memory\": 2048,\n \"name\": \"ubuntu-from-snap\",\n \"os_name\": \"ubuntu\",\n \"os_version\": \"20.04\",\n \"private_ipv4\": \"10.1.29.54\",\n \"public_ipv6\": \"2a05:1cc0:10:30::80:fffe\",\n \"status\": \"stopped\",\n \"storage\": [\n {\n \"created_at\": \"2021-03-01 13:42:05\",\n \"name\": \"vda\",\n \"pool\": \"n/a\",\n \"primary\": true,\n \"replica\": [\n {\n \"created_at\": \"2022-05-26 11:14:23\",\n \"master_uuid\": \"aa546efe-8c33-480f-91a6-9e7e58b9d80a\",\n \"pool\": \"\",\n \"size\": 40,\n \"type\": \"snapshot\",\n \"uuid\": \"1c2de616-b2ed-4e60-9de0-8971e35a8b6e\"\n },\n {\n \"created_at\": \"2022-05-25 02:00:01\",\n \"master_uuid\": \"aa546efe-8c33-480f-91a6-9e7e58b9d80a\",\n \"pool\": \"\",\n \"size\": 40,\n \"type\": \"backup\",\n \"uuid\": \"44a66936-7eb0-4fc5-ade9-b86cff3e358d\"\n },\n {\n \"created_at\": \"2022-05-18 02:00:02\",\n \"master_uuid\": \"aa546efe-8c33-480f-91a6-9e7e58b9d80a\",\n \"pool\": \"\",\n \"size\": 40,\n \"type\": \"backup\",\n \"uuid\": \"31b001c6-d6e1-4ffa-a755-8f79bf10d2aa\"\n },\n {\n \"created_at\": \"2022-05-11 02:00:02\",\n \"master_uuid\": \"aa546efe-8c33-480f-91a6-9e7e58b9d80a\",\n \"pool\": \"\",\n \"size\": 40,\n \"type\": \"backup\",\n \"uuid\": \"45174cec-79be-4ebd-ab64-99dc5c33b64a\"\n },\n {\n \"created_at\": \"2022-05-04 02:00:02\",\n \"master_uuid\": \"aa546efe-8c33-480f-91a6-9e7e58b9d80a\",\n \"pool\": \"\",\n \"size\": 40,\n \"type\": \"backup\",\n \"uuid\": \"8a2a2ad9-98a7-44b0-81b7-39e98eb28bd5\"\n }\n ],\n \"shared\": false,\n \"size\": 40,\n \"type\": \"n/a\",\n \"user_id\": 29,\n \"uuid\": \"aa546efe-8c33-480f-91a6-9e7e58b9d80a\"\n }\n ],\n \"updated_at\": \"2022-05-26 12:53:41\",\n \"user_id\": 29,\n \"username\": \"kadri\",\n \"uuid\": \"49c039db-7bcd-4f20-9358-88c4618c547a\",\n \"vcpu\": 2\n}"}],"_postman_id":"4fe54dad-d668-44ef-a85a-e0731f911526"},{"name":"Modify Disk","id":"029cf3ac-bd61-425d-ba32-c4384908f123","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/v1/{{location}}/base-operator/admin/vm/storage?uuid=49c039db-7bcd-4f20-9358-88c4618c547a&disk_uuid=aa546efe-8c33-480f-91a6-9e7e58b9d80a&size_gb=60","description":"

#location-specific

Modify virtual machine disk with the specified capacity. New disk size cannot be smaller than current size.

Form Parameters:

uuid (string): VM instance ID.
disk_uuid (string): Disk ID to resize.
size_gb (whole number): New disk size.

\n","urlObject":{"path":["v1","{{location}}","base-operator","admin","vm","storage"],"host":["{{url}}"],"query":[{"key":"uuid","value":"49c039db-7bcd-4f20-9358-88c4618c547a"},{"key":"disk_uuid","value":"aa546efe-8c33-480f-91a6-9e7e58b9d80a"},{"key":"size_gb","value":"60"}],"variable":[]}},"response":[{"id":"914fbc95-ab90-4742-ab82-5e78181ba3ac","name":"Modify Disk","originalRequest":{"method":"PATCH","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{url}}/v1/{{location}}/base-operator/admin/vm/storage?uuid=49c039db-7bcd-4f20-9358-88c4618c547a&disk_uuid=aa546efe-8c33-480f-91a6-9e7e58b9d80a&size_gb=60","host":["{{url}}"],"path":["v1","{{location}}","base-operator","admin","vm","storage"],"query":[{"key":"uuid","value":"49c039db-7bcd-4f20-9358-88c4618c547a"},{"key":"disk_uuid","value":"aa546efe-8c33-480f-91a6-9e7e58b9d80a"},{"key":"size_gb","value":"60"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Expose-Headers","value":"x-warren-correlation-id,X-Warren-Correlation-Id"},{"key":"Content-Length","value":"1163"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 26 May 2022 13:07:07 GMT"},{"key":"Server","value":"gunicorn/19.9.0"},{"key":"Via","value":"kong/0.13.0"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"X-Kong-Upstream-Latency","value":"1471"},{"key":"X-Warren-Correlation-Id","value":"bop-ft4h2dlnl"}],"cookie":[],"responseTime":null,"body":"{\n \"created_at\": \"2021-03-01 13:42:05\",\n \"name\": \"vda\",\n \"pool\": \"n/a\",\n \"primary\": true,\n \"replica\": [\n {\n \"created_at\": \"2022-05-26 11:14:23\",\n \"master_uuid\": \"aa546efe-8c33-480f-91a6-9e7e58b9d80a\",\n \"pool\": \"\",\n \"size\": 40,\n \"type\": \"snapshot\",\n \"uuid\": \"1c2de616-b2ed-4e60-9de0-8971e35a8b6e\"\n },\n {\n \"created_at\": \"2022-05-25 02:00:01\",\n \"master_uuid\": \"aa546efe-8c33-480f-91a6-9e7e58b9d80a\",\n \"pool\": \"\",\n \"size\": 40,\n \"type\": \"backup\",\n \"uuid\": \"44a66936-7eb0-4fc5-ade9-b86cff3e358d\"\n },\n {\n \"created_at\": \"2022-05-18 02:00:02\",\n \"master_uuid\": \"aa546efe-8c33-480f-91a6-9e7e58b9d80a\",\n \"pool\": \"\",\n \"size\": 40,\n \"type\": \"backup\",\n \"uuid\": \"31b001c6-d6e1-4ffa-a755-8f79bf10d2aa\"\n },\n {\n \"created_at\": \"2022-05-11 02:00:02\",\n \"master_uuid\": \"aa546efe-8c33-480f-91a6-9e7e58b9d80a\",\n \"pool\": \"\",\n \"size\": 40,\n \"type\": \"backup\",\n \"uuid\": \"45174cec-79be-4ebd-ab64-99dc5c33b64a\"\n },\n {\n \"created_at\": \"2022-05-04 02:00:02\",\n \"master_uuid\": \"aa546efe-8c33-480f-91a6-9e7e58b9d80a\",\n \"pool\": \"\",\n \"size\": 40,\n \"type\": \"backup\",\n \"uuid\": \"8a2a2ad9-98a7-44b0-81b7-39e98eb28bd5\"\n }\n ],\n \"shared\": false,\n \"size\": 60,\n \"type\": \"n/a\",\n \"updated_at\": \"2022-05-26 13:07:07\",\n \"user_id\": 29,\n \"uuid\": \"aa546efe-8c33-480f-91a6-9e7e58b9d80a\"\n}"}],"_postman_id":"029cf3ac-bd61-425d-ba32-c4384908f123"},{"name":"Boot VM from Rescue ISO","event":[{"listen":"test","script":{"id":"056c37a3-9e30-4009-a31f-76314d23b3e0","exec":[""],"type":"text/javascript"}}],"id":"72a54421-7617-427f-9d94-4223b2551f49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"

UUID of Virtual Machine

\n","key":"uuid","type":"text","value":"b00f40f3-fb61-4c08-85d8-18f50a333b3f"},{"key":"rescue_image_name","value":"ubuntu-22.04.2-desktop-amd64.rescue.iso","description":"

Name of ISO to boot, optional

\n","type":"text"}]},"url":"{{url}}/v1/user-resource/admin/vm/rescue_start","description":"

Boots a stopped VM from a rescue ISO. By default System Rescue ISO is used.

Optional parameter rescue_image_name can be used to boot any other ISO. The ISO image must exist in the same Ceph pool that contains VM disk images. It is required that the ISO name on Ceph has .rescue.iso as suffix, otherwise the ISO image will not be found.

E.g. a good full path for Ubuntu 22.04 ISO would be vm-disk-images/ubuntu-22.04.2-desktop-amd64.rescue.iso

\n","urlObject":{"path":["v1","user-resource","admin","vm","rescue_start"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"72a54421-7617-427f-9d94-4223b2551f49"},{"name":"Set VM bandwidth limits","event":[{"listen":"test","script":{"id":"056c37a3-9e30-4009-a31f-76314d23b3e0","exec":[""],"type":"text/javascript","packages":{}}}],"id":"edb3ed4f-2faa-4e6b-94e3-bc2d332958bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"

UUID of Virtual Machine

\n","key":"uuid","type":"text","value":"de22e8e1-b443-4320-ba95-0f848a8f4aaa"},{"key":"average_kbps","value":"51200","type":"text"},{"key":"peak_kbps","value":"256000","type":"text"},{"key":"burst_kb","value":"102400","type":"text"}]},"url":"{{url}}/v1/base-operator/admin/vm/iftune","description":"

Sets network bandwidth limits for a VM. Limits are stored and applied immediately to a running VM.

In the returning VM object, nic_iftune will show the stored VM specific bandwidth limits.

To clear VM specific limits, send the request with UUID as the only parameter.

To override global limits and have unlimited bandwidth for this VM only, set average_kbps to 0, other limit parameters will default to 0 if unset.

See https://libvirt.org/formatnetwork.html#quality-of-service for more information.

\n","urlObject":{"path":["v1","base-operator","admin","vm","iftune"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"5c52820d-e85f-4504-bc73-d147a8fe1637","name":"Set VM bandwidth limits","originalRequest":{"method":"PUT","header":[{"key":"apikey","value":"{{apikey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"UUID of Virtual Machine","key":"uuid","type":"text","value":"de22e8e1-b443-4320-ba95-0f848a8f4aaa"},{"key":"average_kbps","value":"51200","type":"text"},{"key":"peak_kbps","value":"256000","type":"text"},{"key":"burst_kb","value":"102400","type":"text"}]},"url":"{{url}}/v1/base-operator/admin/vm/iftune"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Expose-Headers","value":"x-warren-correlation-id,X-Warren-Correlation-Id"},{"key":"Content-Length","value":"1697"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 16 Aug 2024 09:37:03 GMT"},{"key":"Server","value":"gunicorn/19.9.0"},{"key":"Via","value":"kong/0.13.1"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"X-Kong-Upstream-Latency","value":"2240"},{"key":"X-Warren-Correlation-Id","value":"bop-w9m9884"}],"cookie":[],"responseTime":null,"body":"{\n \"backup\": false,\n \"created_at\": \"2024-07-12 12:01:55\",\n \"current_pool_name\": \"Automatically added Pool\",\n \"current_pool_uuid\": \"3590345e-0507-49d7-8e69-7fb16311a3a5\",\n \"description\": \"load bearer\",\n \"designated_pool_id\": 1600000096,\n \"designated_pool_name\": \"Automatically added Pool\",\n \"designated_pool_uuid\": \"3590345e-0507-49d7-8e69-7fb16311a3a5\",\n \"hostname\": \"loadbearer\",\n \"hypervisor_uuid\": \"37313436-3934-5a43-3335-323231364841\",\n \"is_current_pool_visible\": true,\n \"is_deleted\": false,\n \"is_designated_pool_visible\": true,\n \"is_locked\": false,\n \"latest_host_pool_uuid\": \"3590345e-0507-49d7-8e69-7fb16311a3a5\",\n \"mac\": \"52:54:00:9b:88:a0\",\n \"needs_recovery\": false,\n \"nic_iftune\": {\n \"average_kbps\": 51200,\n \"burst_kb\": 102400,\n \"peak_kbps\": 256000\n },\n \"os_name\": \"ubuntu\",\n \"os_version\": \"22.04_orig\",\n \"private_ipv4\": \"10.7.58.242\",\n \"public_ipv6\": \"2a05:1cc0:10:3::8:fffe\",\n \"status\": \"running\",\n \"updated_at\": \"2024-08-16 09:36:40\",\n \"user_data\": {\n \"instance-id\": \"de22e8e1-b443-4320-ba95-0f848a8f4aaa\",\n \"hostname\": \"loadbearer\",\n \"local-hostname\": \"loadbearer\",\n \"fqdn\": \"\",\n \"groups\": [\n \"sverik\"\n ],\n \"users\": [\n {\n \"name\": \"sverik\",\n \"primary-group\": \"sverik\",\n \"groups\": [\n \"users\",\n \"wheel\"\n ],\n \"shell\": \"/bin/bash\",\n \"sudo\": \"ALL=(ALL) NOPASSWD:ALL\",\n \"lock-passwd\": false,\n \"ssh_pwauth\": true,\n \"ssh-authorized-keys\": [\n \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIEjuoavg9y4bwCWLOuYMjbjnJSEXY/wR64KHImzkRCrE sverik@manul\"\n ]\n }\n ],\n \"chpasswd\": {\n \"list\": \"sverik:$6$rounds=4096$hBxrlutn2BnMVoEQ$P0A8cZhzqdOytho/I2P5iRBMK/N9OftK8Ex8runVbgnYIYHvU/YMFgpLVL7eq4DBg5.xjEgpgwiKAEdMCr11Z0\\n\"\n },\n \"ssh_pwauth\": true,\n \"package_upgrade\": false\n },\n \"user_id\": 8,\n \"username\": \"sverik\",\n \"uuid\": \"de22e8e1-b443-4320-ba95-0f848a8f4aaa\",\n \"vcpu\": 2,\n \"vlan_id\": 1588\n}"}],"_postman_id":"edb3ed4f-2faa-4e6b-94e3-bc2d332958bd"},{"name":"Get VM domain XML","event":[{"listen":"test","script":{"id":"45d75838-6860-4db7-a010-d614b6e6d1ee","exec":[""],"type":"text/javascript","packages":{}}}],"id":"6956adc6-0da6-46b0-af83-9a126434bc34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}"}],"url":"{{url}}/v1/base-operator/admin/vm/virsh_dumpxml?uuid=de22e8e1-b443-4320-ba95-0f848a8f4aaa","description":"

For a VM that is defined on a hypervisor, return its libvirt domain XML definition.

If a VM is stopped and undefined, 400 Bad Request will be returned.

\n","urlObject":{"path":["v1","base-operator","admin","vm","virsh_dumpxml"],"host":["{{url}}"],"query":[{"description":{"content":"

UUID of Virtual Machine

\n","type":"text/plain"},"key":"uuid","value":"de22e8e1-b443-4320-ba95-0f848a8f4aaa"}],"variable":[]}},"response":[{"id":"191cc447-fe03-443e-babe-8dbd092902d5","name":"Get VM domain XML","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}"}],"url":{"raw":"{{url}}/v1/base-operator/admin/vm/virsh_dumpxml?uuid=de22e8e1-b443-4320-ba95-0f848a8f4aaa","host":["{{url}}"],"path":["v1","base-operator","admin","vm","virsh_dumpxml"],"query":[{"key":"uuid","value":"de22e8e1-b443-4320-ba95-0f848a8f4aaa","description":"UUID of Virtual Machine"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Access-Control-Expose-Headers","value":"x-warren-correlation-id,X-Warren-Correlation-Id"},{"key":"Content-Length","value":"6201"},{"key":"Content-Type","value":"application/xml"},{"key":"Date","value":"Fri, 16 Aug 2024 09:24:08 GMT"},{"key":"Server","value":"gunicorn/19.9.0"},{"key":"Via","value":"kong/0.13.1"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"X-Kong-Upstream-Latency","value":"1045"},{"key":"X-Warren-Correlation-Id","value":"bop-4ejl05a1"}],"cookie":[],"responseTime":null,"body":"\n de22e8e1-b443-4320-ba95-0f848a8f4aaa\n de22e8e1-b443-4320-ba95-0f848a8f4aaa\n 1048576\n 1048576\n 2\n \n /machine\n \n \n hvm\n \n \n \n \n \n \n \n Westmere-IBRS\n \n \n \n \n \n \n \n \n \n \n \n \n \n destroy\n restart\n destroy\n \n \n \n \n \n /run/libvirt/nix-emulators/qemu-system-x86_64\n \n \n \n \n \n \n \n \n \n \n 209715200\n 15000\n 524288000\n 50200\n 5\n 4\n \n a4d148a9-767a-4d96-8\n \n

\n \n \n \n

\n \n \n \n \n

\n \n \n \n \n \n \n

\n \n \n \n \n \n \n \n \n \n \n

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n \n \n \n \n \n

\n \n \n \n

\n \n \n \n \n \n \n \n \n \n \n

Flag	Description
`is_accepting_workloads`	If true then this host is considered a valid targed for new and migrated VMs. If false then no new VMs will be allocated to this host. Existing VMs will keep running. Admin will still be able to explicitly migrate VMs to that host.
`is_maintenance`	If true then all VMs on this host will be automatically migrated to other hosts. Use this if the host is accessible and you want to make it empty.
`is_offline`	If true then the host is considered to be unavailable, all VMs on this host will be automatically recreated on other hosts (it is like doing Force Stop and Start to all its VMs). Potentially dangerous, it can lead to a nasty split-brain issue if the host is not actually stopped and VMs are still running there! Use only if you are sure that there are no running VMs on that host.
`is_deleted`	If true then the host has been removed from the cluster. It will not be shown in admin views anymore.