Docs
Elastic Cloud Enterprise Reference [2.3] » RESTful API » API reference » Deployments - Extensions
«  Comments     Deployments - IP Filtering - CRUD  »

Deployments - Extensions

List Extensions

Retrieves all of the available extensions.

Request

GET /api/v1/deployments/extensions

Responses

200
(Extensions) The Extensions that are available
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/extensions \
-u $CLOUD_USER:$CLOUD_KEY

Create an extension

Creates an extension.

Request

POST /api/v1/deployments/extensions

Request body

(CreateExtensionRequest) (required) the data that creates the extension

Responses

201

(Extension) The Extension that was just created.

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
403
(BasicFailedReply) Your current session does not have a user id associated with it. (code: extensions.no_user_id)
409
(BasicFailedReply) An extension already exists with the generated id. Please try again. (code: extensions.id_already_exists)
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/extensions \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "extension_type" : "string",
   "name" : "string",
   "url" : "string",
   "version" : "string"
}
'

Delete Extension

Deletes a Extension.

Request

DELETE /api/v1/deployments/extensions/{extension_id}

Path parameters

Name Type Required Description

extension_id

string

Y

Id of an Extension

Responses

200

(EmptyResponse) Extension deleted successfully.

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
401
(BasicFailedReply) * The Extension does not belong to you. (code: extensions.unauthorised) * Your current session does not have a user id associated with it. (code: extensions.no_user_id)
404
(BasicFailedReply) The Extension requested does not exist. (code: extensions.not_found)
409
(BasicFailedReply) The version you sent does not match the persisted version. (code: extensions.version_conflict)
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/extensions/{extension_id} \
-u $CLOUD_USER:$CLOUD_KEY

Get Extension

Retrieves an Extension.

Request

GET /api/v1/deployments/extensions/{extension_id}

Path parameters

Name Type Required Description

extension_id

string

Y

Id of an Extension

Responses

200

(Extension) The Extension

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 Extension requested does not exist. (code: extensions.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/extensions/{extension_id} \
-u $CLOUD_USER:$CLOUD_KEY

Update Extension

Updates a Extension.

Request

PUT /api/v1/deployments/extensions/{extension_id}

Path parameters

Name Type Required Description

extension_id

string

Y

Id of an Extension

Request body

(UpdateExtensionRequest) (required) The Extension update data.

Responses

200

(Extension) Extension updated successfully.

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
401
(BasicFailedReply) * The Extension does not belong to you. (code: extensions.unauthorised) * Your current session does not have a user id associated with it. (code: extensions.no_user_id)
404
(BasicFailedReply) The Extension you want does not exist. (code: extensions.not_found)
409
(BasicFailedReply) The version you sent does not match the persisted version. (code: extensions.version_conflict)
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/extensions/{extension_id} \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "extension_type" : "string",
   "name" : "string",
   "url" : "string",
   "version" : "string"
}
'
«  Comments     Deployments - IP Filtering - CRUD  »