List defs

Returns every flag definition in the caller's (org, project) store, by key, with its version and who last changed it.

GET /v1/flag/defs

Flag → · All API references → · Get started →


Address	`https://api.hanzo.ai/v1/flag/defs`
Method	`GET`
Operation	`get_flag_defs`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns every flag definition in the caller's (org, project) store, by key, with its version and who last changed it.

Request

GET /v1/flag/defs takes no parameters and no body — the credential is the whole request.

Response

Status	Body	Meaning
`200`	flag.defsOut	ok
`default`	problem-details	refused

200 body — 6 fields.

Field	In	Type	Always	Description
`data`	body	flag.DefRow[]	—	Data is every definition in the caller's (org, project) store, by key.
`data[].definition`	body	any	—	Definition is the flag-definition document the evaluator consumes, kept BYTE-FOR-BYTE as it was written.
`data[].key`	body	string	—	Key is the flag's primary key in the caller's (org, project) store, and the name evaluation looks it up by.
`data[].updated_at`	body	string	—	UpdatedAt is when the definition was last written, RFC 3339 UTC.
`data[].updated_by`	body	string	—	UpdatedBy is the email of the principal who last wrote it.
`data[].version`	body	integer (int64)	—	Version is 1 when the key was created and rises by one on every overwrite.

Failure carries the platform error shape — see Errors.

Examples

hanzo flag defs list

import { Configuration, FlagApi } from 'hanzoai';

const api = new FlagApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getFlagDefs();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import FlagApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = FlagApi(client).get_flag_defs()

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.FlagAPI.GetFlagDefs(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, flag_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = flag_api::get_flag_defs(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.FlagApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new FlagApi(client).getFlagDefs();

The method above is the one at the current release of the document. [email protected] (npm) was generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl https://api.hanzo.ai/v1/flag/defs \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches flag through the flags tool, which names its 8 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "get_flag_activity"
         }
       }
     }'

Flag API · All Hanzo APIs · Interactive reference

Request

Response

Examples

On this page