POST /v2/registry/{registry_name}/garbage-collection
Garbage collection enables users to clear out unreferenced blobs (layer & manifest data) after deleting one or more manifests from a repository. If there are no unreferenced blobs resulting from the deletion of one or more manifests, garbage collection is effectively a noop. See here for more information about how and why you should clean up your container registry periodically.
To request a garbage collection run on your registry, send a POST request to
/v2/registry/$REGISTRY_NAME/garbage-collection. This will initiate the
following sequence of events on your registry.
- Set the registry to read-only mode, meaning no further write-scoped JWTs will be issued to registry clients. Existing write-scoped JWTs will continue to work until they expire which can take up to 15 minutes.
- Wait until all existing write-scoped JWTs have expired.
- Scan all registry manifests to determine which blobs are unreferenced.
- Delete all unreferenced blobs from the registry.
- Record the number of blobs deleted and bytes freed, mark the garbage
collection status as
success. - Remove the read-only mode restriction from the registry, meaning write-scoped JWTs will once again be issued to registry clients.
Servers
- https://api.digitalocean.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
registry_name |
String | Yes |
The name of a container registry. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
type |
String | No |
Type of the garbage collection to run against this registry Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.