API Reference

Katapult Core API

Resources & Endpoints

Update organization API token

Updates an organization API token with new properties.

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

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 update

 API Token Lookup None

properties Required

The new properties for the API token

 APITokenArguments None

annotations

Annotations for this API token

 KeyValue Array 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?
    }
    annotations: [ KeyValue {
        key: String
        value: String?
    } ]
}