OpenSearch Features

OpenSearch Managed Databases provide additional features for managing indices, access controls, and security settings.

GET/1.3/database/{uuid}/indices

List indices

Returns a list of indices in an OpenSearch Managed Database service.

Request

GET

/1.3/database/{uuid}/indices

curl -X GET https://api.upcloud.com/1.3/database/09a4b9d5-c1f8-4c9f-9e7a-1234567890ab/indices \
  -u your_username:your_password

DELETE/1.3/database/{uuid}/indices/{index_name}

Delete index

Deletes an index from an OpenSearch Managed Database service.

Request

DELETE

/1.3/database/{uuid}/indices/{index_name}

curl -X DELETE https://api.upcloud.com/1.3/database/09a4b9d5-c1f8-4c9f-9e7a-1234567890ab/indices/logs-2024-01 \
  -u your_username:your_password

GET/1.3/database/{uuid}/access-control

Get access controls

Returns the access control settings for an OpenSearch Managed Database service.

Request

GET

/1.3/database/{uuid}/access-control

curl -X GET https://api.upcloud.com/1.3/database/09a4b9d5-c1f8-4c9f-9e7a-1234567890ab/access-control \
  -u your_username:your_password

PATCH/1.3/database/{uuid}/access-control

Modify access controls

Modifies access control settings for an OpenSearch Managed Database service.

Attributes

Name
access_control
Type
boolean
Description
Enable access control with user authentication.
Name
extended_access_control
Type
boolean
Description
Grant access to top-level _mget, _msearch, and _bulk APIs with user-specific access control rules.

Request

PATCH

/1.3/database/{uuid}/access-control

curl -X PATCH https://api.upcloud.com/1.3/database/09a4b9d5-c1f8-4c9f-9e7a-1234567890ab/access-control \
  -u your_username:your_password \
  -H "Content-Type: application/json" \
  -d '{
    "access_control": true,
    "extended_access_control": true
  }'

GET/1.3/database/{uuid}/security

Get security status

Returns the security management status for an OpenSearch Managed Database service.

Request

GET

/1.3/database/{uuid}/security

curl -X GET https://api.upcloud.com/1.3/database/09a4b9d5-c1f8-4c9f-9e7a-1234567890ab/security \
  -u your_username:your_password

POST/1.3/database/{uuid}/security/admin

Create security admin

Creates a security admin user for OpenSearch security management.

Attributes

Name
password
Type
string
Description
Password for the security admin user.

Request

POST

/1.3/database/{uuid}/security/admin

curl -X POST https://api.upcloud.com/1.3/database/09a4b9d5-c1f8-4c9f-9e7a-1234567890ab/security/admin \
  -u your_username:your_password \
  -H "Content-Type: application/json" \
  -d '{
    "password": "SecureAdminPassword123!"
  }'

PUT/1.3/database/{uuid}/security/admin

Modify security admin

Updates the security admin user password or disables the admin user.

Attributes

Name
password
Type
string
Description
New password for the security admin user. Omit to disable.

Request

PUT

/1.3/database/{uuid}/security/admin

curl -X PUT https://api.upcloud.com/1.3/database/09a4b9d5-c1f8-4c9f-9e7a-1234567890ab/security/admin \
  -u your_username:your_password \
  -H "Content-Type: application/json" \
  -d '{
    "password": "NewSecureAdminPassword456!"
  }'