API revamp

Jump to bottom

T. Andrew Manning edited this page Jun 16, 2026 · 6 revisions

API revamp

Issues are associated with avi-revamp milestone.

Problem

Goal

Original API

New API

Datasets

GET /api/dataset/[transient_name]

Output tabular data only. Default to JSON format but support YAML.

Query params:

format (string): "json" (default) or "yaml" revision (integer): which dataset revision to return

GET /api/dataset/[transient_name]/all

Output entire dataset as compressed archive file.

Query params:

format (string): ".tar.gz" (default) or ".zip"