API Access
The API page is where you manage your API credentials and access controls. Navigate to Account → API to configure API access.
Personal Access Token
Your API token is displayed on this page. Use it in the Authorization header for all API calls.
⚠️ Regenerating your token will immediately invalidate the current token. This also breaks your active portal session, since the portal is itself an API client. You will need to log in again with the new token.
IP ACL (Required)
The NetActuate API requires an IP-based access control list. API calls are rejected unless the source IP is on your allowlist. To authorize access:
- Click + Add to add an authorized IP address range.
- Enter the IP or CIDR range and a description.
- Click Submit.
Without at least one authorized IP range, API calls will return an error.
VM OAuth (API Access from VMs)
If Allow VMs to authenticate is enabled in Security settings, VMs can call the API using their own context without embedding an API key. The API key and VM context are passed automatically via the metadata endpoint.
Use cases:
- Bootstrap scripts that need VM details at startup (e.g., NixOS configurations, cloud-init scripts)
- Auto-configuration workflows where VMs self-configure based on their own metadata
- Self-registration automation where VMs register themselves with external systems using their NetActuate identity
API Explorer
The portal includes a built-in API explorer for browsing available API calls. Use it to look up:
- Plan IDs and compute plan specifications
- Cloud Pools and available cloud pool resources
- Datacenter / POP IDs for location-based deployments
- OS Image IDs for available operating system images
- Usage Contracts and active billing contracts
This is helpful when building API automation, Terraform configurations, or Ansible playbooks.
API Versions
| Version | Status | Documentation |
|---|---|---|
| v3 | Current | API v3 Reference |
| v2 | Active | API v2 Reference |
Both API versions are actively maintained. Use v3 for new integrations where possible.
SDKs and Tools
NetActuate provides SDKs and example scripts on GitHub for Python, Go, and JavaScript. For full API and SDK documentation, see the Automation section.
Quick Start
# List your virtual machines
curl -X GET "https://api.netactuate.com/api/v3/servers" \
-H "Authorization: Bearer YOUR_API_TOKEN"
Need Help?
Contact support@netactuate.com or open a support ticket from the portal.