SDK: egress

The egress area has 9 methods on the client. Each takes one object of path, query and body arguments and an optional CallOptions, and returns a promise of the response body. A refused call rejects with OverlaneApiError (see the SDK index).

egressEvaluate

Ask whether a host may be reached; the answer is recorded

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/egress/evaluate

egressEvaluate(args: { tenantId: string; projectId: string; body: EvaluateEgressRequest }, options?: CallOptions): Promise<Record<string, unknown>>

egressEvents

Egress decisions recorded for the project

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/egress/events

egressEvents(args: { tenantId: string; projectId: string; query?: { outcome?: string; task?: string; limit?: string } }, options?: CallOptions): Promise<Record<string, unknown>>

egressGrantsCreate

Grant a task one secret for one host

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/egress/grants

egressGrantsCreate(args: { tenantId: string; projectId: string; body: GrantRequest }, options?: CallOptions): Promise<Record<string, unknown>>

egressGrantsGet

Read one credential grant

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/egress/grants/{grantId}

egressGrantsGet(args: { tenantId: string; projectId: string; grantId: string }, options?: CallOptions): Promise<Record<string, unknown>>

egressGrantsList

List per-task credential grants

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/egress/grants

egressGrantsList(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<Record<string, unknown>>

egressGrantsRevoke

Revoke a credential grant

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/egress/grants/{grantId}/revoke

egressGrantsRevoke(args: { tenantId: string; projectId: string; grantId: string; body: RevokeGrantRequest }, options?: CallOptions): Promise<TaskGrant>

egressLeakscan

Scan files for credentials before they leave

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/egress/leak-scan

egressLeakscan(args: { tenantId: string; projectId: string; body: LeakFilesRequest }, options?: CallOptions): Promise<LeakScanResult>

egressPolicyGet

Read the egress allowlist policy

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/egress/policy

egressPolicyGet(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<Record<string, unknown>>

egressPolicyPut

Change the egress allowlist policy

• Request: PUT on /v1/tenants/{tenantId}/projects/{projectId}/egress/policy
• Needs an approval for agents: class policy_change

egressPolicyPut(args: { tenantId: string; projectId: string; body: PutEgressPolicyRequest }, options?: CallOptions): Promise<Record<string, unknown>>