Update deployment note

edit

Update note for the running deployment.

Request

edit

PUT /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 updated

Query parameters

edit
Name Type Required Description

version

integer

N

If specified then checks for conflicts against the version of the deployment note

Request body

edit

(Note) (required) New content for deployment note

Responses

edit
200

(Note) List of deployment notes after the new deployment note has been added

Headers

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} or note specified by {note_id} cannot be found (code: 'notes.note_not_found')

449

(BasicFailedReply) elevated permissions are required. (code: '"root.needs_elevated_permissions"')

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
curl -XPUT {{hostname}}/api/v1/deployments/{deployment_id}/notes/{note_id} \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "id" : "string",
   "message" : "string",
   "timestamp" : "2019-01-01T00:00:00Z",
   "user_id" : "string",
   "version" : 0
}
'