API Reference

Katapult Core API

Resources & Endpoints

Regenerate organization API token secret

Regenerates the secret for an organization API token.

POST
https://api.katapult.io/core/v1/api_tokens/{api_token}/regenerate_secret

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

api_token Required

The API token to regenerate the secret for

 API Token Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

api_token_not_found

No API token was found matching any of the criteria provided in the arguments.

 404 Not Found

permission_denied

The authenticated identity is not permitted to perform this action

 403 Forbidden

validation_error

A validation error occurred with the object that was being created/updated/deleted

 422 Unprocessable Entity

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    api_token: APIToken {
        id: String
        name: String
        organization_id: String?
        authorized_ip_addresses: [ String ]
        expires_at: Unix Timestamp?
        rate_limit: Integer
        scopes: [ String ]
        secret: String?
    }
}