{"info":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","description":"

Welcome to the VasHosting.cz API documentation! This API can be used for manipulating with servers, domains and all services related to domains (dns, emails, crons, etc.).

Feel free to give us some feedback and things you think our API could do.

Response formats

Our api communicates only via JSON, we receive JSON body via the POST requests, and we provide back usually empty 204 response or response code 200 with JSON body if we need to provide you some information.

Successfull responses: 200 (with json), 204 (empty body).
Error responses: 4xx (with JSON, please read the \"message\" json key).

You can see examples of correct requests (with successful responses) and bad requests (with error responses) under each endpoint's demo.

Variables in URLs

An example variable in url can be (your domain name) or (your server hostname), variables will tel us the context and they will setup the environment.

Units

As we provide hosting for your domains and offer managed VDSes/VPSes, too, we need to handle with various units for storage and operational memories. As hosting tariffs for domains are usually used for smaller projects, it works with smaller units (like kB and MB) as stored data isn't too big. On the other side, managed servers often works with bigger data in GB and TB. To deal with this asymmetry we decided to use two unit systems in this API.

\n\n

Everything around domains (includes all related services like databases, FTP or emails) uses Megabytes (MB) in endpoints of this API.

When we need to count with bigger numbers, we always divide by 1,000, so e.g. 1 GB = 1,000 MB.

Servers (VPS, VDS)

When dealing with storage units and limitations around servers (VPSes and VDSes), always use Gigabytes (GB) for disk spaces and Gibibytes (GiB) for RAM size.

When we need to save higher unit, for instance TB, we will divide bytes by 1,000 for storage (server drives, etc.) and by 1,024 for RAM.

Authorization

Every your request needs to be authorized, authorization is done via API keys, they can be created here https://portal.vas-hosting.cz/api-key and scope is currently unlimited, they will be displayed only once, since we are encrypting them and we cannot show them again, so please save them to some secure place.

Authorizatin is done with http headers, header name is X-API-Key and the value is your api key.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"26076792","collectionId":"385cb945-6e04-46b0-970b-4d04cdfdaf46","publishedId":"2s93CRJque","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-02-27T13:39:23.000Z"},"item":[{"name":"Account","item":[{"name":"List unpaid invoices","id":"3d2de5e6-2a05-4391-8581-00354cff8002","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://portal.vas-hosting.cz/api/v1/account/unpaid-invoices","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","account","unpaid-invoices"],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"8f08ef54-5c97-4835-bdaa-d6c23af4bea1","name":"Working example","originalRequest":{"method":"GET","header":[],"url":"https://portal.vas-hosting.cz/api/v1/account/unpaid-invoices"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 03 Mar 2023 03:00:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":"{\n \"3023000368\": {\n \"totalPrice\": \"0.00\",\n \"createdAt\": \"2023-01-17\",\n \"expiresAt\": \"2023-01-22\"\n },\n \"3023000370\": {\n \"totalPrice\": \"4414.08\",\n \"createdAt\": \"2023-01-17\",\n \"expiresAt\": \"2023-01-22\"\n },\n \"3023000372\": {\n \"totalPrice\": \"4065.60\",\n \"createdAt\": \"2023-01-17\",\n \"expiresAt\": \"2023-01-22\"\n },\n \"3023000373\": {\n \"totalPrice\": \"348.48\",\n \"createdAt\": \"2023-01-17\",\n \"expiresAt\": \"2023-01-22\"\n },\n \"3023000374\": {\n \"totalPrice\": \"209.33\",\n \"createdAt\": \"2023-01-23\",\n \"expiresAt\": \"2023-01-28\"\n },\n \"3023000375\": {\n \"totalPrice\": \"209.33\",\n \"createdAt\": \"2023-01-23\",\n \"expiresAt\": \"2023-01-28\"\n },\n \"3023000377\": {\n \"totalPrice\": \"532.40\",\n \"createdAt\": \"2023-01-23\",\n \"expiresAt\": \"2023-01-28\"\n },\n \"3023000378\": {\n \"totalPrice\": \"3726.80\",\n \"createdAt\": \"2023-01-23\",\n \"expiresAt\": \"2023-01-28\"\n },\n \"3023000381\": {\n \"totalPrice\": \"399.30\",\n \"createdAt\": \"2023-01-27\",\n \"expiresAt\": \"2023-02-01\"\n },\n \"3023000382\": {\n \"totalPrice\": \"605.00\",\n \"createdAt\": \"2023-01-30\",\n \"expiresAt\": \"2023-02-04\"\n },\n \"3023000387\": {\n \"totalPrice\": \"1980.77\",\n \"createdAt\": \"2023-02-21\",\n \"expiresAt\": \"2023-02-26\"\n },\n \"3023000388\": {\n \"totalPrice\": \"209.33\",\n \"createdAt\": \"2023-02-21\",\n \"expiresAt\": \"2023-02-26\"\n },\n \"3023000394\": {\n \"totalPrice\": \"3509.00\",\n \"createdAt\": \"2023-02-24\",\n \"expiresAt\": \"2023-03-01\"\n },\n \"3023000396\": {\n \"totalPrice\": \"1628.66\",\n \"createdAt\": \"2023-02-28\",\n \"expiresAt\": \"2023-03-05\"\n }\n}"}],"_postman_id":"3d2de5e6-2a05-4391-8581-00354cff8002"},{"name":"Pay unpaid invoice","id":"4e1597a2-045e-4bed-bd74-0eb68076bbe1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://portal.vas-hosting.cz/api/v1/account/unpaid-invoices//pay-with-credit","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","account","unpaid-invoices","","pay-with-credit"],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"ffd3e884-0b45-4074-ba7f-6f214e711739","name":"Working example","originalRequest":{"method":"POST","header":[],"url":"https://portal.vas-hosting.cz/api/v1/account/unpaid-invoices//pay-with-credit"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 03 Mar 2023 03:07:41 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4e1597a2-045e-4bed-bd74-0eb68076bbe1"}],"id":"6cb3fb08-e4e8-4224-a8b4-0cf4041742ad","_postman_id":"6cb3fb08-e4e8-4224-a8b4-0cf4041742ad","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}}},{"name":"Domains","item":[{"name":"Databases","item":[{"name":"List databases","id":"746622b5-3851-4ff7-9ad5-54dfb6c1103e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://portal.vas-hosting.cz/api/v1/domains//databases","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","domains","","databases"],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"1d370dda-aba9-4cc4-81e0-5566195dbede","name":"Working example","originalRequest":{"method":"GET","header":[],"url":"https://portal.vas-hosting.cz/api/v1/domains//databases"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 03 Mar 2023 02:06:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":"{\n \"invoicekd_5579\": {\n \"user\": \"invoicekd.5579\",\n \"type\": \"mysql\",\n \"size\": 100\n },\n \"kareldyta_5579\": {\n \"user\": \"kareldyta.5579\",\n \"type\": \"mysql\",\n \"size\": 200\n },\n \"kareldytb_5579\": {\n \"user\": \"kareldytb.5579\",\n \"type\": \"mysql\",\n \"size\": 0\n },\n \"kareldytrycha_5579\": {\n \"user\": \"kareldytrycha_5579\",\n \"type\": \"postgresql\",\n \"size\": 300\n },\n \"kareldytrychcza_5579\": {\n \"user\": \"kareldytrychcza_5579\",\n \"type\": \"postgresql\",\n \"size\": 152\n },\n \"kareldytrychczb_5579\": {\n \"user\": \"kareldytrychczb_5579\",\n \"type\": \"postgresql\",\n \"size\": 326\n },\n \"mysql_5579\": {\n \"user\": \"mysql.5579\",\n \"type\": \"mysql\",\n \"size\": 0\n }\n}"}],"_postman_id":"746622b5-3851-4ff7-9ad5-54dfb6c1103e"},{"name":"Create database","id":"5a4c208e-3681-47c7-a704-d1b3bd0aedba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"foobar_5579\", \r\n \"type\": \"mysql\",\r\n \"password\": \"mytopsecretpassword\", \r\n \"encoding\": \"utf8mb4_unicode_ci\",\r\n \"note\": null\r\n}"},"url":"https://portal.vas-hosting.cz/api/v1/domains//databases","description":"

\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

JSON Parameter	Required	Description
name (string)	yes	Database name
type (mysql/postgresql)	yes	Database software
password (string 8-64)	yes	User password
encoding (string)	no	MySQL/PostgreSQL encoding
note (string)	no	Note

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

JSON Parameter	Required	Description
password (string 8-64)	yes	New password

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","domains","","databases","","change-password"],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"5128dd2a-8f41-4e13-82e8-d2812b548b24","name":"Working example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"password\": \"mynewpassword\"\r\n}"},"url":"https://portal.vas-hosting.cz/api/v1/domains//databases//change-password"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 03 Mar 2023 02:14:37 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8800f5aa-65da-491a-adb7-5b1744278b1b"},{"name":"Backup database","id":"f86981bd-22c5-48d4-ab1a-f17539a8ebc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://portal.vas-hosting.cz/api/v1/domains//databases//backup","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","domains","","databases","","backup"],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"0a2d8a8e-587f-4500-bcb1-6101a71221c3","name":"Working example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://portal.vas-hosting.cz/api/v1/domains//databases//backup"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 03 Mar 2023 02:18:01 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f86981bd-22c5-48d4-ab1a-f17539a8ebc2"},{"name":"Delete database","id":"26f790da-8541-4f78-94d6-11447f41017a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://portal.vas-hosting.cz/api/v1/domains//databases/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","domains","","databases",""],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"ccf57bc6-14ab-4cfb-877f-3d9eeb3583c8","name":"Working example","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://portal.vas-hosting.cz/api/v1/domains//databases/"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 03 Mar 2023 02:15:54 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"26f790da-8541-4f78-94d6-11447f41017a"}],"id":"2ba5b6b8-0a42-46b3-9483-77684be09ab7","description":"

Units

All API endpoints for databases uses Megabytes (MB) as storage size units.

\n","_postman_id":"2ba5b6b8-0a42-46b3-9483-77684be09ab7","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}}},{"name":"DNS records","item":[{"name":"List DNS records","id":"2af90a07-8671-4c66-8e50-d795c8f0cb6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"https://portal.vas-hosting.cz/api/v1/domains//dns-records","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","domains","","dns-records"],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"81823416-3a77-4cfc-ae6b-47b4ac356181","name":"Working example","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"https://portal.vas-hosting.cz/api/v1/domains//dns-records"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 06 Feb 2024 21:19:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":"{\n \"139816\": {\n \"name\": \"test.kareldytrych.cz\",\n \"type\": \"A\",\n \"content\": \"1.1.1.3\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": \"Test record\",\n \"created\": \"2016-02-22 08:48:16\",\n \"updated\": \"2023-03-03 23:08:32\"\n },\n \"139817\": {\n \"name\": \"kareldytrych.cz\",\n \"type\": \"NS\",\n \"content\": \"ns.vas-hosting.eu\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2016-02-22 08:48:16\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"139818\": {\n \"name\": \"kareldytrych.cz\",\n \"type\": \"NS\",\n \"content\": \"ns.vas-hosting.com\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2016-02-22 08:48:16\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"139819\": {\n \"name\": \"kareldytrych.cz\",\n \"type\": \"A\",\n \"content\": \"95.168.209.66\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2016-02-22 08:48:16\",\n \"updated\": \"2023-03-03 23:12:37\"\n },\n \"139820\": {\n \"name\": \"kareldytrych.cz\",\n \"type\": \"MX\",\n \"content\": \"xyz.vas-hosting.cz\",\n \"priority\": 12,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2016-02-22 08:48:16\",\n \"updated\": \"2023-12-20 12:25:08\"\n },\n \"139821\": {\n \"name\": \"www.kareldytrych.cz\",\n \"type\": \"A\",\n \"content\": \"95.168.209.68\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2016-02-22 08:48:16\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"139822\": {\n \"name\": \"*.kareldytrych.cz\",\n \"type\": \"A\",\n \"content\": \"37.235.104.64\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": \"dsadasda\",\n \"created\": \"2016-02-22 08:48:16\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"146033\": {\n \"name\": \"autoconfig.kareldytrych.cz\",\n \"type\": \"CNAME\",\n \"content\": \"test.vas-hosting.cz\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2016-08-13 06:54:35\",\n \"updated\": \"2023-12-20 12:25:01\"\n },\n \"146034\": {\n \"name\": \"autodiscover.kareldytrych.cz\",\n \"type\": \"CNAME\",\n \"content\": \"mail.vas-hosting.cz\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2016-08-13 06:54:35\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"146035\": {\n \"name\": \"_autodiscover._tcp.kareldytrych.cz\",\n \"type\": \"SRV\",\n \"content\": \"10 1 443 mail.vas-hosting.cz\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2016-08-13 06:54:35\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"213884\": {\n \"name\": \"kareldytrych.cz\",\n \"type\": \"CAA\",\n \"content\": \"0 issue \\\"letsencrypt.org\\\"\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2019-08-21 20:10:04\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"232965\": {\n \"name\": \"kareldytrych.cz\",\n \"type\": \"TXT\",\n \"content\": \"v=spf1 a mx ?all\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2020-02-25 09:36:16\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"428812\": {\n \"name\": \"test.kareldytrych.cz\",\n \"type\": \"A\",\n \"content\": \"0.1.0.33\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2022-11-19 09:01:44\",\n \"updated\": \"2023-03-03 23:13:00\"\n },\n \"428813\": {\n \"name\": \"qqq.kareldytrych.cz\",\n \"type\": \"TXT\",\n \"content\": \"v=spf1 a mx ?all\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2022-11-19 09:17:16\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"439225\": {\n \"name\": \"test2.kareldytrych.cz\",\n \"type\": \"A\",\n \"content\": \"9.8.7.9\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2023-02-15 04:25:50\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"439226\": {\n \"name\": \"test.kareldytrych.cz\",\n \"type\": \"A\",\n \"content\": \"9.8.7.7\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2023-02-25 21:29:18\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"439227\": {\n \"name\": \"test.kareldytrych.cz\",\n \"type\": \"A\",\n \"content\": \"9.8.7.1\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2023-02-25 21:29:59\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"439228\": {\n \"name\": \"test2.kareldytrych.cz\",\n \"type\": \"A\",\n \"content\": \"9.8.7.1\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2023-02-25 21:31:58\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"439229\": {\n \"name\": \"test.kareldytrych.cz\",\n \"type\": \"A\",\n \"content\": \"9.8.7.9\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2023-02-25 21:32:48\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"439230\": {\n \"name\": \"test.kareldytrych.cz\",\n \"type\": \"A\",\n \"content\": \"9.8.7.2\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2023-02-25 21:33:22\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"439231\": {\n \"name\": \"test.kareldytrych.cz\",\n \"type\": \"A\",\n \"content\": \"9.8.7.0\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2023-02-25 21:40:42\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"439236\": {\n \"name\": \"foo.kareldytrych.cz\",\n \"type\": \"AAAA\",\n \"content\": \"::1\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2023-03-02 15:27:42\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"439237\": {\n \"name\": \"bar.kareldytrych.cz\",\n \"type\": \"AAAA\",\n \"content\": \"1:2:abc:456:009::1\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2023-03-02 15:28:20\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"439238\": {\n \"name\": \"bar.kareldytrych.cz\",\n \"type\": \"AAAA\",\n \"content\": \"123::111:1:12\",\n \"priority\": null,\n \"ttl\": 3600,\n \"note\": null,\n \"created\": \"2023-03-02 15:31:10\",\n \"updated\": \"2023-03-03 20:42:13\"\n },\n \"439333\": {\n \"name\": \"kareldytrych.cz\",\n \"type\": \"TXT\",\n \"content\": \"test123\",\n \"priority\": null,\n \"ttl\": 1800,\n \"note\": null,\n \"created\": \"2024-01-10 10:06:20\",\n \"updated\": \"2024-01-10 10:10:42\"\n },\n \"439334\": {\n \"name\": \"kareldytrych.cz\",\n \"type\": \"TXT\",\n \"content\": \"test\",\n \"priority\": null,\n \"ttl\": 1800,\n \"note\": null,\n \"created\": \"2024-01-10 10:10:16\",\n \"updated\": \"2024-01-10 10:10:19\"\n },\n \"439336\": {\n \"name\": \"kareldytrych.cz\",\n \"type\": \"TXT\",\n \"content\": \"google-site-verification: google12cfc8677988bb4.html\",\n \"priority\": null,\n \"ttl\": 1800,\n \"note\": null,\n \"created\": \"2024-01-10 10:13:25\",\n \"updated\": \"2024-01-10 10:13:28\"\n }\n}"}],"_postman_id":"2af90a07-8671-4c66-8e50-d795c8f0cb6d"},{"name":"Create DNS record","id":"a01b941d-6a3b-4385-b072-b00a958891fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"test\",\r\n \"content\": \"9.8.7.6\",\r\n \"type\": \"A\",\r\n \"ttl\": 1800\r\n}"},"url":"https://portal.vas-hosting.cz/api/v1/domains//dns-records","description":"

\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

JSON Parameter	Required	Description
name (string)	yes	Record name
content (string)	yes	Record content/value
type (string)	yes	Type (A/MX/TXT etc.)
ttl (int 60-86400)	yes	Time to live
priority (int 0-65535)	no	Priority for MX records
note (string)	no	Your internal note

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","domains","","dns-records"],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"26adc3fa-23e1-4a3e-a78d-7dbf7d8dbb5d","name":"Working example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"test\", \r\n \"content\": \"9.8.7.0\", \r\n \"type\": \"A\", \r\n \"ttl\": 1800\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://portal.vas-hosting.cz/api/v1/domains//dns-records"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Sat, 25 Feb 2023 20:40:42 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":""},{"id":"9eec820f-e540-4b1b-9f14-f91f55d705a5","name":"Collision","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"test\", \r\n \"content\": \"9.8.7.5\", \r\n \"type\": \"A\", \r\n \"ttl\": 1800\r\n}\r\n"},"url":"https://portal.vas-hosting.cz/api/v1/domains//dns-records"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Sat, 25 Feb 2023 20:24:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"DNS record already exists (content)\"\n}"},{"id":"0d153a9e-ca7e-44a6-ab98-8d85787fb55e","name":"Bad parameters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"test\", \r\n \"content\": \"9.8.7.6\", \r\n \"type\": \"A\", \r\n \"ttl\": 1\r\n}\r\n"},"url":"https://portal.vas-hosting.cz/api/v1/domains//dns-records"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Sat, 25 Feb 2023 20:41:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": 422,\n \"message\": \"Request body contains an error. See context for details.\",\n \"context\": {\n \"validation\": {\n \"ttl\": [\n \"This value should be between 60 and 86400.\"\n ]\n }\n }\n}"},{"id":"5ce01198-a979-4f84-9fee-976cb04c45e2","name":"Bad parameters Copy","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"test\", \r\n \"content\": \"9.8.7.6\", \r\n \"type\": \"A\", \r\n \"ttl\": 1\r\n}\r\n"},"url":"https://portal.vas-hosting.cz/api/v1/domains//dns-records"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Sat, 25 Feb 2023 20:41:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": 422,\n \"message\": \"Request body contains an error. See context for details.\",\n \"context\": {\n \"validation\": {\n \"ttl\": [\n \"This value should be between 60 and 86400.\"\n ]\n }\n }\n}"}],"_postman_id":"a01b941d-6a3b-4385-b072-b00a958891fc"},{"name":"Edit DNS record","id":"3dcef33e-7303-4d90-983e-d005764e0f63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"test\", \r\n \"content\": \"1.1.1.1\", \r\n \"type\": \"A\", \r\n \"ttl\": 1800\r\n}\r\n"},"url":"https://portal.vas-hosting.cz/api/v1/domains//dns-records/","description":"

\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

JSON Parameter	Required	Description
name (string)	yes	Record name
content (string)	yes	Record content/value
type (string)	yes	Type (A/MX/TXT etc.)
ttl (int 60-86400)	yes	Time to live
priority (int 0-65535)	no	Priority for MX records
note (string)	no	Your internal note

This API endpoint is for creating, updating and deleting your DNS records. You can also access your NS records and change/delete them.

\n","_postman_id":"8e57c664-a450-4380-a4fc-82f6a630b0fc","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}}},{"name":"Email accounts","item":[{"name":"List email accounts","id":"e3fdd578-bfb4-418e-9ac6-6fb397754a07","protocolProfileBehavior":{"disableBodyPruning":true,"followAuthorizationHeader":false},"request":{"method":"GET","header":[],"url":"https://portal.vas-hosting.cz/api/v1/domains//email-accounts","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","domains","","email-accounts"],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"0a072ed6-072b-4ca0-91e5-ed7d626c8e7e","name":"Working example","originalRequest":{"method":"GET","header":[],"url":"https://portal.vas-hosting.cz/api/v1/domains//email-accounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 28 Feb 2023 23:06:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":"{\n \"bar\": {\n \"quota\": 0,\n \"isAutoReply\": false,\n \"isActive\": true\n },\n \"foo\": {\n \"quota\": 0,\n \"isAutoReply\": false,\n \"isActive\": true\n },\n \"foobar\": {\n \"quota\": 0,\n \"isAutoReply\": false,\n \"isActive\": true\n },\n \"karel\": {\n \"quota\": 0,\n \"isAutoReply\": false,\n \"isActive\": true\n }\n}"}],"_postman_id":"e3fdd578-bfb4-418e-9ac6-6fb397754a07"},{"name":"Create an email account","id":"1ecd6078-4eb1-4745-b1ad-6c57254838d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"foobar\", \r\n \"displayName\": \"Karel Dytrych\", \r\n \"password\": \"mytopsecretpassword\", \r\n \"quota\": 200\r\n}"},"url":"https://portal.vas-hosting.cz/api/v1/domains//email-accounts","description":"

\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

JSON Parameter	Required	Description
name (string)	yes	Account name
displayName (string)	yes	Display name
password (string 8-64)	yes	Account password
quota (int, MB)	yes	Quota (0 for unlimited)

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

JSON Parameter	Required	Description
password (string 8-64)	yes	New password

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

JSON Parameter	Required	Description
quota (int, MB)	yes	New quota

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

JSON Parameter	Required	Description
name (string)	yes	Email alias name

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","domains","","email-accounts","","alias"],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"132b03a1-f774-4082-9848-9a5f596227e4","name":"Add email alias","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"testing\"\r\n}"},"url":"https://portal.vas-hosting.cz/api/v1/domains//email-accounts//alias"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 01 Mar 2023 22:41:13 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"baf70b5f-7d9a-489b-bd94-42bc0de19d06"},{"name":"Delete email alias","id":"33b717fb-a2c2-462b-9e88-ae602f3bd820","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://portal.vas-hosting.cz/api/v1/domains//email-accounts//alias/testing","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","domains","","email-accounts","","alias","testing"],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"b62ceaef-889e-41eb-9504-e71a7852ff12","name":"Working example","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://portal.vas-hosting.cz/api/v1/domains//email-accounts//alias/testing"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 01 Mar 2023 22:45:09 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":null},{"id":"17eb0c11-51bd-4a17-b42f-9c4edc882aa4","name":"Alias does not exist","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://portal.vas-hosting.cz/api/v1/domains//email-accounts//alias/testing"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 01 Mar 2023 22:47:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"This alias does not exist.\"\n}"}],"_postman_id":"33b717fb-a2c2-462b-9e88-ae602f3bd820"},{"name":"Setup auto-reply","id":"2f132b11-ef4d-41e7-bbac-8dad7ea4e22e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"isActive\": true,\r\n \"autoActiveFrom\": \"2023-01-01 00:00:00\",\r\n \"autoActiveTo\": \"2023-02-02 00:00:00\",\r\n \"subject\": \"This is auto-reply subject\",\r\n \"content\": \"This is the body of the email\"\r\n}\r\n"},"url":"https://portal.vas-hosting.cz/api/v1/domains//email-accounts//setup-auto-reply","description":"

\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

JSON Parameter	Required	Description
isActive (boolean)	yes	Status
autoActiveFrom (string, datetime)	no	Auto. active from
autoActiveTo (string, datetime)	no	Auto. active to
subject (string)	no	Email title
content (string)	no	Email body

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

JSON Parameter	Required	Description
emails (array of strings)	yes	Emails to forward to
deleteOriginalEmail (boolean)	yes	Delete original email?

When working with email accounts, always use only account name that is before @yourdomain.com, because domain name is always specified in the URL, if you are manipulating with email test@yourdomain.com, url for changing password will look like this:

https://centrum.vas-hosting.cz/api/v1/domains/yourdomain.com/email-accounts/test/change-password\n\n

Units

All API endpoints for emails uses Megabytes (MB) as storage size units.

\n","_postman_id":"c4da7027-0f10-46d9-b73e-dc3b0648e886","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}}},{"name":"Ftp accounts","item":[{"name":"List FTP accounts","id":"fe4bb862-4f9f-49b1-9e45-3376d524c74d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://portal.vas-hosting.cz/api/v1/domains//ftp-accounts","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","domains","","ftp-accounts"],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"22411c53-f92a-43ea-afc6-7257979c9b77","name":"Working example","originalRequest":{"method":"GET","header":[],"url":"https://portal.vas-hosting.cz/api/v1/domains//email-accounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 28 Feb 2023 23:06:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":"{\n \"bar\": {\n \"quota\": 0,\n \"isAutoReply\": false,\n \"isActive\": true\n },\n \"foo\": {\n \"quota\": 0,\n \"isAutoReply\": false,\n \"isActive\": true\n },\n \"foobar\": {\n \"quota\": 0,\n \"isAutoReply\": false,\n \"isActive\": true\n },\n \"karel\": {\n \"quota\": 0,\n \"isAutoReply\": false,\n \"isActive\": true\n }\n}"}],"_postman_id":"fe4bb862-4f9f-49b1-9e45-3376d524c74d"},{"name":"Create FTP account","id":"3287e51d-5969-4c9d-92f5-9c4d4d7c340f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"foobar.5579\", \r\n \"directory\": \"/adminer\",\r\n \"password\": \"mytopsecretpassword\", \r\n \"quota\": 2000000000\r\n}"},"url":"https://portal.vas-hosting.cz/api/v1/domains//ftp-accounts","description":"

StartFragment

\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

JSON Parameter	Required	Description
name (string)	yes	Account name
directory (string)	yes	Directory path
password (string 8-64)	yes	Account password
quota (int, MB)	yes	Quota (0 for unlimited)

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

JSON Parameter	Required	Description
password (string 8-64)	yes	Account password

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

JSON Parameter	Required	Description
quota (int, MB)	yes	Quota (0 for unlimited)

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","domains","","ftp-accounts","","change-quota"],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[],"_postman_id":"62075398-7e33-4bbd-8279-bf081a63f806"},{"name":"Lock FTP account","id":"cf887b73-e362-4861-8b11-3d80b44e3433","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://portal.vas-hosting.cz/api/v1/domains//ftp-accounts//lock","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","domains","","ftp-accounts","","lock"],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"4a652269-656e-4384-8ae9-4ad1c1d8aaf0","name":"Working example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://portal.vas-hosting.cz/api/v1/domains//ftp-accounts//lock"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 01 Mar 2023 00:22:25 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"cf887b73-e362-4861-8b11-3d80b44e3433"},{"name":"Unlock FTP account","id":"13b6a65b-302c-44fa-afb4-bed69c46436e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://portal.vas-hosting.cz/api/v1/domains//ftp-accounts//unlock","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","domains","","ftp-accounts","","unlock"],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"f995c6b3-fa24-4fcf-a2d5-0e6d096454d6","name":"Working example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://portal.vas-hosting.cz/api/v1/domains//ftp-accounts//unlock"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 01 Mar 2023 00:23:41 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"13b6a65b-302c-44fa-afb4-bed69c46436e"},{"name":"Delete FTP account","id":"2ef1a0d5-f826-44a3-a0b0-c36fa0f08013","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://portal.vas-hosting.cz/api/v1/domains//ftp-accounts/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","domains","","ftp-accounts",""],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"eb0d312c-b7c3-4330-a1ed-4b8e33bcdfb9","name":"Working example","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://portal.vas-hosting.cz/api/v1/domains//ftp-accounts/"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 01 Mar 2023 00:34:34 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":null},{"id":"ba68182a-95fe-4de3-bbe0-8e97142fdebc","name":"Account not found","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://portal.vas-hosting.cz/api/v1/domains//ftp-accounts/"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 01 Mar 2023 00:34:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Account not found\"\n}"}],"_postman_id":"2ef1a0d5-f826-44a3-a0b0-c36fa0f08013"}],"id":"bfd41d91-c746-48c7-a152-571063732bc7","description":"

Units

All API endpoints around FTP uses Megabytes (MB) as storage size units.

\n","_postman_id":"bfd41d91-c746-48c7-a152-571063732bc7","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}}},{"name":"Get domain info","id":"13742d3b-a9c8-4ba0-89a7-68f92e435117","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://portal.vas-hosting.cz/api/v1/domains/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","domains",""],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"362aae28-0d91-4834-91ce-9d183f48b898","name":"Working example","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://portal.vas-hosting.cz/api/v1/domains/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 03 Mar 2023 03:25:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 5579,\n \"expiration\": \"2023-07-27\",\n \"isRegisteredByUs\": true,\n \"tariff\": \"flexi\",\n \"ip\": \"95.168.219.16\",\n \"dnssec\": false,\n \"storageQuota\": 26000,\n \"storageUsed\": 25160,\n \"storageFree\": 840\n}\n"}],"_postman_id":"13742d3b-a9c8-4ba0-89a7-68f92e435117"},{"name":"Change PHP version","id":"473d7e79-2d35-493a-8849-fa61a888de18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"version\":\"8.2\"\r\n}\r\n"},"url":"https://portal.vas-hosting.cz/api/v1/domains//change-php-version","description":"

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

JSON Parameter	Required	Description
version (string)	yes	PHP version

Units

As we noted at the top of this API documentation, all units (maily around storage and its limitations) for domains and related services (everything in this section) are in Megabytes (MB). As we count with jumping over content of this document, this information is repeated in all subsections.

\n","_postman_id":"a115edc0-b046-403c-86e4-92049ad6d08a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}}},{"name":"Servers","item":[{"name":"Labels","item":[{"name":"Get list of server labels","id":"ce07718c-0a81-4395-99fd-70573fc45c20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://portal.vas-hosting.cz/api/v1/servers/labels","description":"

Returns all created labels and their colors. These labels could be assigned to your servers for better identification, grouping or filtering. Filtering servers by their labels is supported directly through our API.

Creates new server label.

Name of the label (key name) can't contain any whitespace characters. It's restricted due to some limitations of working with labels in GUI.

Deletes an existing server label. If the label has been assigned to some servers, it is automatically unassigned before deletion. So, be careful which label you delete.

Modifies server label.

Name of the label (key name) can't contain any whitespace characters. It's restricted due to some limitations of working with labels in GUI.

Returns list of OSes we can automatically install for you. These operating systems could be used in API requests for server installations). If you need some special OS, you need to contact us for manual intervention.

Returns your assigned IP addresses that can be used for server installs.

Returns all active servers in customer's account.

Filtering

This endpoint supports an optional filtering.

By label name

You can filter servers by labels that were assigned to them before. This could be done using optional query parameter labels[], which takes an array of label names. You can support one or many labels this way, but it always has to be specified like an array query parameter.

Correct usage:

labels[]=my-label – Selects servers with label \"my-label\".
labels[]=first&labels[]=second – Selects servers with both \"first\" and \"second\" labels.

Wrong usage:

~~label=my-label~~ – The correct name of the query parameter is labels[], even for single label.
~~labels=my-label~~ – You need to provide query parameter as array always, even for single label.
~~labels[]=first,second~~ – When specifying two labels, you need to insert labels[] query parameter twice. This example would select filters with label named \"first,second\".

Optional query parameters for filtering by label name

\n","type":"text/plain"},"key":"labels[]","value":"label-name"}],"variable":[]}},"response":[{"id":"fac00867-8c9e-4821-adde-5a2145ccf18b","name":"Working example","originalRequest":{"method":"GET","header":[],"url":"https://portal.vas-hosting.cz/api/v1/servers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"tsd01.vas-server.cz\": {\n \"id\": 8367,\n \"name\": \"tsd01-john-doe\",\n \"displayName\": \"tsd01 - Test VPS server (full vps parent)\",\n \"dedicatedServerName\": \"tsd\",\n \"expiration\": \"2050-01-01\",\n \"tariff\": \"dedicated\",\n \"operatingSystem\": \"Debian Bullseye 64bit\",\n \"storage\": {\n \"primary\": 100000000000\n },\n \"ram\": 17179869184,\n \"status\": \"new\",\n \"addresses\": {\n \"ipv4\": {\n \"46.234.108.95\": {\n \"reverse\": null,\n \"changedAt\": \"2024-02-07 23:32:56\"\n }\n },\n \"ipv6\": []\n },\n \"labels\": [\n \"label-1\",\n \"label-with-servers\"\n ]\n }\n}"},{"id":"61bb3dde-64fa-4a41-8a5e-b442d3d140e8","name":"Working example with filtering by labels","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://portal.vas-hosting.cz/api/v1/servers?labels[]=label-1&labels[]=label-with-servers","host":["https://portal.vas-hosting.cz"],"path":["api","v1","servers"],"query":[{"key":"labels[]","value":"label-1","description":"Only servers with label \"label-1\""},{"key":"labels[]","value":"label-with-servers","description":"Only servers with label \"label-with-servers\""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"tsd01.vas-server.cz\": {\n \"id\": 8367,\n \"name\": \"tsd01-john-doe\",\n \"displayName\": \"tsd01 - Test VPS server (full vps parent)\",\n \"dedicatedServerName\": \"tsd\",\n \"expiration\": \"2050-01-01\",\n \"tariff\": \"dedicated\",\n \"operatingSystem\": \"Debian Bullseye 64bit\",\n \"storage\": {\n \"primary\": 100000000000\n },\n \"ram\": 17179869184,\n \"status\": \"new\",\n \"addresses\": {\n \"ipv4\": {\n \"46.234.108.95\": {\n \"reverse\": null,\n \"changedAt\": \"2024-02-07 23:32:56\"\n }\n },\n \"ipv6\": []\n },\n \"labels\": [\n \"label-1\",\n \"label-with-servers\"\n ]\n }\n}"}],"_postman_id":"6b537ccb-f16f-416a-92b3-17ea3c869e0e"},{"name":"Get server info","id":"77436138-f2e3-422f-a5c8-eb01fe76d76c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://portal.vas-hosting.cz/api/v1/servers/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","servers",""],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"800b29db-f5eb-4b3a-8634-59ad3acffd9e","name":"Working example","originalRequest":{"method":"GET","header":[],"url":"https://portal.vas-hosting.cz/api/v1/servers/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 03 Oct 2023 12:11:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 3,\n \"expiration\": \"2030-01-23\",\n \"tariff\": \"dedicated\",\n \"operatingSystem\": \"Debian Lenny 64bit\",\n \"storage\": {\n \"primary\": 232000000000\n },\n \"ram\": 8589934592,\n \"status\": \"suspended\",\n \"addresses\": {\n \"ipv4\": {\n \"95.168.205.136\": {\n \"reverse\": \"smo03.vas-服务器.cz\",\n \"changedAt\": \"2023-10-02 08:13:27\"\n },\n \"46.234.101.6\": {\n \"reverse\": \"spock03.webovy-servis.cz\",\n \"changedAt\": \"2023-10-02 08:13:27\"\n }\n },\n \"ipv6\": []\n }\n}"}],"_postman_id":"77436138-f2e3-422f-a5c8-eb01fe76d76c"},{"name":"Reboot server","id":"011c5645-070d-4128-ae90-5cb705b9f201","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://portal.vas-hosting.cz/api/v1/servers//reboot","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","servers","","reboot"],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"eb1013f0-86eb-4f78-9c5d-06ef4ac5c1c3","name":"Working example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://portal.vas-hosting.cz/api/v1/servers//reboot"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 03 Mar 2023 03:13:55 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":null},{"id":"bbce4a4c-b85c-402f-99db-d98abaf2888d","name":"Insufficient permissions","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://portal.vas-hosting.cz/api/v1/servers//reboot"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 03 Mar 2023 03:14:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Nette Framework 3"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"_nss=1; path=/; HttpOnly; SameSite=Strict"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"You have insufficient permissions to reboot this server, please contact our support.\"\n}"}],"_postman_id":"011c5645-070d-4128-ae90-5cb705b9f201"},{"name":"Get list of VDS","id":"b5d554ff-1355-4ef0-bd71-2c8bb07ae465","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://portal.vas-hosting.cz/api/v1/servers/vds","description":"

Returns all VDS available for authenticated customer.

Allows to install VPS (Virtual Private Server) on VDS (Virtual Dedicated Server). Dedicated servers could be partitioned to more virtual servers, when there is enough capacity of CPU, RAM, storage and the partitioning is allowed (you need to contact us, if you need to use this feature).

Used units (and value restrictions):

cpu — GHz (greater than 3)
ram — GiB (greater than or equal to 2)
primaryStorageSize — GB
primaryStorageLocation — number of VDS's disk slot (see https://documenter.getpostman.com/view/26076792/2s93CRJque#b5d554ff-1355-4ef0-bd71-2c8bb07ae465)
operatingSystem — OS identifier (see https://documenter.getpostman.com/view/26076792/2s93CRJque#493137a1-9d6f-44b9-8209-911897af75d2)
ipAddress — Ip address (optional, see https://documenter.getpostman.com/view/26076792/2s93CRJque#da892cd7-e364-439d-9080-765f0cd1082c)

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}},"urlObject":{"path":["api","v1","servers","","install-vps"],"host":["https://portal.vas-hosting.cz"],"query":[],"variable":[]}},"response":[{"id":"0abd3a05-aabc-4916-a4c8-04f0baf28b0a","name":"Working example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cpu\": 3,\n \"ram\": 4,\n \"primaryStorageSize\": 10,\n \"primaryStorageLocation\": 1,\n \"operatingSystem\": \"vpsc\",\n \"serverName\": \"Test server\"\n}","options":{"raw":{"language":"json"}}},"url":"https://portal.vas-hosting.cz/api/v1/servers//install-vps"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"2d017599-fdef-4bff-879e-f6f48344fe38","name":"Working example without optional arguments","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cpu\": 3000,\n \"ram\": 4,\n \"primaryStorageSize\": 10,\n \"primaryStorageLocation\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://portal.vas-hosting.cz/api/v1/servers//install-vps"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"1b209dd0-d740-4f7a-ac29-13bf9a1046ea","name":"Reaching maximum number of installed servers","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cpu\": 3000,\n \"ram\": 4,\n \"primaryStorageSize\": 10,\n \"primaryStorageLocation\": 1,\n \"operatingSystem\": \"vpsc\",\n \"serverName\": \"Test server\"\n}","options":{"raw":{"language":"json"}}},"url":"https://portal.vas-hosting.cz/api/v1/servers//install-vps"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"You have reached the maximum number of VPS (1) on this VDS.\"\n}"},{"id":"10c6d726-aff4-4131-9f5e-99df2c2de3ea","name":"Invalid storage location","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cpu\": 3000,\n \"ram\": 4,\n \"primaryStorageSize\": 10,\n \"primaryStorageLocation\": 3,\n \"operatingSystem\": \"vpsc\",\n \"serverName\": \"Test server\"\n}","options":{"raw":{"language":"json"}}},"url":"https://portal.vas-hosting.cz/api/v1/servers//install-vps"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": 422,\n \"message\": \"Request body contains an error. See context for details.\",\n \"context\": {\n \"validation\": {\n \"primaryStorageLocation\": [\n \"The value you selected is not a valid choice.\"\n ]\n }\n }\n}"},{"id":"915ce5c1-e87a-450e-b7bb-3777d06a5b23","name":"CPU frequency below minimum","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cpu\": 1000,\n \"ram\": 4,\n \"primaryStorageSize\": 10,\n \"primaryStorageLocation\": 1,\n \"operatingSystem\": \"vpsc\",\n \"serverName\": \"Test server\"\n}","options":{"raw":{"language":"json"}}},"url":"https://portal.vas-hosting.cz/api/v1/servers//install-vps"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": 422,\n \"message\": \"Request body contains an error. See context for details.\",\n \"context\": {\n \"validation\": {\n \"cpu\": [\n \"This value should be greater than or equal to 3000.\"\n ]\n }\n }\n}"},{"id":"352fcf59-b131-4e21-b79a-badd31180816","name":"More CPU frequency than available","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cpu\": 200000,\n \"ram\": 4,\n \"primaryStorageSize\": 10,\n \"primaryStorageLocation\": 1,\n \"operatingSystem\": \"vpsc\",\n \"serverName\": \"Test server\"\n}","options":{"raw":{"language":"json"}}},"url":"https://portal.vas-hosting.cz/api/v1/servers//install-vps"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"You have reached the maximum CPU frequency (192000 MHz) on this VDS.\"\n}"},{"id":"cf783860-edb6-4b38-bb49-88f713b56057","name":"RAM below minimum","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cpu\": 3000,\n \"ram\": 1,\n \"primaryStorageSize\": 10,\n \"primaryStorageLocation\": 1,\n \"operatingSystem\": \"vpsc\",\n \"serverName\": \"Test server\"\n}","options":{"raw":{"language":"json"}}},"url":"https://portal.vas-hosting.cz/api/v1/servers//install-vps"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": 422,\n \"message\": \"Request body contains an error. See context for details.\",\n \"context\": {\n \"validation\": {\n \"ram\": [\n \"This value should be greater than or equal to 2.\"\n ]\n }\n }\n}"},{"id":"03645a68-ceb9-479a-977f-398f5b918269","name":"More RAM than available","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cpu\": 3000,\n \"ram\": 64,\n \"primaryStorageSize\": 10,\n \"primaryStorageLocation\": 1,\n \"operatingSystem\": \"vpsc\",\n \"serverName\": \"Test server\"\n}","options":{"raw":{"language":"json"}}},"url":"https://portal.vas-hosting.cz/api/v1/servers//install-vps"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"You have reached the maximum RAM (32 GB) on this VDS.\"\n}"},{"id":"dd49c23f-1c24-497f-bfbb-18aba3d3aaa2","name":"More storage than available","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cpu\": 3000,\n \"ram\": 4,\n \"primaryStorageSize\": 200,\n \"primaryStorageLocation\": 1,\n \"operatingSystem\": \"vpsc\",\n \"serverName\": \"Test server\"\n}","options":{"raw":{"language":"json"}}},"url":"https://portal.vas-hosting.cz/api/v1/servers//install-vps"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"You have reached the maximum storage size (100 GB) in storage location 2 on this VDS.\"\n}"},{"id":"f90ea7c9-347e-48b3-882a-042eeeecce29","name":"Invalid OS identifier","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cpu\": 3000,\n \"ram\": 4,\n \"primaryStorageSize\": 10,\n \"primaryStorageLocation\": 1,\n \"operatingSystem\": \"invalid-os\",\n \"serverName\": \"Test server\"\n}","options":{"raw":{"language":"json"}}},"url":"https://portal.vas-hosting.cz/api/v1/servers//install-vps"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Operating system with specified identifier isn't supported. Default (when unset) is OS with VPS Center.\"\n}"},{"id":"5b34acf2-4982-4a4b-b575-46c5e699ee46","name":"Non-existent target VDS","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cpu\": 3000,\n \"ram\": 4,\n \"primaryStorageSize\": 10,\n \"primaryStorageLocation\": 1,\n \"operatingSystem\": \"vpsc\",\n \"serverName\": \"Test server\"\n}","options":{"raw":{"language":"json"}}},"url":"https://portal.vas-hosting.cz/api/v1/servers/invalid01.vas-server.cz/install-vps"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Server \\\"invalid01.vas-server.cz\\\" not found.\"\n}"},{"id":"cf2898b0-d66b-408d-8df4-3cddf1aabb83","name":"Target server is VPS (not VDS)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cpu\": 3000,\n \"ram\": 4,\n \"primaryStorageSize\": 10,\n \"primaryStorageLocation\": 1,\n \"operatingSystem\": \"vpsc\",\n \"serverName\": \"Test server\"\n}","options":{"raw":{"language":"json"}}},"url":"https://portal.vas-hosting.cz/api/v1/servers//install-vps"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"You can install VPS only on VDS via this endpoint.\"\n}"}],"_postman_id":"e22242c2-00bb-4df8-858b-c8e23b573a5b"},{"name":"Assign label to server","id":"818959ac-9fad-407f-9604-6129518e2d0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"label\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://portal.vas-hosting.cz/api/v1/servers//assign-label","description":"

Assigns prepared label to some server.

Unassigns previously assigned label from server.

Units

Every numbers for defining storage sizes are in Gigabytes (GB), RAM sizes are in Gibibytes (GiB).

\n","_postman_id":"f066ae7b-a605-4989-a5d5-5bef59a88c19","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","id":"385cb945-6e04-46b0-970b-4d04cdfdaf46","name":"Vas-Hosting API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"76e54c21-0518-41d4-ac07-9ccd9a947d49","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"219b3d9b-4f3b-4fb3-8e30-cc74d8c4a893","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"domain","value":""},{"key":"apiKey","value":""},{"key":"url","value":"https://portal.vas-hosting.cz"},{"key":"email","value":""},{"key":"ftp","value":""},{"key":"dnsRecordId","value":""},{"key":"database","value":""},{"key":"variableSymbol","value":""},{"key":"serverHostname","value":""},{"key":"emailAlias","value":""}]}

Response formats

Variables in URLs

Units

Domains (and related services)

Servers (VPS, VDS)

Authorization

Units

Units

Units

Units

Filtering

By label name

Units