Skip to main content

Interface: SignozApiKeyOptions

Defined in: src/client.ts:30

Authentication by service account API key (SigNoz-Api-Key), with no session and no rotate.

Extends​

  • CommonOptions

Properties​

apiKey​

apiKey: string

Defined in: src/client.ts:32

A service account's API key (Settings → Service Accounts in SigNoz).

authToken?​

optional authToken?: undefined

Defined in: src/client.ts:33

baseUrl​

baseUrl: string

Defined in: src/client.ts:9

The instance URL, with its base path if any (e.g. https://example.com/signoz).

Inherited from​

CommonOptions.baseUrl

fetch?​

optional fetch?: (input, init?) => Promise<Response>

Defined in: src/client.ts:13

An alternative fetch (tests, proxy).

Parameters​

input​

string | URL | Request

init?​

RequestInit

Returns​

Promise<Response>

Inherited from​

CommonOptions.fetch

refreshAuthToken?​

optional refreshAuthToken?: undefined

Defined in: src/client.ts:34

timeoutMs?​

optional timeoutMs?: number

Defined in: src/client.ts:11

Timeout per attempt, in ms (default 30000; 0 or Infinity turn it off).

Inherited from​

CommonOptions.timeoutMs