Get Extension

GET /deployments/extensions/{extension_id}

Retrieves an extension.

Path parameters

Query parameters

  • Include deployments referencing this extension. Up to only 10000 deployments will be included.

    Default value is false.

Responses

  • The Extension

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • id string Required

      The extension ID

    • name string Required

      The extension name.

    • The extension description.

    • url string Required

      The extension URL to be used in the plan.

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

    • The extension file metadata.

      Additional properties are allowed.

      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.

  • The extension requested does not exist. (code: extensions.not_found)

    Hide headers attribute Show headers attribute
    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

GET /deployments/extensions/{extension_id}
curl \
 -X GET https://{{hostname}}/api/v1/deployments/extensions/{extension_id}
Response examples (200)
# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{
  "id": "string",
  "name": "string",
  "description": "string",
  "url": "string",
  "download_url": "string",
  "extension_type": "plugin",
  "version": "string",
  "deployments": [
    "string"
  ],
  "file_metadata": {
    "last_modified_date": "2024-05-04T09:42:00+00:00",
    "size": 42,
    "url": "https://example.com"
  }
}
Response examples (404)
# Headers
x-cloud-error-codes: extensions.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}