openapi: 3.2.0 info: description: '# Introduction This API is documented using the **OpenAPI 2.0** specification.' title: Logz.io Manage metrics account API termsOfService: https://logz.io/about-us/terms-of-use/ contact: email: help@logz.io url: https://docs.logz.io/ license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://api.logz.io/ security: - X-API-TOKEN: [] tags: - name: Manage metrics account paths: /v1/account-management/metrics-accounts: post: summary: Create a new metrics account description: Please ensure to change the region in the URL to match your account's region. tags: - Manage metrics account responses: 201: description: Created content: application/json: schema: type: object properties: id: type: integer description: ID of the created metrics account accountName: type: string description: Name of metrics account. token: type: string description: Metrics account token createdAt: type: string format: date-time description: Timestamp of account creation planUts: type: integer description: Usage plan for Unique Time Series (UTS). UTS defines the number of unique time series an account is allowed to have. If usage exceeds the plan, exceeding data points will not be processed. authorizedAccountsIds: type: array description: IDs of authorized accounts items: type: integer requestBody: content: application/json: schema: type: object required: - email properties: email: type: string description: Email address of the account owner example: ^[_A-Za-z0-9-\+]+(\.[_A-Za-z0-9-]+)*@[A-Za-z0-9-]+(\.[A-Za-z0-9-]+)*(\.[A-Za-z]{2,})$ accountName: type: string description: Name of metrics account to be created. If empty, the default name `_metrics` is used. planUts: type: integer description: Usage plan for Unique Time Series (UTS). UTS defines the number of unique time series an account is allowed to have. If usage exceeds the plan, exceeding data points will not be processed. authorizedAccountsIds: type: array description: IDs of authorized accounts items: type: integer description: IDs of authorized accounts required: true operationId: postV1AccountManagementMetricsAccounts x-operation-id-source: derived get: summary: Get a list of all metrics accounts description: Please ensure to change the region in the URL to match your account's region. tags: - Manage metrics account responses: 200: description: OK content: application/json: schema: type: array items: type: object properties: id: type: integer description: ID of the metrics account accountName: type: string description: Name of metrics account. token: type: string description: Metrics account token createdAt: type: string format: date-time description: Timestamp of account creation planUts: type: integer description: Usage plan for Unique Time Series (UTS). UTS defines the number of unique time series an account is allowed to have. If usage exceeds the plan, exceeding data points will not be processed. authorizedAccountsIds: type: array description: IDs of authorized accounts items: type: integer operationId: getV1AccountManagementMetricsAccounts x-operation-id-source: derived /v1/account-management/metrics-accounts/{metricsAccountId}: put: summary: Update a metrics account description: Please ensure to change the region in the URL to match your account's region. tags: - Manage metrics account parameters: - in: path name: metricsAccountId required: true schema: type: integer responses: 200: description: OK content: application/json: schema: type: object properties: id: type: integer description: ID of the metrics account accountName: type: string description: Name of metrics account. token: type: string description: Metrics account token createdAt: type: string format: date-time description: Timestamp of account creation planUts: type: integer description: Usage plan for Unique Time Series (UTS). UTS defines the number of unique time series an account is allowed to have. If usage exceeds the plan, exceeding data points will not be processed. authorizedAccountsIds: type: array description: IDs of authorized accounts items: type: integer requestBody: content: application/json: schema: type: object properties: accountName: type: string description: Name of metrics account. planUts: type: integer description: Usage plan for Unique Time Series (UTS). UTS defines the number of unique time series an account is allowed to have. If usage exceeds the plan, exceeding data points will not be processed. authorizedAccountsIds: type: array description: IDs of authorized accounts items: type: integer required: true operationId: putV1AccountManagementMetricsAccountsByMetricsAccountId x-operation-id-source: derived delete: summary: Delete a metrics account description: Please ensure to change the region in the URL to match your account's region. tags: - Manage metrics account parameters: - in: path name: metricsAccountId required: true responses: 200: description: OK operationId: deleteV1AccountManagementMetricsAccountsByMetricsAccountId x-operation-id-source: derived get: summary: Get a specific metrics account description: Please ensure to change the region in the URL to match your account's region. tags: - Manage metrics account parameters: - in: path name: metricsAccountId required: true schema: type: integer responses: 200: description: OK content: application/json: schema: type: object properties: id: type: integer description: ID of the metrics account accountName: type: string description: Name of metrics account. token: type: string description: Metrics account token createdAt: type: string format: date-time description: Timestamp of account creation planUts: type: integer description: Usage plan for Unique Time Series (UTS). UTS defines the number of unique time series an account is allowed to have. If usage exceeds the plan, exceeding data points will not be processed. authorizedAccountsIds: type: array description: IDs of authorized accounts items: type: integer operationId: getV1AccountManagementMetricsAccountsByMetricsAccountId x-operation-id-source: derived components: securitySchemes: X-API-TOKEN: description: '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.' type: apiKey in: header name: X-API-TOKEN x-servers: - url: https://api.logz.io description: US East (Northern Virginia) - url: https://api-au.logz.io description: Asia Pacific (Sydney) - url: https://api-ca.logz.io description: Canada (Central) - url: https://api-eu.logz.io description: Europe (Frankfurt) - url: https://api-uk.logz.io description: Europe (London) x-tagGroups: - name: Log Monitoring tags: - Search logs - Alerts - Deployments - Insights - Logz.io snapshots - name: Cloud SIEM tags: - Security account - Security rules - Security events - Lookup lists - name: Account administration tags: - Manage users - Manage metrics account - Associated accounts - Authentication groups - Who am I - Manage time-based log accounts - Manage shared tokens - Manage API tokens - Manage notification endpoints - Import or export Kibana objects - name: Manage data shipping tags: - Manage log shipping tokens - Drop filters - Archive logs - Restore logs - Parsing - Delete object API - name: Data security tags: - Retrieve audit trail - name: Connect to AWS resources tags: - Connect to CloudTrail - Connect to S3 Buckets - name: Metrics API Gateway tags: - Grafana contact points - Grafana data source - Grafana alerting provisioning - Grafana silence management - Grafana annotations - Grafana dashboards - Grafana dashboard search - Grafana snapshots - Grafana get all folders description: Metrics API Gateway to supported endpoints.