Create a client

Use createDevboxClient() to configure authentication, API transport, and Devbox connection defaults. The returned client provides access to Devboxes, blueprints, and images.

`createDevboxClient()`

Create a client that provides access to Devboxes, blueprints, and images. The client loads credentials when it first makes an authenticated request.

Example

import { createDevboxClient } from "@namespacelabs/sdk/devbox";

const client = createDevboxClient();

/*  Work with the devbox client here */

// Close the connection at the end
client.close()

API reference

createDevboxClient(options?: DevboxClientOptions): DevboxClient

Arguments and options

DevboxClientOptions

Options used to configure the client.

Hide properties

TokenSourceInput

Provides API tokens for Namespace requests and Devbox connections. Defaults to the Namespace workload token when available, then falls back to the local user token.

Transport

A fully configured Connect transport for Devbox API requests. When provided, baseUrl is ignored and the SDK does not add RPC authentication. The tokenSource is still used to authenticate Devbox connections.

string

The Devbox API URL used by the default transport. Defaults to NSC_DEVBOX_ENDPOINT when set, or the Namespace iad regional endpoint. This does not select where Devboxes are created.

number

default:"90000"

The default timeout, in milliseconds, for establishing a connection to a Devbox.

Return value

createDevboxClient() returns a DevboxClient. In examples, this object is assigned to the client variable.

`DevboxClient`

A DevboxClient provides APIs for working with Devboxes, blueprints, and images. It also manages the connections used to interact with Devboxes.

Example

import { createDevboxClient } from "@namespacelabs/sdk/devbox";

const client = createDevboxClient();
const devboxes = await client.devboxes.list();

API reference

interface DevboxClient {
  devboxes: DevboxResource;
  blueprints: BlueprintResource;
  images: ImageResource;
  close(): void;
}

Explore the APIs

Select an API to learn how to manage Devboxes, blueprints, or images with the client.

client.devboxes

Create, find, list, start, stop, and delete Devboxes.

client.blueprints

Create, find, list, update, and delete blueprints.

client.images

`client.close()`

Close connections cached by the client when your application no longer needs them. This does not delete Devboxes, blueprints, images, or other resources.

Example

import { createDevboxClient } from "@namespacelabs/sdk/devbox";

const client = createDevboxClient();

client.close();

API reference

close(): void

Arguments and options

This method has no arguments or options.

Return value

Returns no value. Calling close() more than once has no effect.

Authenticate with Namespace

Configure credentials for local development and automated workloads.

Create and manage Devboxes

Use the client’s Devbox resource and manage Devbox lifecycles.

Devbox SDK

Automation

CLI

`createDevboxClient()`

Example

API reference

Arguments and options

Return value

`DevboxClient`

Example

API reference

Explore the APIs

client.devboxes

client.blueprints

client.images

`client.close()`

Example

API reference

Arguments and options

Return value

Authenticate with Namespace

Create and manage Devboxes

​createDevboxClient()

​Example

​API reference

​Arguments and options

​Return value

​DevboxClient

​Example

​API reference

​Explore the APIs

client.devboxes

client.blueprints

client.images

​client.close()

​Example

​API reference

​Arguments and options

​Return value

​Related documentation

Authenticate with Namespace

Create and manage Devboxes

`createDevboxClient()`

Example

API reference

Arguments and options

Return value

`DevboxClient`

Example

API reference

Explore the APIs

`client.close()`

Example

API reference

Arguments and options

Return value

Related documentation