List routing configs

GET/v1/configs

List routing configs.

Lists an organization's configs, or one workspace's, a page at a time, as summaries (without their targets). Get a config for its full target tree.

Requires a workspace key (member or admin) for workspace_id when it is given, or an organization admin key; an organization-wide list (no workspace_id) requires an organization admin key. 403 otherwise.

Authorization

AuthorizationBearer va_
A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Query parameters

organizationstringrequired
the organization slug
workspace_idstring<uuid>
only configs in this workspace (UUID); omit for every config in the organization
searchstring
only configs whose name contains this text
pageinteger<int32>
the page number, starting at 1 (default 1)
page_sizeinteger<int32>
configs per page (default 20, at most 100)

Responses

200application/json

dataobject[]
The configs on this page.
Child attributes
- idstring<uuid>
  The config's id (UUID).
- slugstring
  The config's slug, for the x-config header.
- namestring
  The config's name.
- descriptionstring
  A free-text description. Absent when none was set.
- organizationstring
  The slug of the organization the config belongs to.
- workspace_idstring<uuid>
  The workspace the config belongs to (UUID).
- strategy_modeenum<string>
  The top-level strategy: SINGLE, LOADBALANCE, FALLBACK or CONDITIONAL.
  One of "SINGLE", "LOADBALANCE", "FALLBACK", "CONDITIONAL"
- target_countinteger<int32>
  How many targets the config has, nested targets included.
- created_atstring<date-time>
  When the config was created (ISO 8601 date-time).
- updated_atstring<date-time>
  When the config last changed (ISO 8601 date-time).
pageinteger<int32>
This page's number, starting at 1.
page_sizeinteger<int32>
The page size used (at most 100).
totalinteger<int64>
How many configs match, across every page.

VectorAxis is built by GK Labs, a member of NVIDIA Inception.