Delete deployment note

edit

This endpoint is deprecated and scheduled to be removed in the next major version. Use Delete Comment instead.

Delete note for the running deployment.

Request

edit

DELETE /api/v1/deployments/{deployment_id}/notes/{note_id}

Path parameters

edit
Name Type Required Description

deployment_id

string

Y

Identifier for the deployment

note_id

string

Y

Identifier of the note to be deleted

Query parameters

edit
Name Type Required Description

version

string

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

(BasicFailedReply)

  • "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
449

(BasicFailedReply)

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

edit
curl -XDELETE https://{{hostname}}/api/v1/deployments/{deployment_id}/notes/{note_id} \
-H "Authorization: ApiKey $ECE_API_KEY"