Update Egress Exit

Change an exit; only the fields sent change.

Changing where it leads or its credentials restarts the running instances bound to it.

patch/v1/workspaces/{workspace}/egress-exits/{exit_id}

Request

The document declares no server URL.
Auth
HTTP bearer
TypeScript
https://skmtc.dev/agentarea/apis/agentarea-api/docs/v1/workspaces/:workspace/egress-exits/:exit_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

exit_idstring uuid required

workspacestring required

Slug of the workspace the request acts in

allow_plaintext_credentialsboolean nullable

descriptionstring nullable

namestring nullable

password_secret_idstring uuid nullable

upstream_urlstring nullable

usernamestring nullable

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.