AGagentarea
v1
protected
egress-exits

Create Egress Exit

Changed on

Define a proxy the workspace's MCP instances may leave through.

post/v1/workspaces/{workspace}/egress-exits/

Request

Path parameters

workspacestring required

Slug of the workspace the request acts in

Request body

allow_plaintext_credentialsboolean

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

descriptionstring nullable

What this exit is for.

namestring required

Name, unique in the workspace.

password_secret_idstring uuid nullable

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.

upstream_urlstring required

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

usernamestring nullable

Proxy username, if it needs one.

Response

Successful Response

allow_plaintext_credentialsboolean required
created_atstring date-time required
created_bystring required
descriptionstring nullable required
idstring uuid required
managed_bystring nullable required

"platform" for an exit the operator manages; null for the workspace's own.

namestring required
password_secret_idstring uuid nullable required
updated_atstring date-time required
upstream_urlstring nullable required
usernamestring nullable required
viastring nullable required

The platform hop this exit leaves through, if any.

Changes