IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. 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 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
-
-
"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
-
"The deployment specified by {deployment_id} cannot be found. (code:
-
449
-
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 exampleedit
curl -XPUT https://{{hostname}}/api/v1/deployments/{deployment_id}/notes/{note_id} \ -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" } '