Create an extension
- POST /deployments/extensions
Creates 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
the data that creates the extension
-
namestringrequired -
The extension name. Only ASCII alphanumeric and [_.-] characters allowed
-
descriptionstring -
The extension description.
-
download_urlstring -
The URL to download the extension archive.
-
versionstringrequired -
The Elasticsearch version.
Responses
The extension that was just created.
-
idstringrequired -
The extension ID
-
namestringrequired -
The extension name.
-
descriptionstring -
The extension description.
-
urlstringrequired -
The extension URL to be used in the plan.
-
download_urlstring -
The download URL specified during extension creation.
-
versionstringrequired -
The Elasticsearch version.
-
deploymentsstring -
List of deployments using this extension. Up to only 10000 deployments will be included in the list.
-
file_metadataExtensionFileMetadata -
last_modified_datestring -
The date and time the extension was last modified.
-
sizeinteger -
The extension file size in bytes.
-
urlstring -
The temporary URL to download the extension file. Usable for verification.
Response Headers
-
x-cloud-resource-versionstring The resource version, which is used to avoid update conflicts with concurrent operations
-
x-cloud-resource-createdstring The date-time when the resource was created (ISO format relative to UTC)
-
x-cloud-resource-last-modifiedstring The date-time when the resource was last modified (ISO format relative to UTC)
Could not download the extension from the specified URL. (code: extensions.request_execution_failed)
-
errorsBasicFailedReplyElementrequired -
A list of errors that occurred in the failing request
Response Headers
-
x-cloud-error-codes The error codes associated with the response
Your current session does not have a user id associated with it. (code: extensions.no_user_id)
-
errorsBasicFailedReplyElementrequired -
A list of errors that occurred in the failing request
Response Headers
-
x-cloud-error-codes The error codes associated with the response
An extension already exists with the generated id. Please try again. (code: extensions.id_already_exists)
-
errorsBasicFailedReplyElementrequired -
A list of errors that occurred in the failing request
Response Headers
-
x-cloud-error-codes The error codes associated with the response