v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB

DigitalOcean-public.v2-new_Container Registries

[Public Preview] Update Garbage Collection

To cancel the currently-active garbage collection for a registry, send a PUT request to /v2/registries/$REGISTRY_NAME/garbage-collection/$GC_UUID and specify one or more of the attributes below. It is similar to PUT /v2/registries/$REGISTRY_NAME/garbage-collection/$GC_UUID and exists for backward compatibility.

put/v2/registries/{registry_name}/garbage-collection/{garbage_collection_uuid}

Path parameters

registry_namestring required

The name of a container registry.

garbage_collection_uuidstring required

The UUID of a garbage collection run.

Request body

cancelboolean

A boolean value indicating that the garbage collection should be cancelled.

Example request

{
  "cancel": true
}

Response

The response will be a JSON object with a key of garbage_collection. This will be a json object with attributes representing the currently-active garbage collection.

Example response

{
  "garbage_collection": {
    "uuid": "eff0feee-49c7-4e8f-ba5c-a320c109c8a8",
    "registry_name": "example",
    "status": "requested",
    "created_at": "2020-10-30T21:03:24Z",
    "updated_at": "2020-10-30T21:03:44Z",
    "blobs_deleted": 42,
    "freed_bytes": 667
  }
}