Skip to content

Export manual

API Reference

  • Base URL: https://<your-tier0-host>/openapi/v2
  • Authentication: Send your Tier0 API key in the x-api-key request header.
  • For /uns/ requests, check both the HTTP status and the response body. A successful response has a 2xx status and code: 0. Read the result from data.
  • On failure, inspect error.code for the reason and keep requestId for troubleshooting.
  • For batch requests, check each item even when the HTTP status is 200. Some items may have failed.
  • Check error.execution to see whether the write was started, rolled back, committed, or has an unknown outcome.
  • If error.retry.safe is true, retry the same request with the same idempotency key. If one was supplied, wait at least as long as indicated by error.retry.afterMs or the Retry-After header.
  • If part of a batch was committed, check which items succeeded before submitting any remaining work. If the outcome is unknown and the response does not confirm a safe retry, verify whether the write took effect before sending it again.