Skip to main content

Retrieve account settings by ID

GET 
/v1/account-management/time-based-accounts/:id

Returns account configuration settings as a JSON object. Must be run with an API token from the main account.

In the schema below, properties may be labeled as Subscription or Consumption. If a field doesn’t apply to your plan, it may be null.

Please ensure to change the region in the URL to match your account's region.

Request​

Path Parameters

    id int32required

    ID of the account to retrieve

    Example: 99999

Responses​

successful operation

Schema
    accountId int64

    ID of the account

    email string

    Email address of the user who created the account

    accountName string

    Name of the account

    retentionDays int32

    How long log data is retained in the Elasticsearch Index and searchable in Kibana, in days.

    searchable boolean

    Default value: false

    If other accounts can search this account's logs, true. Otherwise, false.

    accessible boolean

    Default value: false

    If users of the main account can access this account, true. Otherwise, false.

    docSizeSetting boolean

    Default value: false

    Adds a LogSize field to each log to record the size in bytes, to better manage the account utilization.

    sharingObjectsAccounts object[]

    Accounts that have permissions to access this account's Kibana objects.

  • Array [
    • accountId int32

    ID of the account

    accountName string

    Name of the account

  • ]
    • utilizationSettings object

    Settings for logging metrics on your account utilization, such as used and expected data volume at current indexing rate.

    frequencyMinutes int32

    How often utilization metrics are written to logs, in minutes

    utilizationEnabled boolean

    If utilization metrics are written to logs, true. Otherwise, false.

    isOwner boolean

    Default value: false

    If the account is an owner account, true. Otherwise, false.

    snapsearchRetentionDays int32

    Number of days to retain data in the warm tier. Minimum value is 1.

    isFlexibleSubscription boolean

    Default value: false

    Indicates whether the plan has shared volume enabled.

    For Consumption accounts, this field defaults should be false.

    If true, the volume of data that the account can index per calendar day is determined by 2 parameters: reservedDailyGB (Required) and maxDailyGB (Optional, can be null).

    If false, the volume of data that the account can index per calendar day is determined only by maxDailyGB. The parameter reservedDailyGB does not apply and should be null.

    reservedDailyGBSubscription float

    Daily reserved capacity in GB.

    • If Consumption account (isFlexible: false), this value is always null.
    • If isFlexible=false, this field does not apply and will be null.
    • If isFlexible=true, this determines the daily volume in GBs that is reserved for the account, given as an integer.
    maxDailyGBSubscription float

    The maximum volume of data that an account can index per calendar day.

    • If Consumption account (isFlexible: false), this value determines the account's soft cap in GB.

    • If isFlexible=false this is the only capacity reserved for use by the account. Cannot be null.

    • If isFlexible=true this is used to limit the account's access to shared volume. Once the data shipped to the account exceeds the account's reserved capacity, the account can continue to index data up to its maxDailyGB, as long as shared volume is available.

    • If null (and isFlexible=true), the account is uncapped and can continue to index data as long as shared volume is available.

    isCappedSubscription boolean

    Default value: false

    • If Consumption account (isFlexible: false), this value is always null.

    • If isFlexible=false, this field does not apply and will be false.

    • If isFlexible=true, this field determines whether the account is capped by GB. If the account is capped, true.

    totalTimeBasedDailyGBSubscription float

    • If Consumption account (isFlexible: false), this value is always null.

    • If isFlexible=false, this field does not apply and will be null.

    • If isFlexible=true, this determines the account plan volume in GB.

    sharedGBSubscription float

    • If Consumption account (isFlexible: false), this value is always null.

    • If isFlexible=false, this field does not apply and will be null.

    • If isFlexible=true, this determines the shareable volume in GB.

    softLimitGBConsumption float

    If Subscription account, this value is always null. Indicates the account's soft cap in GB.

Loading...