overlane deploy env secret delete

Removes a secret from the vault and from the environment. On the platform’s own production environment the next release also takes it off the Worker, and a secret that is already gone counts as done. The service refuses secrets the release pipeline itself needs. Needs –force without a terminal.

Usage

overlane deploy env secret delete [env] [name] [--dry-run] [--force]

Arguments

Argument	Required	Description
`env`	no	The environment (required; checked after the –force confirmation)
`name`	no	The secret name, UPPER_SNAKE_CASE (required; checked after the –force confirmation)

Flags

Flag	Type	Required	Default	Description
`--dry-run`	boolean	no		Print the requests and file changes this command would make, then stop. Needs no credentials.
`--force`	boolean	no		Confirm a destructive action when there is no terminal to ask on. Without it, exit 2.

Examples

overlane deploy env secret delete staging API_KEY --force

Behavior

Effect: destructive (deletes or reverts; needs --force without a terminal).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: yes. Accepts --force: yes.
Machine-readable description: overlane schema deploy env secret delete.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "tenantId": {
          "type": "string"
        },
        "environment": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "deleted": {
          "type": "boolean",
          "const": true
        },
        "pending": {
          "type": "boolean"
        }
      },
      "required": [
        "tenantId",
        "environment",
        "name",
        "deleted",
        "pending"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "dryRun": {
          "type": "boolean",
          "const": true
        },
        "service": {
          "type": "string"
        },
        "requests": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string"
              },
              "path": {
                "type": "string"
              },
              "body": {},
              "note": {
                "type": "string"
              }
            },
            "required": [
              "method",
              "path"
            ],
            "additionalProperties": false
          }
        },
        "commands": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "writes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "action": {
                "type": "string",
                "enum": [
                  "write",
                  "append",
                  "delete"
                ]
              },
              "description": {
                "type": "string"
              }
            },
            "required": [
              "path",
              "action",
              "description"
            ],
            "additionalProperties": false
          }
        },
        "notes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "dryRun",
        "requests",
        "commands",
        "writes",
        "notes"
      ],
      "additionalProperties": false
    }
  ]
}

See exit codes for the status the process returns.