Update Extension

POST /deployments/extensions/{extension_id}

Updates an extension.

Path parameters

  • extension_id string Required

    Id of an extension

application/json

Body Required

The extension update data.

  • name string Required

    The extension name.

  • description string

    The extension description.

  • download_url string

    The URL to download the extension archive.

  • extension_type string Required

    The extension type.

    Values are plugin or bundle.

  • version string Required

    The Elasticsearch version.

Responses

  • 200 application/json

    Extension updated successfully.

    Hide headers attributes Show headers attributes
    • x-cloud-resource-version string

      The resource version, which is used to avoid update conflicts with concurrent operations

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

    Hide response attributes Show response attributes object
    • id string Required

      The extension ID

    • name string Required

      The extension name.

    • description string

      The extension description.

    • url string Required

      The extension URL to be used in the plan.

    • download_url string

      The download URL specified during extension creation.

    • extension_type string Required

      The extension type.

      Values are plugin or bundle.

    • version string Required

      The Elasticsearch version.

    • deployments array[string]

      List of deployments using this extension. Up to only 10000 deployments will be included in the list.

    • file_metadata object

      The extension file metadata.

      Hide file_metadata attributes Show file_metadata attributes object
      • last_modified_date string(date-time)

        The date and time the extension was last modified.

      • size integer(int64)

        The extension file size in bytes.

      • url string(uri)

        The temporary URL to download the extension file. Usable for verification.

  • 400 application/json

    Could not download the extension from the specified URL. (code: extensions.request_execution_failed)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is extensions.request_execution_failed.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

  • 401 application/json
    • 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)
    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Values are extensions.unauthorised or extensions.no_user_id.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

  • 404 application/json

    The extension you want does not exist. (code: extensions.not_found)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is extensions.not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

  • 409 application/json

    The version you sent does not match the persisted version. (code: extensions.version_conflict)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is extensions.version_conflict.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

POST /deployments/extensions/{extension_id}
curl \
 --request POST 'https://api.elastic-cloud.com/api/v1/deployments/extensions/{extension_id}' \
 --header "Content-Type: application/json" \
 --data '{"name":"string","description":"string","download_url":"string","extension_type":"plugin","version":"string"}'