Docs
Elastic Cloud Enterprise Reference [2.2] » RESTful API » API reference » Deployments - Notes
«  Deployments - IP Filtering - CRUD     Platform  »

Deployments - Notes

Get deployment notes

Get deployment notes.

Request

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

Path parameters

Name Type Required Description

deployment_id

string

Y

Identifier for the deployment

Responses

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/deployments/{deployment_id}/notes \
-u $CLOUD_USER:$CLOUD_KEY

Create deployment note

Create note for the running deployment.

Request

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

Path parameters

Name Type Required Description

deployment_id

string

Y

Identifier for the deployment

Query parameters

Name Type Required Description

version

integer

N

If specified then checks for conflicts against the version of the deployment note

Request body

(Note) (required) New deployment note

Responses

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -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"
}
'

Delete deployment note

Delete note for the running deployment.

Request

DELETE /api/v1/deployments/{deployment_id}/notes/{note_id}

Path parameters

Name Type Required Description

deployment_id

string

Y

Identifier for the deployment

note_id

string

Y

Identifier of the note to be deleted

Query parameters

Name Type Required Description

version

integer

N

If specified then checks for conflicts against the version of the deployment note

Responses

200

(Notes) List of deployment notes after {note_id} has been deleted

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) * The note specified by {note_id} cannot be found. (code: notes.note_not_found)
449
(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XDELETE {{hostname}}/api/v1/deployments/{deployment_id}/notes/{note_id} \
-u $CLOUD_USER:$CLOUD_KEY

Get a deployment note

Gets a deployment note.

Request

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

Path parameters

Name Type Required Description

deployment_id

string

Y

Identifier for the deployment

note_id

string

Y

Identifier of the note to be fetched

Responses

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
(BasicFailedReply) * "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)
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/deployments/{deployment_id}/notes/{note_id} \
-u $CLOUD_USER:$CLOUD_KEY

Update deployment note

Update note for the running deployment.

Request

PUT /api/v1/deployments/{deployment_id}/notes/{note_id}

Path parameters

Name Type Required Description

deployment_id

string

Y

Identifier for the deployment

note_id

string

Y

Identifier of the note to be updated

Query parameters

Name Type Required Description

version

integer

N

If specified then checks for conflicts against the version of the deployment note

Request body

(Note) (required) New content for deployment note

Responses

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
(BasicFailedReply) * "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)
449
(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPUT {{hostname}}/api/v1/deployments/{deployment_id}/notes/{note_id} \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "id" : "string",
   "message" : "string",
   "timestamp" : "2019-01-01T00:00:00Z",
   "user_id" : "string"
}
'
«  Deployments - IP Filtering - CRUD     Platform  »