deploy.kill-switches.list

List an app's kill switches, active and released

GET /deploy/api/apps/{id}/kill-switchesIAM deploy:ListKillSwitchesRead

Request syntax

GET /deploy/api/apps/{id}/kill-switches

Path parameters

  • idRequired

    string

    Constraints: uuid

Response

200 with `data`: the app’s 50 newest switches, active and released.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • [].​idAlways

    string

    The switch id, which releases it
  • [].​appIdAlways

    string

    The app it is pulled on
  • [].​appNameWhen present

    string

    The app’s name (list-active only)
  • [].​kindAlways

    one of route_offline, private_only, scale_to_zero

    What the switch does
  • [].​labelAlways

    string

    The kind, for people: "Route offline"
  • [].​targetAlways

    string, may be null

    route_offline: the hostname or path prefix; null for the other kinds
  • [].​reasonAlways

    string

    Why it was pulled, as given
  • [].​findingIdAlways

    string, may be null

    The Security Posture finding it was pulled from
  • [].​activeAlways

    boolean

    true until released
  • [].​appliedByAlways

    string

    Who pulled it
  • [].​appliedAtAlways

    string

    When it was pulled
  • [].​releasedByAlways

    string, may be null

    Who released it; null while active
  • [].​releasedAtAlways

    string, may be null

    When it was released; null while active

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow deploy:ListKillSwitches on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud deploy kill-switches list id

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_deploy_kill-switches_list.