RegistryUI Documentation
/udr/v1api/garbagecollection
| Endpoint | Method | Description |
|---|---|---|
| /udr/v1api/garbagecollection | POST | Performs garbage collection. |
The registry is set offline in order to perform garbage collection. While garbage collection runs, images cannot be pushed/pulled and users are notified that the registry is offline when attempting to push/pull images.
Authentication
Basic Authorization header required. The specified user must have administrator privileges.
Query String Arguments
| Argument | Type | Description |
|---|---|---|
| (none) |
Response
A JSON object is returned. If an error occurs, the "error" field will contain a descriptive error message (see Standard API Response).
| Field | Type | Description |
|---|---|---|
| data | Boolean | Contains true indicating that garbage collection has completed. |
Example
curl -u username:usertoken -d "" https://registry.yoursite.com/udr/v1api/garbagecollection
Response:
{"error":null,"data":true}