/setup

GET

/setup

const url = 'https://example.com/api/v1/setup';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/setup \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Responses

200

Default Response

application/json

One of:

object
object

object

state

required

string

Allowed values: pending

version

required

string

steps

required

object

hostname

required

boolean

tls

required

boolean

domain

required

boolean

owner

required

boolean

hostname

required

Any of:

string
null

string

tlsMode

required

Any of:

string
null

string

Allowed values: acme byo none

domain

required

Any of:

string
null

string

ownerEmail

required

Any of:

string
null

string

pop3

required

boolean

publicBind

required

boolean

Example

{
  "state": "pending",
  "tlsMode": "acme"
}