API reference

Every endpoint a token can use, generated from the API itself and grouped like the app's sidebar. Each one shows the scope it needs, whether a token may call it when it changes something, its parameters, the call in cURL, PowerShell, PHP, Python, JavaScript and Go, the recorded answer, and an example of each error it can answer.

Downloads

• openapi.json — the same description as OpenAPI 3, for generating clients or loading into an API gateway. Also versioned on GitHub in infranest-openapi.
• Postman collection and environment — every endpoint, one folder per page below.
• Bruno collection — the same, as a folder of .bru files with its environment.

How to import each, and Insomnia: Use with Postman, Bruno or Insomnia.

Pages

Section	Page	What is in it
Domains	Domains	Domains and contacts as InfraNest knows them. Registrar actions (register, renew, transfer) stay in the app.
Domains	DNS	Zones and records at your DNS providers, templates and dynamic IP sources. Record changes are recorded in the zone history and can be undone.
Domains	Certificates	TLS certificates InfraNest tracks or issues, and when they expire.
Infrastructure	Servers and cloud	Servers, volumes, networks, firewalls and load balancers. Provider actions stay in the app; tokens edit InfraNest's own records and alerting.
Monitoring	Monitoring	Monitors, their results and uptime, and deploy markers.
Monitoring	Incidents	Incidents: open, update and resolve them.
Monitoring	Maintenance	Planned maintenance windows, which pause alerts and show on status pages.
Monitoring	Status pages	Public status pages and what they show.
Monitoring	Alerts and notifications	Alert channels, alert rules and notification settings. Read only: changing who gets alerted stays in the app.
Automations	Automations	Automations and the connections they use. Read only.
Automations	Integrations	Connected providers and messaging apps. Read only: credentials are managed in the app.
Drop catch	Drop catch	Watched domains.
Organization	Organization and members	The organizations a token can reach, their members, roles, single sign-on and dashboards. Read only.
Organization	Tags and custom fields	Tags and custom fields, which work across every module.
Organization	Costs	Cost items, cost changes and provider price changes.
Organization	Billing	Subscription, invoices and usage. Read only.
Organization	Audit log	Every change in the organization, including those made with tokens. Read only.
Organization	Data export	Export your data as CSV or JSON.
Account	Account	Who the token belongs to, and revoking it.

Errors use one shared format, described in Errors.