A newer version is available. For the latest information, see the
current release documentation.
Delete deployment note
editDelete deployment note
editDelete note for the running deployment.
Request
editDELETE /api/v1/deployments/{deployment_id}/notes/{note_id}
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the deployment |
|
|
Y |
Identifier of the note to be deleted |
Query parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
If specified then checks for conflicts against the version of the deployment note |
Responses
edit-
200 -
(
Notes)List of deployment notes after {note_id} has been deleted
Headers
-
x-cloud-resource-created(string) - The date-time when the resource was created (ISO format relative to UTC)
-
x-cloud-resource-last-modified(string) - The date-time when the resource was last modified (ISO format relative to UTC)
-
x-cloud-resource-version(string) - The resource version, which is used to avoid update conflicts with concurrent operations
-
-
404 -
-
"The deployment specified by {deployment_id} cannot be found. (code:
deployments.deployment_not_found) -
The note specified by {note_id} cannot be found. (code:
notes.note_not_found)
Headers
-
x-cloud-error-codes(string; allowed values: [deployments.deployment_not_found,notes.note_not_found]) - The error codes associated with the response
-
"The deployment specified by {deployment_id} cannot be found. (code:
-
449 -
Elevated permissions are required. (code:
root.unauthorized.rbac.elevated_permissions_required)Headers
-
x-cloud-error-codes(string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]) - The error codes associated with the response
-
Request example
editcurl -XDELETE https://{{hostname}}/api/v1/deployments/{deployment_id}/notes/{note_id} \
-H "Authorization: ApiKey $ECE_API_KEY"