Global

An internal error code (string) or an HTTP status code (number).

Human-readble description of the error.

Original (relative) URL.

Effective base URL.

Request method used.

Query parameters passed.

Data sent in the request body.

URL relative to the baseURL or the tenant. Ex.: '/api/v2/entities'.

Request method ('get', 'put', 'post', 'delete').

Name of the Dynatrace tenant (BalancedAPIRequest only - not an Axios property). Ex.: 'PROD'.

URL of the Dynatrace tenant (DirectAPIRequest only). Ex.: 'https://abc12345.live.dynatrace.com'.

Plain object containing the headers to be set in the request. Ex.: { 'Authorization': 'token XYZ' }.

URL parameters to be sent with the request. Must be a plain object or a URLSearchParams object. Ex.: { ID: 12345 }.

Must be of one of the following types: string, object, ArrayBuffer, ArrayBufferView, URLSearchParams, Stream, Buffer. Ex.: { firstName: 'Bart' }.

Specifies whether the request should be rejected if due to throttling it cannot immediately be issued (BalancedAPIRequest only - not an Axios property).

Number of milliseconds before the request times out. If the request takes longer than timeout, it will be aborted (if it has been issued already) or cancelled (if it is still waiting in a queue).

Number of milliseconds to wait before trying again after a 429 or 503 status is received and the response does not contain a 'Retry-After' header. If not provided, the default from the constructor is used.

Maximum number of redirects to follow. If set to 0, no redirects will be followed.

Maximum number of retries allowed if a potentially transient error is encountered (not an Axios property).

Maximum size of the http request content in bytes.

Maximum size of the http response content in bytes.

IGNORED This parameter is set by BalancedAPIRequest and DirectAPIRequest internally.

Specifies the type of data that the server will respond with. Options are: 'arraybuffer', 'document', 'json', 'text', 'stream'. Note: The automatic paging support only works then this value is set to 'json'.

Specifies whether or not cross-site Access-Control requests should be made using credentials.

Encoding to use for decoding responses. Note: Ignored when responseType is 'stream'.

Specifies a cancel token that can be used to cancel the request. See Axios documentation for details. Note that BalancedAPIRequest sets this property to create and return a CancellablePromise or a CancellableEventEmitter through which requests can be cancelled.

See Axios documentation.

See Axios documentation.

See Axios documentation.

See Axios documentation.

Specifies whether or not the response body should be decompressed automatically. If set to true will also remove the 'content-encoding' header from the response objects of all decompressed responses. Note: The automatic paging support only works then this value is set to true.

Name of tenant as used in the tenant property of RequestOptions.

The address of the tenant. Either this or the hosts property must be present.

A list of addresses of nodes at which the tenant can be reached. This is typically a subset of cluster nodes (for Managed Clusters).

If the nodes(s) are of a Managed Cluster, this is the environment URL. Ex.: /e/123-456-345

The Dynatrace API token to be used to execute the requests. The permissions this token should represent depends on the APIs that are permitted to be used.

Maximum number of retries before reporting an error. Note that
retry attempts will stop once the 'timeout' value gets exceeded.

Maximum number of API requests per minute allowed against this tenant.

Maximum length of the queue. The actual size is typically kept in check by virtue of the request rate limit.

Maximum number of milliseconds a request may be queued. A request will be cancelled with 408 status if it stays queued for too long.

Maximum allowed number of concurrently active (i.e. issued) requests.

Number of milliseconds before a request times out once issued. If a request takes longer than this value, it will be aborted.

Number of milliseconds to wait before retrying after a 429 or 503 status where the response does not contain a 'Retry-After' header.