HEhexlet
Image

Remove an image

Changed on

Remove an image, along with any untagged parent images that were referenced by that image.

Images can't be removed if they have descendant images, are being used by a running container or are being used by a build.

delete/images/{name}

Request

  • Base URL
    /v1.57 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    none declared

Path parameters

namestring required

Image name or ID

Query parameters

forceboolean

Remove the image even if it is being used by stopped containers or has other tags

nopruneboolean

Do not delete untagged parent images

platformsstring[]

Select platform-specific content to delete. Repeat the parameter to select multiple platforms. Each platform is a OCI platform encoded as a JSON string.

Response

The image was deleted successfully

Untaggedstring

The image ID of an image that was untagged

Deletedstring

The image ID of an image that was deleted

Changes

  • 6df97b60796cRevision changes
    • breaking

      removed the media type application/json for the response with the status

    • info

      api tag Image added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 31f80d10d31aRevision changes
    • breaking

      for the query request parameter force, default value false was removed

    • breaking

      for the query request parameter noprune, default value false was removed

    • info

      api tag Image removed

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status