Create a sub account API token.

POST 
https://api.logz.io/v1/api-tokens/sub-account

Creates a new API token for a sub account. Must be run with an API token of the owner account. Once created, you can view the details for this new token in Manage tokens > API tokens, when you are logged in to the relevant sub account.

Note: To activate Prometheus API over our Metrics account contact Logz.io's support team. Please ensure to change the region in the URL to match your account's region.

Request

application/json

Body

required

name string

Default value: string

The name provided in the request for a new API token for the sub account

accountId int32

Logz.io sub account ID.

Responses

200

successful operation

application/json

Schema

Schema

id int32

ID of the newly created API token for the sub account

name string

The name of the newly created API token for the sub account. Uses the name provided in the request.

token string

The API token

createdAt Instant

The time at which the new sub account API token was created

Example (from schema)

{
  "id": 7386,
  "name": "newTokenTest999",
  "token": "c498fbc3-a3ac-4676-ad09-689854b5cbbd\"",
  "createdAt": 1621858311
}

400

Bad Request

application/json

Schema

Schema

message string

Bad Request. The request cannot be completed. Errors may include malformed request syntax, invalid request message parameters, and so on.

Example (from schema)

{
  "message": "Bad Request. There was an issue with the request syntax from the client. Received integer instead of expected string parameter"
}

401

Unauthorized

application/json

Schema

Schema

message string

Unauthorized. Attempted to create an API token for a sub account with insufficient or missing credentials for the main or owner account. Please contact our Support team for access to this API feature via help@logz.io.

Example (from schema)

{
  "message": "Unauthorized. There was a problem with the authorization provided in the request."
}

403

Forbidden

application/json

Schema

Schema

message string

Forbidden. Attempted to create an API token for a sub account with an invalid owner account token. This operation requires a valid API token for the owner account.

Example (from schema)

{
  "message": "Forbidden. Attempted to create an API token for a sub account using an illegal owner account token."
}

404

Not Found

application/json

Schema

Schema

message string

Not Found. Could not find the sub account associated with this request or the relevant owner account for the sub account.

Example (from schema)

{
  "message": "Not Found. Could not find the sub account associated with this request."
}

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 POST 'https://api.logz.io/v1/api-tokens/sub-account' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-API-TOKEN: <API_KEY_VALUE>' \
--data-raw '{
  "name": "newTokenTest999",
  "accountId": 160343
}'

Request Collapse all

Base URL

https://api.logz.io

Auth

X-API-TOKEN

Body required

{
  "name": "newTokenTest999",
  "accountId": 160343
}