Skip to content

overlane release withdraw

Withdraw a release so it can no longer be pinned or promoted

Updated View as MarkdownOpen in ChatGPTOpen in Claude

Marks the release withdrawn. Projects pinned to it keep their pin until they update; nothing new can pin or promote it. Needs a role that manages policy. Without a terminal it needs –force.

Usage

overlane release withdraw [digest] [--service URL] [--team TENANT_ID] [--dry-run] [--force]

Arguments

Argument Required Description
digest no The release digest from overlane release list (required)

Flags

Flag Type Required Default Description
--service string no The service address (default: OVERLANE_SERVICE_URL, then the project’s binding, then the hosted service)
--team string no The team (tenant) to act on (default: the one your token belongs to)
--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 release withdraw sha256:ab12... --force
overlane release withdraw sha256:ab12... --dry-run

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 release withdraw.

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"
        },
        "channel": {
          "type": "string"
        },
        "publishedAt": {
          "type": "string"
        },
        "soakUntil": {
          "type": "string"
        },
        "promotedAt": {
          "type": "string"
        },
        "manifest": {
          "type": "object",
          "properties": {
            "version": {
              "type": "string"
            },
            "digest": {
              "type": "string"
            }
          },
          "required": [
            "version",
            "digest"
          ],
          "additionalProperties": {}
        }
      },
      "required": [
        "tenantId",
        "channel",
        "publishedAt",
        "soakUntil",
        "manifest"
      ],
      "additionalProperties": {}
    },
    {
      "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.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close

Overlane Agent

Ask about the docs. Answers are quoted from the pages, with links. This panel cannot change anything.

    Questions are answered in your browser from the docs index. Nothing you type here is stored or sent anywhere.