Interface PostBucketRequest

interface PostBucketRequest {
    description?: string;
    name: string;
    orgID: string;
    retentionRules?: RetentionRules;
    rp?: string;
    schemaType?: SchemaType;
}

Properties

description? name orgID retentionRules? rp? schemaType?

Properties

Optionaldescription

description?: string

A description of the bucket.

name

name: string

The name of the bucket.

orgID

orgID: string

Organization ID. The ID of the organization.

OptionalretentionRules

retentionRules?: RetentionRules

Optionalrp

rp?: string

Retention policy is an InfluxDB 1.x concept that represents the duration of time that each data point in the retention policy persists. Use rp for compatibility with InfluxDB 1.x. The InfluxDB 2.x and Cloud equivalent is retention period.

OptionalschemaType

schemaType?: SchemaType

Schema Type. Use explicit to enforce column names, tags, fields, and data types for your data.

InfluxDB Cloud

  • Default is implicit.

InfluxDB OSS

  • Doesn't support schemaType.

Settings

Member Visibility

On This Page

Properties