Skip to main content

F2HCloud API

F2HCloud API

F2H API access is currently experimental and should not be used with production systems.

By using scoped API keys, you can allow specific API functions to be performed without needing to be logged into The NOC. Scoped keys provide fine‑grained control over what actions an external system, script, or integration is allowed to perform.

You can generate an API key and assign it to a specific server. Once created, you can choose exactly which permissions that key is allowed to use—such as managing IPs, updating PTR records, performing server actions, or accessing monitoring data. This ensures that each key only has the minimum level of access required for its intended task, improving both security and automation flexibility.

NoCAPI.png

Reboot Using The API

An example API call using cURL to reboot your server is shown below. The API key used must include the reboot permission within its assigned scope.

Swagger API

Swagger access is currently experimental and should not be used with production systems.

Swagger provides a GUI (Graphical User Interface) to allow users to quickly perform API tasks from a browser. Using scoped API keys on one of the supported API servers will allow you to control your server from any browser.

SwaggerAPI.png