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.
Update deployment noteedit
Update note for the running deployment.
Requestedit
PUT /api/v1/deployments/{deployment_id}/notes/{note_id}
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the deployment |
|
|
Y |
Identifier of the note to be updated |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
If specified then checks for conflicts against the version of the deployment note |
Responsesedit
-
200
-
(
Note
) Updated deployment noteHeaders
-
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
) -
449
-
(
BasicFailedReply
) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required
)
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
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" } '