Skip to main content
POST
Create public URL
Makes https://<name>-<tail>.orgo.dev serve a port on the computer. See Public URLs. Read the address from url in the answer. Orgo adds 4 characters after the name, so it can’t be known in advance. Leave out name and Orgo picks one. The app must listen on 0.0.0.0, not 127.0.0.1. Each port gets one URL: a second create for the same port answers 409 PORT_TAKEN with the existing URL in public_url. Needs a paid plan or credits you’ve bought.

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.

Body

application/json
port
integer
required

The port your app listens on inside the computer. Not 22, 3389, 5900 to 5999, 6080 to 6099, 8080 or 9000: the computer uses those itself.

Required range: 1 <= x <= 65535
name
string

The start of the address. Orgo adds 4 characters after it, so cool-thing becomes cool-thing-x7k2. Lowercase letters, digits and hyphens. Omit it and Orgo picks one.

Required string length: 2 - 16
label
string

Older name for name, read the same way. To get back an address the workspace owner removed in the last 30 days, send its full label here, for example cool-thing-x7k2. Send name or label, not both.

Response

Created.

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.