Create deployment note

edit

Create note for the running deployment.

Request

edit

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

Path parameters

edit
Name Type Required Description

deployment_id

string

Y

Identifier for the deployment

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 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)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_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

Request example

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