Class NetworkPolicies

Hierarchy

APIResource
- NetworkPolicies

Index

Constructors

Properties

Methods

create retrieve update list delete

Constructors

constructor

new NetworkPolicies(client: Runloop): Runloop.NetworkPolicies
Parameters
- client: Runloop
Returns Runloop.NetworkPolicies
Inherited from APIResource.constructor
- Defined in src/resource.ts:8

Properties

`Protected`_client

_client: Runloop

Methods

create

create(
body: Runloop.NetworkPolicyCreateParams,
options?: RequestOptions<unknown>,
): APIPromise<Runloop.NetworkPolicyView>
Create a new NetworkPolicy with the specified egress rules. The policy can then be applied to blueprints, devboxes, or snapshot resumes.
Parameters
- body: Runloop.NetworkPolicyCreateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.NetworkPolicyView>
- Defined in src/resources/network-policies.ts:13

retrieve

retrieve(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<Runloop.NetworkPolicyView>
Get a specific NetworkPolicy by its unique identifier.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.NetworkPolicyView>
- Defined in src/resources/network-policies.ts:20

update

update(
    id: string,
    body?: Runloop.NetworkPolicyUpdateParams,
    options?: RequestOptions<unknown>,
): APIPromise<Runloop.NetworkPolicyView>
Update an existing NetworkPolicy. All fields are optional.
Parameters
- id: string
- Optionalbody: Runloop.NetworkPolicyUpdateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.NetworkPolicyView>
- Defined in src/resources/network-policies.ts:27
update(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<Runloop.NetworkPolicyView>
Update an existing NetworkPolicy. All fields are optional.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.NetworkPolicyView>
- Defined in src/resources/network-policies.ts:32

list

list(
    query?: Runloop.NetworkPolicyListParams,
    options?: RequestOptions<unknown>,
): PagePromise<
    Runloop.NetworkPolicyViewsNetworkPoliciesCursorIDPage,
    Runloop.NetworkPolicyView,
>
List all NetworkPolicies for the authenticated account.
Parameters
- Optionalquery: Runloop.NetworkPolicyListParams
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<
Runloop.NetworkPolicyViewsNetworkPoliciesCursorIDPage,
Runloop.NetworkPolicyView,
>
- Defined in src/resources/network-policies.ts:47
list(
    options?: RequestOptions<unknown>,
): PagePromise<
    Runloop.NetworkPolicyViewsNetworkPoliciesCursorIDPage,
    Runloop.NetworkPolicyView,
>
List all NetworkPolicies for the authenticated account.
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<
Runloop.NetworkPolicyViewsNetworkPoliciesCursorIDPage,
Runloop.NetworkPolicyView,
>
- Defined in src/resources/network-policies.ts:51

delete

delete(
    id: string,
    body?: Runloop.NetworkPolicyDeleteParams | null,
    options?: RequestOptions<unknown>,
): APIPromise<Runloop.NetworkPolicyView>
Delete an existing NetworkPolicy. This action is irreversible.
Parameters
- id: string
- Optionalbody: Runloop.NetworkPolicyDeleteParams | null
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.NetworkPolicyView>
- Defined in src/resources/network-policies.ts:70