Skip to content

Regenerate API secret

POST
/v1/integrator/regenerate-secret

Regenerates the integrator’s API secret. The new secret is returned in the response - this is the only time it will be exposed.

Grace Period: Optionally specify oldSecretValidForSeconds (0-3600) to keep the old secret valid during rotation. This prevents service disruption while updating your systems.

Warning: Without a grace period, the old secret is invalidated immediately. Any requests signed with the old secret will fail.

Store the new secret securely - it cannot be retrieved again.

object
oldSecretValidForSeconds

Grace period in seconds during which the old secret remains valid. Allows for safe rotation without service disruption. Default: 0 (immediate invalidation), Maximum: 3600 (1 hour).

number
0 <= 3600

Response for status 200

object
secret
required

The newly generated API secret. This is the only time the secret will be exposed - store it securely.

string
oldSecretExpiresAt

ISO 8601 timestamp when the old secret will expire. Only present if a grace period was specified.

string format: date-time

Response for status 401

object
type

A URI reference that identifies the problem type

string
default: about:blank
title
required

A short, human-readable summary of the problem type

string
status
required

The HTTP status code

number
detail

A human-readable explanation specific to this occurrence

string
instance

A URI reference that identifies the specific occurrence

string
realm

The authentication realm

string
scope

The required scope for this resource

string

Response for status 404

object
type

A URI reference that identifies the problem type

string
default: about:blank
title
required

A short, human-readable summary of the problem type

string
status
required

The HTTP status code

number
detail

A human-readable explanation specific to this occurrence

string
instance

A URI reference that identifies the specific occurrence

string
resourceType
required

The type of resource that was not found

string
resourceId
required

The identifier of the resource that was not found

string

Response for status 500

object
type

A URI reference that identifies the problem type

string
default: about:blank
title
required

A short, human-readable summary of the problem type

string
status
required

The HTTP status code

number
detail

A human-readable explanation specific to this occurrence

string
instance

A URI reference that identifies the specific occurrence

string