Skip to navigation

Set

Serve an app on this hostname, in place of any it had. One hostname serves one app of one workspace, and every app is served on it with clean paths. On Go Links’ hostname the console is at /, and any other path is a link’s name, followed by whoever the link’s access lets in (see /golinks). Requires appDomains:write. Errors: 422 invalid_hostname, 422 own_hostname, 409 hostname_taken, 409 hostname_in_use, 502 domain_setup_failed (our host would not take it: nothing was saved).

Authentication

AuthorizationBearer

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

Path parameters

appSlugstringRequired

Request

This endpoint expects an object.
hostnamestringRequired

The bare host, such as go.acme.com. A scheme, port or path pasted with it is dropped.

Response

This endpoint returns an object.
appSlugstring
hostnamestring
statusenum
How far along a hostname is, in the order it gets there.
recordslist of objects

What DNS needs for it, as our host recommends it now. Still listed once ready, though nothing is left to do: the app shows the record only until then. Empty when the state is missing, error or unknown, when our host has nothing to say.

messagestringOptional

Errors

403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Validation Error
429
Too Many Requests Error
502
Upstream Error