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.
Create deployment note
editCreate deployment note
editCreate note for the running deployment.
Request
editPOST /api/v1/deployments/{deployment_id}/notes
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the deployment |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
If specified then checks for conflicts against the version of the deployment note |
Responses
edit-
201
-
(
Notes
) List of deployment notes after the new deployment note has been added -
404
-
(
BasicFailedReply
) The deployment specified by {deployment_id} cannot be found. (code:deployments.deployment_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 example
editcurl -XPOST {{hostname}}/api/v1/deployments/{deployment_id}/notes \ -u $CLOUD_USER:$CLOUD_KEY \ -H 'Content-Type: application/json' \ -d ' { "id" : "string", "message" : "string", "timestamp" : "2019-01-01T00:00:00Z", "user_id" : "string" } '