Skip to content
PUT/api/v1/prompts/deployments

Deployment action (rollback / canary lifecycle)

Action-discriminated: rollback reverts an env to the prior version; start/update/complete/abort-canary manage a percentage-based canary rollout.

Authentication

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

Request body required

Schema
{
  "application/json": {
    "schema": {
      "oneOf": [
        {
          "type": "object",
          "required": [
            "action",
            "name",
            "env"
          ],
          "properties": {
            "action": {
              "type": "string",
              "enum": [
                "rollback"
              ]
            },
            "name": {
              "type": "string"
            },
            "env": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "action",
            "name",
            "version",
            "env",
            "percentage"
          ],
          "properties": {
            "action": {
              "type": "string",
              "enum": [
                "start-canary"
              ]
            },
            "name": {
              "type": "string"
            },
            "version": {
              "type": "integer"
            },
            "env": {
              "type": "string"
            },
            "percentage": {
              "type": "number",
              "minimum": 1,
              "maximum": 99
            }
          }
        },
        {
          "type": "object",
          "required": [
            "action",
            "deploymentId",
            "percentage"
          ],
          "properties": {
            "action": {
              "type": "string",
              "enum": [
                "update-canary"
              ]
            },
            "deploymentId": {
              "type": "string"
            },
            "percentage": {
              "type": "number",
              "minimum": 1,
              "maximum": 99
            }
          }
        },
        {
          "type": "object",
          "required": [
            "action",
            "deploymentId"
          ],
          "properties": {
            "action": {
              "type": "string",
              "enum": [
                "complete-canary",
                "abort-canary"
              ]
            },
            "deploymentId": {
              "type": "string"
            }
          }
        }
      ],
      "discriminator": {
        "propertyName": "action"
      }
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Action applied (rollback / update-canary / complete-canary / abort-canary).
201Canary started (start-canary).
400(no description)
401(no description)
403Forbidden — ORG_CONTEXT_REQUIRED.
429(no description)
500Internal Server Error — an unhandled error was converted to the standard error envelope (INTERNAL_ERROR).

Code samples

cURL

curl -X PUT \
  https://evalguard.ai/api/v1/prompts/deployments \
  -H "Authorization: Bearer $EVALGUARD_API_KEY"

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/prompts/deployments", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}` },
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}

response = requests.request("PUT", "https://evalguard.ai/api/v1/prompts/deployments", headers=headers)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequestWithContext(context.Background(), "PUT", "https://evalguard.ai/api/v1/prompts/deployments", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403429500

Other Prompts endpoints