v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
tokensLibraryManagement

Update a token.

Update a token with the given identifier in the token library.

put/v1/tokens/{id}

Path parameters

idstring required

Identifier of the token to update.

Request body

namestring required

Name of the token.

descriptionstring

Description of the token.

statusstring required

Status of the token. Can be Active, or Inactive.

typestring required

Type of the token. Valid values: 1) CollectorRegistration

versioninteger required

Version of the token.

Example request

{
  "name": "token-name",
  "description": "token description: for test.",
  "status": "Active",
  "type": "CollectorRegistration"
}

Response

The token was successfully modified.

idstring required

Identifier of the token.

namestring required

Name of the token.

descriptionstring required

Description of the token.

statusstring required

Status of the token. Can be Active, or Inactive.

typestring required

Type of the token. Valid values: 1) CollectorRegistrationTokenResponse

versioninteger required

Version of the token.

createdAtstring date-time required

Creation timestamp in UTC in RFC3339 format.

createdBystring required

Identifier of the user who created the resource.

modifiedAtstring date-time required

Last modification timestamp in UTC.

modifiedBystring required

Identifier of the user who last modified the resource.

Example response

{
  "name": "token-name",
  "description": "token description: for test.",
  "status": "Active",
  "type": "CollectorRegistrationTokenResponse"
}