API clients

Create API clients to access Bunny's GraphQL API, set scopes, rotate the client secret, generate access tokens and browse API events.

Bunny has an extensive GraphQL API that enables you to do everything that can be done via the user interface. In order to access the API, you will need to create one or more API clients. We recommend creating different API clients for different purposes, such as marketing website, self-service, CRM integration etc.

It’s good practice to narrow down the scope as much as possible in order to limit your security exposure.

API client Config tab with name, entity, access token expiration, scopes, grant toggles and client credentials

API client

See Bunny’s developer documentation for more details on how to use the API both directly and via Bunny’s SDKs.

Rotating client secretLink to Rotating client secret section

If you client secret has been compromised or needs to be changed you can select the Renew client secret action.

API client actions menu with Renew client secret, Delete and Events options

This will immediately generate a new client secret and display it once on the screen. The previous client secret will be removed and no longer work.

Any access tokens that were generated with the old client secret will continue to work until their token expiry date/time has passed.

Generating an access tokenLink to Generating an access token section

You can use the OAuth2 client credentials grant to generate an access token with a refined set of scopes based on the scopes that were enabled on the api client.

Alternately you can generate an access token via the admin UI by clicking the Generate access token button. This will generate an access token containing all of the scopes that have been enabled for the api client and will expire based on the expiration setting for that client.

EventsLink to Events section

To aid with troubleshooting API issues, the client’s API requests are recorded as events: queries are kept for one day and mutations for one year. You can browse them on the events tab and see the detailed payloads and responses.

API client Events tab listing mutations, with one event's request, variables and response shown