Skip to main content
PATCH
Send port, password, or both. "password": null removes the password. Changes are live within 5 seconds. With a password, a browser sees a password form first. Any other request without the form’s cookie, such as an API call or a webhook, gets 401. A program that needs in can read the cookie from Get public URL password. Setting a new password signs out everyone who entered the old one.

Authorizations

Authorization
string
header
required

API key authentication. Get your key at orgo.ai/workspaces

Path Parameters

id
string
required

Computer ID. Accepts the computer's UUID or its instance_id.

urlId
string<uuid>
required

The public URL's id, from List public URLs.

Body

application/json

Send port, password, or both.

port
integer

Serve another port on the computer.

Required range: 1 <= x <= 65535
password
string | null

4 to 64 printable ASCII characters, case sensitive, no space at the start or end. null removes the password.

Required string length: 4 - 64

Response

Updated. The answer never includes the password, only protected.

id
string<uuid>
required
url
string<uri>
required

The address to share.

Example:

"https://cool-thing-x7k2.orgo.dev"

hostname
string
required
Example:

"cool-thing-x7k2.orgo.dev"

label
string
required

The part of the hostname before the base domain.

Example:

"cool-thing-x7k2"

port
integer
required

The port on the computer the URL serves.

Required range: 1 <= x <= 65535
created_at
string<date-time>
required
protected
boolean
required

true when visitors must enter a password first.

disabled
boolean

Present and true only when Orgo support turned the URL off. It is not served and cannot be changed or removed.