git.ssh-keys.delete

Remove a registered SSH key

DELETE /git/api/ssh-keys/{id}IAM git:DeleteSshKeyChanges stateDestructive

Request syntax

DELETE /git/api/ssh-keys/{id}

Path parameters

  • idRequired

    string

    Constraints: uuid

Response

200 without `data`, also when no key of yours has that id.

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

Fields of data

    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 git:DeleteSshKey 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 git ssh-keys delete id

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