[BETA] Create OpenSearch Logs external integration endpoint

POST /dbaas-external-endpoint-opensearch/{name}

[BETA] Create OpenSearch Logs external integration endpoint

application/json

Body Required

  • settings object

    Additional properties are allowed.

    Hide settings attributes Show settings attributes object
    • ca string

      PEM encoded CA certificate

      Maximum length is 16384.

    • url string Required

      OpenSearch connection URL

      Minimum length is 12, maximum length is 2048.

    • index-prefix string Required

      OpenSearch index prefix

      Minimum length is 1, maximum length is 1000. Format should match the following pattern: ^[a-z0-9][a-z0-9-_.]+$.

    • index-days-max integer(int64)

      Maximum number of days of logs to keep

      Minimum value is 1, maximum value is 10000.

    • timeout integer(int64)

      OpenSearch request timeout limit

      Minimum value is 10.0, maximum value is 120.0.

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

      Additional properties are allowed.

      Hide reference attributes Show reference attributes object
      • 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.
POST /dbaas-external-endpoint-opensearch/{name} 
curl \
 -X POST https://api-ch-gva-2.exoscale.com/v2/dbaas-external-endpoint-opensearch/{name} \
 -H "Content-Type: application/json" \
 -d '{"settings":{"ca":"string","url":"string","index-prefix":"string","index-days-max":42,"timeout":42}}'
Request examples 
{
  "settings": {
    "ca": "string",
    "url": "string",
    "index-prefix": "string",
    "index-days-max": 42,
    "timeout": 42
  }
}
Response examples (200) 
{
  "id": "string",
  "reason": "incorrect",
  "reference": {
    "id": "string",
    "link": "string",
    "command": "string"
  },
  "message": "string",
  "state": "failure"
}