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.

« Deployments - Notes Create deployment note »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.11] ›RESTful API ›API reference ›Deployments - Notes

Get deployment notes

edit

Get deployment notes

edit

Get deployment notes.

Request

edit

GET /api/v1/deployments/{deployment_id}/notes

Path parameters

edit
Name Type Required Description

deployment_id

string

Y

Identifier for the deployment

Responses

edit
200

(Notes) The deployment notes were successfully returned

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)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found])
The error codes associated with the response

Request example

edit
curl -XGET https://{{hostname}}/api/v1/deployments/{deployment_id}/notes \
-H "Authorization: ApiKey $ECE_API_KEY"
« Deployments - Notes Create deployment note »