API docs by Redocly

Cluster Settings REST API (2.1)

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": "enterprise-analytics-bucket",
  • "blobStorageRegion": "us-west-2",
  • "blobStoragePrefix": "analytics-data/",
  • "blobStorageAnonymousAuth": false,
  • "blobStorageForcePathStyle": false,
  • "blobStoragePathStyleAddressing": false,
  • "blobStorageEndpoint": "https://my-object-storage:18082",
  • "blobStorageDisableSslVerify": false,
  • "blobStorageCertificates": [
    ],
  • "blobStorageAccessKeyId": "AKIAIOSFODNN7EXAMPLE",
  • "blobStorageSecretAccessKey": "***",
  • "numStoragePartitions": 128
}

Modify Enterprise Analytics Settings

Sets cluster-level Analytics settings.

Authorizations:
ClusterWrite
Request Body schema: application/x-www-form-urlencoded
blobStorageScheme
string
Enum: "s3" "azblob"

The storage scheme (provider) to use. Supported values:

  • s3 — AWS S3 or an S3-compatible storage service.
  • azblob — Azure Blob Storage.
blobStorageBucket
string

The name of the blob storage bucket (S3) or container (Azure Blob Storage) where Enterprise Analytics will store its data.

blobStorageRegion
string

The region of the blob storage bucket. Applies only when blobStorageScheme is s3.

blobStoragePrefix
string

Optional. The path prefix within the bucket (S3) or container (Azure Blob Storage) where Enterprise Analytics will store its data. If not specified, the data is stored in the root of the bucket /

blobStorageAnonymousAuth
boolean

Applies only when blobStorageScheme is s3. If true, the storage bucket will be accessed without any credentials (anonymous access). See also blobStorageAccessKeyId and blobStorageSecretAccessKey for static credentials, or omit all credential fields to use the Standard Credential Chain.

blobStorageForcePathStyle
boolean
Deprecated

(Deprecated) Use blobStoragePathStyleAddressing instead.

blobStoragePathStyleAddressing
boolean

Applies only when blobStorageScheme is s3 and a custom blobStorageEndpoint is configured (S3-compatible storage). If true, path-style URLs are used (e.g., https://s3.example.com/bucket-name/key). If false, virtual-hosted-style URLs are used (e.g., https://bucket-name.s3.example.com/key). Some S3-compatible storage services require path-style addressing. Replaces the deprecated blobStorageForcePathStyle.

blobStorageEndpoint
string

The endpoint URL for the blob storage service. Required when using S3-compatible storage or Azure Blob Storage.

  • For s3 (S3-compatible): the URL of your S3-compatible storage service (e.g., https://my-object-storage:18082).
  • For azblob: the Blob service endpoint for your Azure storage account (e.g., https://mycompany.blob.core.windows.net/).
blobStorageDisableSslVerify
boolean

If true, disables certificate verification for SSL/TLS connections to the blob storage endpoint. Useful for testing or when using self-signed certificates, but not recommended for production. Warning: Disabling SSL verification in a production environment is highly insecure and exposes the system to serious risks, including Man-in-the-Middle (MITM) attacks.

blobStorageCertificates
Array of strings

One or more PEM-encoded certificates to trust when connecting to the blob storage endpoint. Only required if the endpoint is signed by a certificate authority (CA) other than a well-known public CA (e.g., for self-signed or private/internal CA certificates). Multiple certificates can be provided to support certificate rotation.

Available from Enterprise Analytics 2.1.1.

blobStorageAccessKeyId
string

Optional. Applies only when blobStorageScheme is s3. The Access Key ID for static credential authentication. If provided, must be supplied together with blobStorageSecretAccessKey. If omitted, the Standard Credential Chain is used (instance profile, environment variables, etc.) to obtain credentials automatically. See also blobStorageAnonymousAuth for anonymous access.

Available from Enterprise Analytics 2.1.1.

blobStorageSecretAccessKey
string

Optional. Applies only when blobStorageScheme is s3. The Secret Access Key for static credential authentication. If provided, must be supplied together with blobStorageAccessKeyId. If omitted, the Standard Credential Chain is used (instance profile, environment variables, etc.) to obtain credentials automatically. This value is masked as *** in logs and when returned from the API for security reasons.

Available from Enterprise Analytics 2.1.1.

numStoragePartitions
integer [ 1 .. 1024 ]

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

Responses

Response samples

Content type
application/json
{
  • "blobStorageScheme": "s3",
  • "blobStorageBucket": "enterprise-analytics-bucket",
  • "blobStorageRegion": "us-west-2",
  • "blobStoragePrefix": "analytics-data/",
  • "blobStorageAnonymousAuth": false,
  • "blobStorageForcePathStyle": false,
  • "blobStoragePathStyleAddressing": false,
  • "blobStorageEndpoint": "https://my-object-storage:18082",
  • "blobStorageDisableSslVerify": false,
  • "blobStorageCertificates": [
    ],
  • "blobStorageAccessKeyId": "AKIAIOSFODNN7EXAMPLE",
  • "blobStorageSecretAccessKey": "***",
  • "numStoragePartitions": 128
}