It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Get a deployment note Deployments - Templates »

› › › ›

Update deployment note

edit

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`	`string`	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) Updated deployment note

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

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

Request example

edit

curl -XPUT https://{{hostname}}/api/v1/deployments/{deployment_id}/notes/{note_id} \
-H "Authorization: ApiKey $ECE_API_KEY" \
-d '
{
   "id" : "string",
   "message" : "string",
   "timestamp" : "2019-01-01T00:00:00Z",
   "user_id" : "string"
}
'

« Get a deployment note Deployments - Templates »