{"id":507,"date":"2024-12-28T23:23:24","date_gmt":"2024-12-28T21:23:24","guid":{"rendered":"https:\/\/hostup.se\/en\/support\/?p=507"},"modified":"2025-12-01T15:04:16","modified_gmt":"2025-12-01T13:04:16","slug":"api-autentisering","status":"publish","type":"post","link":"https:\/\/hostup.se\/en\/support\/api-autentisering\/","title":{"rendered":"API \u2013 Authentication & Guidance"},"content":{"rendered":"\n

When authenticating against the public API<\/a>, you use an API key. You can create as many keys as you like, and we recommend creating one API key for each service you integrate with.<\/p>\n\n\n\n

Example command:<\/p>\n\n\n\n

curl -H \"Authorization: Bearer YOUR_API_KEY\" \\\n  https://cloud.hostup.se\/api\/hosting-accounts<\/code><\/pre>\n\n\n\n
\"\"<\/figure>\n\n\n\n
<\/span>Limited permissions<\/span><\/h2>\n\n\n\n
If you only want to grant an API key permission to perform certain tasks through the API\u2014such as managing DNS records\u2014you just need to assign the scopes required for that.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
<\/span>API documentation<\/span><\/h2>\n\n\n\n
You can find our API documentation at https:\/\/cloud.hostup.se\/api-management<\/a>. It is currently only available once you\u2019re logged in. The documentation is somewhat limited right now, but one very useful thing to know is that our customer portal uses the exact same API that you, as a developer, have access to.<\/p>\n\n\n\n
That means that if you open your browser\u2019s dev console, you can see how the API is being used and which endpoints are available.<\/p>\n\n\n\n
A good example of this is that, when I opened the window to configure permissions, an API call was made to https:\/\/cloud.hostup.se\/api\/keys\/scopes. There I can see exactly what the page retrieves from the backend to create the layout you\u2019re seeing on the screen.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
<\/span>Example: Stop a VPS<\/span><\/h2>\n\n\n\n
\"\"<\/figure>\n\n\n\n
With the browser console you can figure out absolutely everything. If you try stopping your VPS in the control panel, the browser\u2019s dev console shows you exactly what\u2019s going on. In this case a POST request is sent to https:\/\/cloud.hostup.se\/api\/vm\/16793\/status with the payload 
{action: “stop”, force: true}. Armed with this information, we can craft and test a curl request against the API directly from the terminal:<\/p>\n\n\n\n
curl -X POST 'https:\/\/cloud.hostup.se\/api\/vm\/16793\/status' \\\n  -H 'X-API-Key: YOUR_API_KEY' \\\n  -H 'Content-Type: application\/json' \\\n  -d '{\"action\": \"stop\", force: true}'<\/code><\/pre>\n\n\n\n
In response, I got back:<\/p>\n\n\n\n
{\n    \"success\": true,\n    \"timestamp\": \"2025-11-27T17:32:05.199Z\",\n    \"requestId\": \"9098d7b0-4cff-40c2-bc43-964500cbde6e\",\n    \"data\": {\n        \"success\": true,\n        \"action\": \"stop\",\n        \"jobId\": \"stop-16793-1764264725196\",\n        \"message\": \"stop operation queued\",\n        \"estimated_time\": 30\n    }\n}<\/code><\/pre>\n\n\n\n
This is exactly what makes things so much easier for our developers. Because our control panel uses the very same API you have access to, neither of us needs to reinvent the wheel. You also don\u2019t have to rely on poor or outdated API documentation, since you can always open the browser console to see precisely how the API works.<\/p>\n\n\n\n
<\/span>Example 2: Manage automatic SSL renewal via ACHME<\/span><\/h2>\n\n\n\n
We\u2019ve created a plugin for acme.sh: <\/p>\n\n\n\n
https:\/\/github.com\/hostup\/acme.sh\/blob\/9980ad0fef9634b105c59711dd5f470a4b35f080\/dnsapi\/dns_hostup.sh<\/a><\/p>\n\n\n\n
The code above gives you a few more examples of how to use our API.<\/p>\n\r\n\t\t\t
\r\n\r\n\t\t\t\t
\r\n\t\t\t\t\t
\r\n\t\t\t\t\t\t
Was this article helpful?<\/h3>\r\n\t\t\t\t\t<\/div>\r\n\t\t\t\t\t
\r\n\t\t\t\t\t\t
\r\n\t\t\t\t\t\t\t\r\n\t\t\t
\r\n\t\t\t\t\r\n                \r\n                    \r\n                        
\r\n\t\t\t\t\r\n                \r\n                    \r\n                        
\r\n\t\t\t\t\t
\r\n\t\t\t\t\t\t