Deleting an Image Retention Policy
Description
Delete an image retention policy.
Constraints
None
API Calling
For details, see Calling APIs.
Authorization Information
Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.
- If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.
URI
DELETE /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
namespace |
Yes |
String |
Organization name. Enter 1 to 64 characters, starting with a lowercase letter and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed. |
|
repository |
Yes |
String |
Image repository name. Enter 1 to 128 characters. It must start and end with a lowercase letter or digit. Only lowercase letters, digits, periods (.), slashes (/), underscores (_), and hyphens (-) are allowed. Periods, slashes, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed. Replace a slash (/) with a dollar sign ($) before you send the request. |
|
retention_id |
Yes |
Integer |
Image retention policy ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
Content-Type |
No |
String |
Message body type (format). The value can be application/json or charset=utf-8 application/json. Default value: application/json |
|
X-Auth-Token |
Yes |
String |
User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
None
Example Request
DELETE https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id}
Example Response
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Deletion succeeded. |
|
400 |
Request error. |
|
401 |
Authentication failed. |
|
404 |
The organization, image repository, or policy was not found. |
|
500 |
Internal error. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.