Interface RestPublicClientOptions

Public REST API client options

See

typedoc Reference Documentation
client RestPublicClient

interface RestPublicClientOptions {
sandbox?: boolean;
apiKey?: string;
}

Index

Properties

sandbox? apiKey?

Properties

`Optional` sandbox

sandbox?: boolean

If true, the client will point to Kuma Sandbox API
If not provided or false, will point to the Kuma Production API.

Default Value

false

`Optional` apiKey

apiKey?: string

Optional for public clients

Increases rate limits when provided