Responses

• 200 application/json

  The information for the license.

  Hide response attributes Show response attributes object

  • license object Required

    License data

    Hide license attributes Show license attributes object

    • version integer(int32)

      Version of the license

    • uid string Required

      Unique identifier of the license

    • issuer string Required

      Issuer of the license

    • issued_to string Required

      Entity the license was issued to

    • issue_date_in_millis integer(int64) Required

      When the license was issued, in milliseconds since the Unix epoch

    • type string Required

      Type of the license

    • subscription_type string

      Type of the license subscription

    • signature string Required

      Digital signature

    • start_date_in_millis integer(int64) Required

      Initial validity of the license, in milliseconds since the Unix epoch

    • expiry_date_in_millis integer(int64) Required

      When the license expires, in milliseconds since the Unix epoch

    • max_allocators integer(int32)

      Maximum number of allocators. Empty for version >= 3

    • max_ram_per_allocator_mb integer(int32)

      Maximum RAM per allocator in MB. Empty for version >= 3

    • max_instances integer(int32)

      Maximum number of instances. Only present for version 3

    • max_resource_units integer(int32)

      Maximum number of resource units, where each unit is 64GB. Only present for version > 3

    • operation_mode string

      Operation mode

    • cluster_licenses array[object]

      List of cluster licenses

      Information about the Elasticsearch cluster license.

      Hide cluster_licenses attribute Show cluster_licenses attribute object

      • license object Required

        Object containing the cluster license data

  • usage_stats object

    Information about current usage.

    Hide usage_stats attribute Show usage_stats attribute object

    • total_connected_memory_total integer(int32) Required

      The total amount of memory available to your system

• 404 application/json

  The license cannot be found. (code: license.license_not_found)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is license.license_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