Update a log shipping token

PUT 
https://api.logz.io/v1/log-shipping/tokens/:id

Enables/disables a log shipping token and/or renames it. Please ensure to change the region in the URL to match your account's region.

Request

Path Parameters

id int32required
This token's ID.
Example: 786351

application/json

Body

name string

Descriptive name for this token.

enabled boolean

Default value: true

To enable this token, true. To disable, false.

Responses

200

successful operation

application/json

Schema

Schema

name string

This token's name.

id int32

This token's ID.

token string

The token itself.

updatedAt string

Unix timestamp of when this token was last updated.

updatedBy string

Email address of the last user to update this token.

createdAt string

Unix timestamp of when this token was created.

createdBy string

Email address of the user who created this token.

enabled boolean

If this token is enabled, true. If it's disabled, false.

Example (from schema)

{
  "name": "apac prod",
  "id": 786351,
  "token": "6bLXmMA6FLibc7ySSqNcCfvbhtqT0rPS",
  "updatedAt": 414720000,
  "updatedBy": "shalom.the.mighty@gmail.com",
  "createdAt": 389836800,
  "createdBy": "you.got.this@gmail.com",
  "enabled": 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 PUT 'https://api.logz.io/v1/log-shipping/tokens/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-API-TOKEN: <API_KEY_VALUE>' \
--data-raw '{
  "name": "staging eu",
  "enabled": true
}'

Request Collapse all

Base URL

https://api.logz.io

Auth

X-API-TOKEN

Parameters

id — pathrequired

Body

{
  "name": "staging eu",
  "enabled": true
}