Skip to main content
POST
Create Egress Exit

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace
string
required

Slug of the workspace the request acts in

Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Body

application/json

A proxy of the workspace's own that its MCP instances may leave through.

name
string
required

Name, unique in the workspace.

Required string length: 1 - 255
upstream_url
string
required

The proxy as scheme://host:port: http, https or socks5, no credentials.

Maximum string length: 512
allow_plaintext_credentials
boolean
default:false

Send the credentials to an http or socks5 proxy, where they are unencrypted.

description
string | null

What this exit is for.

password_secret_id
string<uuid> | null

The proxy password as a workspace secret (id from the secrets catalog). It is read when an instance starts; changing the secret's value takes effect at the instance's next start.

username
string | null

Proxy username, if it needs one.

Maximum string length: 255

Response

Successful Response

allow_plaintext_credentials
boolean
required
created_at
string<date-time>
required
created_by
string
required
description
string | null
required
id
string<uuid>
required
managed_by
string | null
required

"platform" for an exit the deployment supplies; null for the workspace's own.

name
string
required
password_secret_id
string<uuid> | null
required
updated_at
string<date-time>
required
upstream_url
string | null
required
username
string | null
required
via
string | null
required

The platform hop this exit leaves through, if any.