Balancer API reference
Use the Balancer API to manage your account configuration and query observations. Your API base URL is https://<your-api-host>. The host is shown in the Balancer portal.
Note: Balancer is in beta. Endpoints, fields and behavior may change before general availability, and the feature must be enabled on your account before use. Contact your NetActuate account manager to request access.
Before you start
Use the host shown for your account. The examples use BALANCER_API_BASE for that base URL and BALANCER_API_KEY for an account API key.
export BALANCER_API_BASE='https://<your-api-host>'
The API exposes resource version values for conditional updates. These values describe resource changes, not an API release version. The available facts do not establish a versioned URL scheme or a compatibility window.
TODO(verify): Confirm the API release versioning and deprecation policy.
Choose a task
- Run five API calls.
- Choose credentials and sign in.
- Handle errors and retries.
- Page and sort lists.
- Protect updates with version checks.
- Check whether a change is active.
API areas
| Area | What it is for | Task guide | Operations |
|---|---|---|---|
| HTTP Load Balancers | An HTTP load balancer contains the groups that handle your web traffic. | Route traffic with groups and routes | 8 |
| Groups and Routes | Groups contain domains and routes; routes select how matching HTTP requests are handled. | Route traffic with groups and routes | 57 |
| Upstream Groups | An upstream group contains origin targets and their health check settings. | Configure origins and health checks | 13 |
| L4 Load Balancers | L4 load balancers represent TCP and UDP services. These operations currently return an empty list or reject access. | Set up L4 load balancing | 20 |
| WAF Firewalls | A WAF firewall combines ordered ruleset bindings for HTTP request inspection. | Protect a site with a WAF firewall and rulesets | 15 |
| WAF Rulesets | A WAF ruleset contains ordered rules. You can read shared rulesets and manage private rulesets. | Protect a site with a WAF firewall and rulesets | 10 |
| WAF Allow Policies | A WAF allow policy contains rules that bypass later WAF evaluation when they match. | Allow trusted traffic with WAF allow policies | 10 |
| Rate Limit Policies | A rate limit policy contains ordered rules that apply request budgets. | Rate limit requests | 11 |
| Block Policies | A block policy contains rules that reject matching source traffic. | Block and allow traffic by country, IP and list | 10 |
| Allow Policies | An allow policy contains rules that allow matching source traffic past source blocking and request budgets. | Block and allow traffic by country, IP and list | 10 |
| Custom Lists | A custom list contains reusable account-wide values for policy rules. | Block and allow traffic by country, IP and list | 9 |
| Cache Policies | A cache policy contains ordered request and response rules for cache behavior. | Set up caching and purge content | 15 |
| Image Manipulation Policies | An image manipulation policy contains named image variants. | Resize and transform images | 10 |
| SSL Certificates | An SSL certificate provides TLS certificate material. You can upload a certificate or request ACME issuance. | Add a TLS certificate | 8 |
| mTLS Certificates | An mTLS certificate provides a client certificate for connections to an origin. | Require client certificates | 4 |
| DNS Zones | A DNS zone contains authoritative DNS records. | Host DNS zones and records | 10 |
| Error Page Assets | An error page asset contains reusable content for custom error responses. | Serve custom error pages | 5 |
| Logs | Log operations manage an account export destination and list available export locations. | Export and read logs | 5 |
| Authentication | Authentication operations sign you in and select an account or organization context. | Manage users, API keys and access control | 12 |
| User | User operations manage your profile, verification challenges, credentials and sessions. | Manage users, API keys and access control | 20 |
| Accounts | An account contains resources and account memberships. | Manage users, API keys and access control | 30 |
| Access Control | Access control operations manage resource permissions, API access and capability grants. | Manage users, API keys and access control | 18 |
| Organizations | An organization groups accounts and has its own memberships. | Manage users, API keys and access control | 30 |
| Edges | Edge targets identify locations available to your account. | Configure origins and health checks | 1 |
Need Help?
Contact support through the Balancer portal.