Rotate token

Rotates the secret value inside the Indexing API token and returns the new raw secret. All other properties of the token are unchanged. In order to rotate the secret value, include the token as the bearer token in the /rotatetoken request. Please refer to Token rotation documentation for more information.

SecurityBearerAuth
Responses
200

OK

Response Schema: application/json
rawSecret
string

New raw secret

createdAt
integer <int64>

Unix timestamp in seconds when the new secret value is assigned to the token. The token needs to be rotated before rotationPeriodMinutes past the createdAt timestamp otherwise it would be rendered unusable.

rotationPeriodMinutes
integer <int64>

Refers to the time period in minutes before which this token needs to be rotated. It is required to rotate the token within the specified rotationPeriodMinutes after each /rotatetoken call, otherwise the tokens would expire. Note that the token would still expire at expiresAt timestamp provided during token creation even if the token is being regularly rotated. rotationPeriodMinutes property is inherited from the parent token being rotated

400

Bad Request

401

Not Authorized

post/rotatetoken
Request samples
Response samples
application/json
{
  • "rawSecret": "string",
  • "createdAt": 0,
  • "rotationPeriodMinutes": 0
}