Getting started
Making requests
All endpoints live under https://openapi.avi-go.com/open/v1 and return JSON. There is no separate "ping" endpoint — to confirm your key and connectivity, make a real call to Empty Legs.
Request headers
| Header | Required | Description |
|---|---|---|
| X-API-Key | Yes | Your secret API key. |
| X-Trace-Id | Response | Returned on every response. Quote it when reporting an issue. |
Response envelope
Every response — success or failure — uses the same envelope. On success code is "OK" and data holds the payload; on failure code is a string error code and the data field is omitted.
Forward compatibility. Treat the response as open: tolerate new, unknown fields. We add fields without bumping the version, so a parser that rejects unknown keys will break. This is the first rule of the integration contract.
Response envelope200 · OK
{
"code": "OK",
"message": "success",
"data": { … },
"traceId": "0c8f1e2a-7b34-4e9d-9a1f-2b6c5d4e3a10"
}