Class NetworkPolicyOps

Network Policy SDK interface for managing network policies.

Remarks

Overview

The NetworkPolicyOps class provides a high-level abstraction for managing network policies, which define egress network access rules for devboxes. Policies can be applied to blueprints, devboxes, and snapshot resumes to control network access.

Usage

This interface is accessed via RunloopSDK.networkPolicy. You should construct a RunloopSDK instance and use it from there:

Example

const runloop = new RunloopSDK();
const policy = await runloop.networkPolicy.create({
  name: 'restricted-policy',
  allow_all: false,
  allowed_hostnames: ['github.com', 'api.openai.com'],
});

const info = await policy.getInfo();
console.log(`Policy: ${info.name}`);

Index

Methods

create fromId list

Methods

create

create(
params: Runloop.NetworkPolicyCreateParams,
options?: RequestOptions<unknown>,
): Promise<RunloopSDK.NetworkPolicy>
Create a new network policy.
Parameters
- params: Runloop.NetworkPolicyCreateParams
  Parameters for creating the network policy.
- Optionaloptions: RequestOptions<unknown>
  Request options.
Returns Promise<RunloopSDK.NetworkPolicy>
A NetworkPolicy instance.
Example
```
const runloop = new RunloopSDK();
const policy = await runloop.networkPolicy.create({
  name: 'my-policy',
  allow_all: false,
  allowed_hostnames: ['github.com', '*.npmjs.org'],
  allow_devbox_to_devbox: true,
  description: 'Policy for restricted network access',
});
```
- Defined in src/sdk.ts:1463

fromId

fromId(id: string): RunloopSDK.NetworkPolicy
Get a network policy object by its ID.
Parameters
- id: string
  The ID of the network policy.
Returns RunloopSDK.NetworkPolicy
A NetworkPolicy instance.
Example
```
const runloop = new RunloopSDK();
const policy = runloop.networkPolicy.fromId('npol_1234567890');
const info = await policy.getInfo();
console.log(`Policy name: ${info.name}`);
```
- Defined in src/sdk.ts:1481

list

list(
params?: Runloop.NetworkPolicyListParams,
options?: RequestOptions<unknown>,
): Promise<RunloopSDK.NetworkPolicy[]>
List network policies with optional filters (paginated).
Parameters
- Optionalparams: Runloop.NetworkPolicyListParams
  Optional filter parameters.
- Optionaloptions: RequestOptions<unknown>
  Request options.
Returns Promise<RunloopSDK.NetworkPolicy[]>
An array of NetworkPolicy instances.
Example
```
const runloop = new RunloopSDK();
const policies = await runloop.networkPolicy.list({ limit: 10 });
console.log(policies.map((p) => p.id));
```
- Defined in src/sdk.ts:1499

Class NetworkPolicyOps

Remarks

Overview

Usage

Example

Index

Methods

Methods

create

Parameters

Returns Promise<RunloopSDK.NetworkPolicy>

Example

fromId

Parameters

Returns RunloopSDK.NetworkPolicy

Example

list

Parameters

Returns Promise<RunloopSDK.NetworkPolicy[]>

Example

Settings

On This Page