API docs by Redocly

Cluster Settings REST API (2.0)

Download OpenAPI specification:

This API enables you to view or set cluster-level Enterprise Analytics settings.

View Enterprise Analytics Settings

Retrieves cluster-level Analytics settings.

Authorizations:
ClusterRead

Responses

Response samples

Content type
application/json
{
  • "blobStorageScheme": "s3",
  • "blobStorageBucket": "enteprise-analytics-bucket",
  • "blobStorageRegion": "us-west-2",
  • "blobStoragePrefix": "analytics-data/",
  • "blobStorageAnonymousAuth": false,
  • "blobStorageForcePathStyle": false,
  • "numStoragePartitions": 128
}

Modify Enterprise Analytics Settings

Sets cluster-level Analytics settings.

Authorizations:
ClusterWrite
Request Body schema: application/x-www-form-urlencoded
blobStorageScheme
string

Specifies the blob storage scheme.

blobStorageBucket
string

Specifies the blob storage bucket name.

blobStorageRegion
string

Specifies the blob storage bucket region.

blobStoragePrefix
string

Specifies the blob storage bucket prefix where enteprise analytics will store its data.

blobStorageAnonymousAuth
boolean

Specifies if anonymous authentication should be used when accessing the blob storage bucket.

blobStorageForcePathStyle
boolean

Specifies if path style should be should be used when accessing the blob storage bucket.

numStoragePartitions
integer [ 1 .. 1024 ]

Specifies the number partitions that will be used when storing the data in the blob storage bucket.

Responses

Response samples

Content type
application/json
{
  • "blobStorageScheme": "s3",
  • "blobStorageBucket": "enteprise-analytics-bucket",
  • "blobStorageRegion": "us-west-2",
  • "blobStoragePrefix": "analytics-data/",
  • "blobStorageAnonymousAuth": false,
  • "blobStorageForcePathStyle": false,
  • "numStoragePartitions": 128
}