Deleting a Template Version
Function
DeleteTemplateVersion
This API deletes a template version.
- template_id is the unique ID of the template. It is a UUID generated by RFS when a template is created. Template names are unique at one specific time, so you can create a template named HelloWorld and another template with the same name after deleting the first one. For parallel development, team members may want to ensure that they are operating the template they created, not one with the same name created by other members after deleting the previous one. To avoid this mismatch, check the ID, since RFS ensures each template has a unique ID that does not change with updates. If the template_id value differs from the current template ID, 400 is returned.
- If a template has only one version, the version cannot be deleted. To delete the only version, call DeleteTemplate. A template must have at least one version.
Exercise caution when you perform this operation.
URI
DELETE /v1/{project_id}/templates/{template_name}/versions/{version_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. It can be obtained by calling an API or from the console. Minimum: 3 Maximum: 64 |
template_name |
Yes |
String |
Name of the template to be created. Minimum: 1 Maximum: 128 |
version_id |
Yes |
String |
Template version ID. It starts with V (uppercase). The number of the ID is incremented by 1 each time a version is created. Minimum: 2 Maximum: 11 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
template_id |
No |
String |
ID of a template. If template_id exists, the template service checks whether template_id matches template_name. If not, 400 is returned. Minimum: 36 Maximum: 36 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Client-Request-Id |
Yes |
String |
Unique request ID. It is specified by a user and is used to locate a request. UUID is recommended. Minimum: 36 Maximum: 128 |
Response Parameters
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 429
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
- Delete a specified template version.
DELETE https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates/my_template/versions/V1
- Delete a specified template version and check whether the template ID matches the current template.
DELETE https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates/my_template/versions/V1?template_id=1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
204 |
Template version deleted. No data returned. |
400 |
Invalid request. |
401 |
Authentication failed. |
403 |
The user does not have the permission to call this API. |
404 |
The template or template version does not exist. |
429 |
Too frequent requests. |
500 |
Internal server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.