Class GatewayConfigOps

Gateway Config SDK interface for managing gateway configurations.

Remarks

Overview

The GatewayConfigOps class provides a high-level abstraction for managing gateway configurations, which define how to proxy API requests through the credential gateway. Gateway configs specify the target endpoint and how credentials should be applied, enabling secure API proxying without exposing API keys.

Usage

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

Example

const runloop = new RunloopSDK();
const gatewayConfig = await runloop.gatewayConfig.create({
  name: 'my-api-gateway',
  endpoint: 'https://api.example.com',
  auth_mechanism: { type: 'bearer' },
});

// Use with a devbox
const devbox = await runloop.devbox.create({
  name: 'my-devbox',
  gateways: {
    'MY_API': {
      gateway: gatewayConfig.id,
      secret: 'my-api-key-secret',
    },
  },
});

Index

Methods

create fromId list

Methods

create

create(
params: Runloop.GatewayConfigCreateParams,
options?: RequestOptions<unknown>,
): Promise<RunloopSDK.GatewayConfig>
Create a new gateway config.
Parameters
- params: Runloop.GatewayConfigCreateParams
  Parameters for creating the gateway config.
- Optionaloptions: RequestOptions<unknown>
  Request options.
Returns Promise<RunloopSDK.GatewayConfig>
A GatewayConfig instance.
Example
```
const runloop = new RunloopSDK();
const gatewayConfig = await runloop.gatewayConfig.create({
  name: 'my-gateway',
  endpoint: 'https://api.example.com',
  auth_mechanism: { type: 'header', key: 'x-api-key' },
  description: 'Gateway for My API',
});
```
- Defined in src/sdk.ts:1864

fromId

fromId(id: string): RunloopSDK.GatewayConfig
Get a gateway config object by its ID.
Parameters
- id: string
  The ID of the gateway config.
Returns RunloopSDK.GatewayConfig
A GatewayConfig instance.
Example
```
const runloop = new RunloopSDK();
const gatewayConfig = runloop.gatewayConfig.fromId('gwc_1234567890');
const info = await gatewayConfig.getInfo();
console.log(`Gateway Config name: ${info.name}`);
```
- Defined in src/sdk.ts:1882

list

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

Class GatewayConfigOps

Remarks

Overview

Usage

Example

Index

Methods

Methods

create

Parameters

Returns Promise<RunloopSDK.GatewayConfig>

Example

fromId

Parameters

Returns RunloopSDK.GatewayConfig

Example

list

Parameters

Returns Promise<RunloopSDK.GatewayConfig[]>

Example

Settings

On This Page