Retrieve detailed information for all accounts

GET 
https://api.logz.io/v1/account-management/time-based-accounts/detailed

Returns detailed account information for the main account and all of its associated sub accounts. Information includes usage and sharing permissions for Kibana objects.

• The list of accounts is returned as an array of JSON objects. Each sub account is its own object.
• Must be run with an API token from the main account. Please ensure to change the region in the URL to match your account's region.

Request

Responses

200

successful operation

application/json

Schema

Schema

• Array [
subAccountRelation object

Properties of the sub accounts related to this main account

ownerAccountId int32

ID of the main account

subAccountId int32

ID of the sub account

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.

createdDate int64

Date this account was created.

lastUpdatedDate int64

Date this account was last updated.

lastUpdaterUserId int32

ID of the user who last updated this account

type string

Possible values: [OWNER_ACCOUNT, SUB_ACCOUNT, TIMELESS_INDEX, ALL]

Account type

account object

accountId int32

accountName string

accountToken string

active boolean

esIndexPrefix string

Prefix of the Elasticsearch Index used to index the data.

isFlexible boolean

Default value: false

Indicates whether the plan has shared volume enabled.

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.

reservedDailyGB float

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

• If isFlexible=true, this determines the daily volume in GB reserved for the account. This capacity is guaranteed and cannot be used by any other accounts.

maxDailyGB float

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

• 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.

retentionDays int32

How long log data is stored and searchable in Kibana, in days.

sharingObjectsAccounts object[]
Array [
accountId int32
accountName string
accountToken string
active boolean
esIndexPrefix string
Prefix of the Elasticsearch Index used to index the data.
isFlexible boolean
Default value: false
Indicates whether the plan has shared volume enabled.
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.
reservedDailyGB float
• If isFlexible=false, this field does not apply.

• If isFlexible=true, this determines the daily volume in GB reserved for the account. This capacity is guaranteed and cannot be used by any other accounts.
maxDailyGB float
The maximum volume of data that an account can index per calendar day.
• 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.
retentionDays int32
How long log data is stored and searchable in Kibana, in days.
]
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.

dailyUsagesList object
usage object[]
Array [
date int64
bytes int64
]
docSizeSetting boolean

Default value: false

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

• ]

Example (from schema)

[
  {
    "subAccountRelation": {
      "ownerAccountId": 88765,
      "subAccountId": 89234,
      "searchable": true,
      "accessible": false,
      "createdDate": 1627489797000,
      "lastUpdatedDate": 1627489797000,
      "lastUpdaterUserId": 33342,
      "type": "SUB_ACCOUNT"
    },
    "account": {
      "accountId": 0,
      "accountName": "string",
      "accountToken": "string",
      "active": true,
      "esIndexPrefix": "string",
      "isFlexible": true,
      "reservedDailyGB": 3,
      "maxDailyGB": 5,
      "retentionDays": 0
    },
    "sharingObjectsAccounts": [
      {
        "accountId": 0,
        "accountName": "string",
        "accountToken": "string",
        "active": true,
        "esIndexPrefix": "string",
        "isFlexible": true,
        "reservedDailyGB": 3,
        "maxDailyGB": 5,
        "retentionDays": 0
      }
    ],
    "utilizationSettings": {
      "frequencyMinutes": 5,
      "utilizationEnabled": true
    },
    "dailyUsagesList": {
      "usage": [
        {
          "date": 0,
          "bytes": 0
        }
      ]
    },
    "docSizeSetting": true
  }
]

Authorization: X-API-TOKEN

name: X-API-TOKENtype: apiKeydescription: You can manage your API tokens from the [Logz.io API tokens](https://app.logz.io/#/dashboard/settings/manage-tokens/api) page.

API tokens are account-specific. You will need to be logged into the relevant Log Management or SIEM account to view the API tokens associated with it.

To manage your API tokens, log into the relevant account in your Logz.io platform, click the gear in the top-right menu, and select [**Tools > Manage tokens > API tokens**](https://app.logz.io/#/dashboard/settings/manage-tokens/api).

It's important to keep your tokens secure. API tokens carry privileges to make changes to users and accounts, so if you believe an API token has been compromised, delete it, and replace it with a new token in your integrations.in: header

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://api.logz.io/v1/account-management/time-based-accounts/detailed' \
-H 'Accept: application/json' \
-H 'X-API-TOKEN: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://api.logz.io

Auth

X-API-TOKEN