Create a DBaaS OpenSearch ACL configuration

PUT /dbaas-opensearch/{name}/acl-config

Path parameters

  • name string Required

    Service name

    Minimum length is 0, maximum length is 63.

application/json

Body Required

  • acls array[object]

    List of OpenSearch ACLs

    Hide acls attributes Show acls attributes object
    • rules array[object]
      Hide rules attributes Show rules attributes object
      • index string Required

        OpenSearch index pattern

        Maximum length is 249. Format should match the following pattern: [^\s\/]+.

      • permission string

        OpenSearch permission

        Values are admin, read, deny, readwrite, or write.

    • username string

      Minimum length is 1, maximum length is 64.

  • acl-enabled boolean

    Enable OpenSearch ACLs. When disabled authenticated service users have unrestricted access.

  • extended-acl-enabled boolean

    Enable to enforce index rules in a limited fashion for requests that use the _mget, _msearch, and _bulk APIs

Responses

  • • 200 application/json

    200

    Hide response attributes Show response attributes object
    • id string(uuid)

      Operation ID

    • reason string

      Operation failure reason

      Values are incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, or conflict.

    • reference object

      Related resource reference

      Hide reference attributes Show reference attributes
      • id string(uuid)

        Reference ID

      • link string

        Link to the referenced resource

      • command string

        Command name

    • message string

      Operation message

    • state string

      Operation status

      Values are failure, pending, success, or timeout.
PUT /dbaas-opensearch/{name}/acl-config 
curl \
 -X PUT https://api-ch-gva-2.exoscale.com/v2/dbaas-opensearch/{name}/acl-config \
 -H "Content-Type: application/json" \
 -d '{"acls":[{"rules":[{"index":"string","permission":"admin"}],"username":"string"}],"acl-enabled":true,"extended-acl-enabled":true}'
Request example 
{
  "acls": [
    {
      "rules": [
        {
          "index": "string",
          "permission": "admin"
        }
      ],
      "username": "string"
    }
  ],
  "acl-enabled": true,
  "extended-acl-enabled": true
}
Response examples (200) 
{
  "id": "string",
  "reason": "incorrect",
  "reference": {
    "id": "string",
    "link": "string",
    "command": "string"
  },
  "message": "string",
  "state": "failure"
}