Create a client
apiKey is a value from secure server configuration. An empty key throws TypeError.
Configuration
The package supports ESM, CommonJS, and TypeScript types. The server runtime requires
fetch or a supplied implementation.
Resources
The client exposeslabs and deployments. Their reference maps each method to its REST operation.
The http member provides lower-level requests. Named methods cover the documented integration features, including terminal sessions.
The separate browser terminal helper does not import the server client or require an organization key.
Headers
The client sendsX-API-KEY and an X-Cybr-SDK version header. The client disables HTTP caching for API requests.
Retry behavior
GET and PUT requests retry timeouts, network errors, and server errors. POST and DELETE requests do not retry those errors automatically. Rate-limit responses can retry within the configured retry count. A requested wait above five seconds returnsrate_limited to the caller.
Backoff starts at 500 milliseconds and doubles, with jitter. A single wait has a five-second ceiling.
A timeout after a write does not prove that the write failed. The error guide describes recovery.
Terminal startup has a separate bounded retry for CONTAINER_STARTING. The terminal reference describes its deadline and cancellation.
Package version
SDK_VERSION reports the version of the SDK in use. Public package installation instructions will appear in the quickstart.