Skip to main content

Update an account

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

Updates the account settings of a main account or sub account, with some exceptions, noted below:

  • For the main account, the parameter retentionDays cannot be updated. It is determined by the plan you purchased.
  • For the main account, if isFlexible=false, the parameters maxDailyGB and reservedDailyGB cannot be updated using this endpoint. 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 update

    Example: 99999

Body

    accountName stringrequired

    Name of the account

    reservedDailyGB float

    • If isFlexible=false, this field does not apply. Leave it null.

    • If isFlexible=true, this parameter is required. It determines the volume that is reserved for the account.

    maxDailyGB float

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

    • If isFlexible=false this parameter can only be used to update a sub account, but not a main account. It determines the only capacity reserved for use by the account. It 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.

    retentionDays int32

    Possible values: >= 1

    This is how long log data is stored 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.

    sharingObjectsAccounts int32[]required

    IDs of accounts that can access this account's data. The array is required, but can be empty.

    docSizeSetting boolean

    Default value: false

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

    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.

Responses​

successful operation

Loading...