Class NetworkPolicy

Object-oriented interface for working with Network Policies.

Remarks

Overview

The NetworkPolicy class provides a high-level, object-oriented API for managing network policies. Network policies define egress network access rules for devboxes and can be applied to blueprints, devboxes, and snapshot resumes.

Quickstart

import { RunloopSDK } from '@runloop/api-client-ts';

const runloop = new RunloopSDK();
const policy = await runloop.networkPolicy.create({
  name: 'my-policy',
  allow_all: false,
  allowed_hostnames: ['github.com', '*.npmjs.org'],
});

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

Index

Accessors

Methods

getInfo update

Accessors

id

get id(): string
Get the network policy ID.

Returns string
The network policy ID
- Defined in src/sdk/network-policy.ts:106

Methods

getInfo

getInfo(options?: RequestOptions<unknown>): Promise<Runloop.NetworkPolicyView>
Get the complete network policy data from the API.
Parameters
- Optionaloptions: RequestOptions<unknown>
  Request options
Returns Promise<Runloop.NetworkPolicyView>
The network policy data
Example
```
const info = await policy.getInfo();
console.log(`Policy name: ${info.name}, allow_all: ${info.egress.allow_all}`);
```
- Defined in src/sdk/network-policy.ts:122

update

update(
params: Runloop.NetworkPolicyUpdateParams,
options?: RequestOptions<unknown>,
): Promise<Runloop.NetworkPolicyView>
Update an existing NetworkPolicy. All fields are optional.
Parameters
- params: Runloop.NetworkPolicyUpdateParams
  Parameters for updating the network policy
- Optionaloptions: RequestOptions<unknown>
  Request options
Returns Promise<Runloop.NetworkPolicyView>
The updated network policy data
Example
```
const updated = await policy.update({
  name: 'updated-policy-name',
  allow_all: true,
  description: 'Updated description',
});
```
- Defined in src/sdk/network-policy.ts:142

Class NetworkPolicy

Remarks

Overview

Quickstart

Index

Accessors

Methods

Accessors

id

Returns string

Methods

getInfo

Parameters

Returns Promise<Runloop.NetworkPolicyView>

Example

update

Parameters

Returns Promise<Runloop.NetworkPolicyView>

Example

Settings

On This Page