Interface CreateClientParams

Client initialization parameters

Hierarchy

  • CreateClientParams

Properties

accessToken adapter? application? basePath? environment? headers? host? httpAgent? httpsAgent? insecure? integration? logHandler? proxy? retryLimit? retryOnError? space timeout?

Properties

accessToken

accessToken: string

Contentful CDA Access Token

Optional adapter

adapter?: AxiosAdapter

Optional axios request adapter (see axios docs )

Optional application

application?: string

Application name and version e.g myApp/version

Optional basePath

basePath?: string

Path appended to the host to support gateways/proxies with custom urls

Optional environment

environment?: string

Contentful Environment ID

Default Value

"master"

Optional headers

headers?: Record<string, string>

Optional additional headers

Optional host

host?: string

API host. Also usable with preview.contentful.com.

Default Value

"cdn.contentful.com"

Optional httpAgent

httpAgent?: any

Optional Node.js HTTP agent for proxying (see Node.js docs and https-proxy-agent)

Optional httpsAgent

httpsAgent?: any

Optional Node.js HTTP agent for proxying (see Node.js docs and https-proxy-agent)

Optional insecure

insecure?: boolean

Requests will be made over http instead of the default https

Default Value

true

Optional integration

integration?: string

Integration name and version e.g react/version

Optional logHandler

logHandler?: ((level, data?) => void)

Type declaration

Optional proxy

proxy?: false | AxiosProxyConfig

Optional Axios proxy (see axios docs )

Optional retryLimit

retryLimit?: number

Optional number of retries before failure.

Default Value

5

Optional retryOnError

retryOnError?: boolean

If we should retry on errors and 429 rate limit exceptions

Default Value

true

space

space: string

Space ID

Optional timeout

timeout?: number

connection timeout in milliseconds (default:30000)

Settings

Member Visibility

Theme

On This Page