Shipeasy
Flags experimentsApiOperations

Get one killswitch

Returns the killswitch metadata plus the latest published value/switches/version per env.

Returns the killswitch metadata plus the latest published value/switches/version per env.

Use case

Fetch the current state of one killswitch — e.g. to verify a trip propagated before declaring an incident mitigated.

GET
/api/admin/killswitches/{id}

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Path Parameters

id*string

Stable opaque killswitch id (ksw_…) or the killswitch's name.

Length1 <= length <= 128

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://shipeasy.ai/api/admin/killswitches/string"
{
  "id": "ksw_01j7w9d8h2k4m6n8p0q2r4s6t8",
  "name": "payments.checkout",
  "description": "Master kill for the checkout flow. Trip to fall back to the legacy provider.",
  "folder": "payments",
  "creatorEmail": "ana@example.com",
  "createdAt": "2026-05-01T10:12:00.000Z",
  "updatedAt": "2026-05-09T18:22:11.000Z",
  "envs": {
    "dev": {
      "value": false,
      "version": 3,
      "publishedAt": "2026-05-09T18:22:11.000Z"
    },
    "stage": {
      "value": false,
      "version": 3,
      "publishedAt": "2026-05-09T18:22:11.000Z"
    },
    "prod": {
      "value": false,
      "switches": {
        "eu_region": true
      },
      "version": 5,
      "publishedAt": "2026-05-09T18:22:11.000Z"
    }
  }
}
{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

{
  "error": "The resource does not exist or is not visible to the caller.",
  "code": "NOT_FOUND"
}

{
  "error": "A resource with this name already exists in the project.",
  "code": "ALREADY_EXISTS"
}

{
  "error": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

Was this page helpful?
✎ Edit this page