briqs

Publish a briq on its HTTPS URL

A briq has one URL, on one port. Its front door (spec.expose, or its only port) is published at once; another port moves the URL there and restarts the machine, which warning says. mode left out keeps the URL's mode (a first URL is public). rotate: true gives a private URL a new token. An undeclared port is refused once the spec declares 32.

post/v1/briqs/{id}/expose

Request

  • Base URL: https://api.briq.cloud
  • URL: https://api.briq.cloud/v1/briqs/{id}/expose
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

portinteger required
protocol'http' | 'postgres' | 'mysql' | 'redis' | 'mongodb' | 'amqp' | 'bolt' | 'grpc'

http (default): an HTTPS URL. postgres, mysql, redis, mongodb, amqp, bolt or grpc: a TCP endpoint, reachable from outside over TLS

mode'public' | 'private'

Left out, the URL keeps the mode it has; a first URL is public

rotateboolean

A new token for a private URL: old links and cookies stop working. Refused for a public URL

Response

ok

idstring required
portnumber required
protocol'http' | 'postgres' | 'mysql' | 'redis' | 'mongodb' | 'amqp' | 'bolt' | 'grpc'

A database protocol: a TCP endpoint, reachable from outside over TLS; absent: a URL

mode'public' | 'private' required
urlstring required

The URL to share; a private URL carries its token. A TCP endpoint: its connection string without the password

hostnamestring required
connectionStringstring

A TCP endpoint: the connection string, TLS required; a recipe's carries its password

credentialsstring

What the connection string cannot carry: a user, an API key

warningstring

The machine restarted to deliver this port, or the URL moved here from another

Changes

No recorded changes to this operation across all 2 revisions of this API.