GET/api/v1/gateway/canary

List active canary deployments

Returns active canary deployments — each canary routes a percentage of traffic to a candidate model/policy while the rest goes to the stable. Includes per-canary metrics (latency, error rate, cost delta).

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/api-keys.

Parameters

projectId in queryrequired
string

Response

200 example

{
  "success": true
}

All status codes

200Active canaries with per-canary status.
400Invalid params.
403Cross-tenant denial.

Code samples

cURL

curl -X GET \
  https://evalguard.ai/api/v1/gateway/canary \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "GET",
  path: "/api/v1/gateway/canary",
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(method="GET", path="/api/v1/gateway/canary")
print(response)

Go

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/evalguard/evalguard-go"
)

func main() {
	client := evalguard.NewClient(os.Getenv("EVALGUARD_API_KEY"))
	resp, err := client.Request(context.Background(), "GET", "/api/v1/gateway/canary", nil)
	if err != nil { panic(err) }
	fmt.Println(resp)
}

Errors

400403

Other Gateway endpoints