SPA API Tokens

SPA: Updates an API Token

Updates an existing API token. Token value cannot be changed. Requires ROLE_INTEGRATOR or ROLE_ADMIN.

PATCH/api/spa/api-tokens/{id}

Authorizations

X-AUTH-TOKEN
stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Path Parameters

id
stringrequired

ApiToken identifier

Request Body

application/json
required

The updated ApiToken resource

{
  "identifier": "default",
  "description": "Any description",
  "active": true,
  "activeFrom": "2024-01-01"
}

Response

200application/json

ApiToken resource updated

id
integer

Identifier generated by Output.Rocks.

Example: 12345

identifier
stringrequired

Unique identifier

Example: "default"

description
stringrequired

ApiToken description

Example: "Any description"

token
string

Token, to be used in API requests to Output.Rocks API

Example: "Any description"

createdAt
string<date-time>

UTC date time of entry creation

Example: "2024-08-23T00:00:00+00:00"

updatedAt
string<date-time>

UTC date time of last entry update

Example: "2024-08-23T00:00:00+00:00"

active
boolean

Active flag. Default: true

Available options: truefalse

Example: true

activeFrom
string<date-time>

Date to activate the entry. Default: today

Example: "2024-01-01"