It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Create an extension
editCreate an extension
editCreates the extension.
The extensions API supports two types of usage patterns.
A). Specify a download_url
, http or https URL, where the extension is currently hosted. This will result in extension being copied to elastic repository.
B). Create only the extension metadata using the POST
endpoint and then use PUT
to upload the extension file. Leave the download_url
unspecified in this case.
Request
editPOST /api/v1/deployments/extensions
Request body
edit(CreateExtensionRequest
) (required) the data that creates the extension
Responses
edit-
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
-
-
400
-
(
BasicFailedReply
) Could not download the extension from the specified URL. (code:extensions.request_execution_failed
)Headers
-
x-cloud-error-codes
(string
; allowed values: [extensions.request_execution_failed
]) - The error codes associated with the response
-
-
404
-
(
BasicFailedReply
) Your current session does not have a user id associated with it. (code:extensions.no_user_id
)Headers
-
x-cloud-error-codes
(string
; allowed values: [extensions.no_user_id
]) - The error codes associated with the response
-
-
409
-
(
BasicFailedReply
) An extension already exists with the generated id. Please try again. (code:extensions.id_already_exists
)Headers
-
x-cloud-error-codes
(string
; allowed values: [extensions.id_already_exists
]) - The error codes associated with the response
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request example
editcurl -XPOST https://{{hostname}}/api/v1/deployments/extensions \ -H "Authorization: ApiKey $ECE_API_KEY" \ -H 'Content-Type: application/json' \ -d ' { "description" : "string", "download_url" : "string", "extension_type" : "string", "name" : "string", "version" : "string" } '