database

List indices (OpenSearch)

Returns a list of available indices for a Managed Database service {uuid}.

get/1.3/database/{uuid}/indices

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/database/{uuid}/indices
  • Auth: HTTP bearer

Path parameters

uuidstring uuid required

The unique identifier for the integration.

Example:01234567-89ab-cdef-0123-456789abcdef

Service UUID

Response

OK

create_timestring date-time

Creation time of the index.

docsinteger

Number of documents in the index.

healthstring

Health status of the index.

index_namestring

Name of the index.

number_of_replicasinteger

Number of replicas for the index.

number_of_shardsinteger

Number of shards for the index.

read_only_allow_deleteboolean

Indicates if the index is read-only and allows deletion.

sizeinteger

Size of the index in bytes.

statusstring

Status of the index.

Example response

[
  {
    "create_time": "2023-05-11T13:24:10.623Z",
    "docs": 1,
    "health": "green",
    "index_name": ".kibana_1",
    "number_of_replicas": 0,
    "number_of_shards": 1,
    "read_only_allow_delete": false,
    "size": 5313,
    "status": "open"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.