A newer version is available. For the latest information, see the
current release documentation.
Get a deployment note
editGet a deployment note
editThis endpoint is deprecated and scheduled to be removed in the next major version. Use Get Comment instead.
Gets a deployment note.
Request
editGET /api/v1/deployments/{deployment_id}/notes/{note_id}
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the deployment |
|
|
Y |
Identifier of the note to be fetched |
Responses
edit-
200 -
(
Note)The deployment note was 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 -
-
"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:
Request example
editcurl -XGET https://{{hostname}}/api/v1/deployments/{deployment_id}/notes/{note_id} \
-H "Authorization: ApiKey $ECE_API_KEY"