Skip to main content
PATCH
Update Egress Exit

Authorizations

Authorization
string
header
required

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

Path Parameters

exit_id
string<uuid>
required
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

Patch an exit: only the fields sent change; null clears an optional one.

allow_plaintext_credentials
boolean | null
description
string | null
name
string | null
Required string length: 1 - 255
password_secret_id
string<uuid> | null
upstream_url
string | null
Maximum string length: 512
username
string | null
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.