public-urls

List a computer’s public URLs

Changed on

A public URL is https://<label>.<base_domain> (orgo.dev) serving a port inside the computer to anyone with the link; a new one’s label is <name>-<tail> (POST). The app must listen on 0.0.0.0:<port>, not 127.0.0.1. Answers { enabled: false, public_urls: [] } where the feature is off or the computer cannot have one (only Linux and Windows computers can).

get/api/computers/{id}/public-urls

Request

  • Base URL
    https://www.orgo.ai
  • Auth
    HTTP bearer

Path parameters

idstring required

Computer id.

Response

Settings and the list.

enabledboolean required

False where the feature is off for this account or this computer cannot have public URLs.

reasonstring

Why enabled is false for this computer, when that is the reason.

base_domainstring
limitinteger

Most public URLs this computer may have; negative means no cap.

account_limitinteger

Most public URLs the workspace owner’s account may have across all its computers; negative means no cap.

account_usedinteger

How many it has.

Example response

{
  "base_domain": "orgo.dev",
  "public_urls": [
    {
      "url": "https://cool-thing-x7k2.orgo.dev",
      "hostname": "cool-thing-x7k2.orgo.dev",
      "label": "cool-thing-x7k2"
    }
  ]
}

Changes