SDK quickstart

​

Requirements

• An organization account with Cybr Labs
• An organization API key
• A server runtime with fetch, such as Node.js 18 or later.

​

Install the SDK

​

Create a server client

import { CybrLabs } from '@cybr/labs-sdk'

const cybr = CybrLabs.init({ key: apiKey })

​

Launch a lab

1. List the available labs:

const labs = await cybr.labs.list()

2. Select an activated lab from your catalog.
3. Resolve the learner ID from your server session.
4. Launch the lab:

const deployment = await cybr.deployments.launch({
  labId,
  learnerId,
  membership: 'free'
})

5. Store deployment.id with the learner session.
6. Wait for the environment:

const ready = await deployment.waitUntilReady({
  onProgress: (status) => console.log(status.status)
})

7. Return the required connection details from ready.outputs to that learner.

​

End the lab

await deployment.destroy()

​

Next steps