List Domains

GET

/tenant/{tenantId}/domain

const url = 'https://api.exolink.cloud/tenant/example/domain';
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://api.exolink.cloud/tenant/example/domain \
  --header 'Authorization: Bearer <token>'

Get the tenant’s custom domain configuration. A tenant may own many domains, so this always returns a list - an empty one when none are configured. Domains being removed are listed with state REMOVING.

Authorizations

bearerToken

Parameters

Path Parameters

tenantId

required

string

Tenant domain prefix

Responses

200

Domain configurations

application/json

Array<object>

Custom domain configuration

object

Domain ID

integer

tenantId

Tenant ID

integer

domainName

Custom domain name

string

domainValue

Target of the CNAME record the domain has to point to

string

domainVerified

Whether the domain points to domainValue

boolean

sslName

Name of the DNS record validating the certificate

string

nullable

sslValue

Value of the DNS record validating the certificate

string

nullable

sslVerified

Whether the certificate is validated

boolean

state

Domain verification and setup state

string

Allowed values: PREPARING PENDING COMPLETE REMOVING FAILED

createdAt

string format: date-time

updatedAt

string format: date-time

deletedAt

string format: date-time

nullable

Example

[
  {
    "domainName": "chargers.company.com",
    "domainValue": "abc123.broker.exolink.cloud",
    "state": "PREPARING"
  }
]

401

Missing, invalid or expired credentials

application/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

Allowed values: ERR_API_BAD_REQUEST ERR_API_NOT_AUTHORIZED ERR_API_PAYMENT_REQUIRED ERR_API_FORBIDDEN ERR_API_RESOURCE_NOT_FOUND ERR_API_RESOURCE_IN_USE ERR_API_RESOURCE_ALREADY_EXISTS ERR_API_UNEXPECTED_STATE ERR_API_CONTENT_TOO_LARGE ERR_API_VALIDATION_FAILED ERR_API_VERIFICATION_FAILED ERR_API_NO_TENANT ERR_API_INVALID_INVITATION ERR_API_USER_DISABLED ERR_API_FAILED_DEPENDENCY ERR_EXOLINK_GENERIC

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "Not authorized",
  "errorCode": "ERR_API_NOT_AUTHORIZED"
}

403

The caller may not perform this action

application/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "Forbidden",
  "errorCode": "ERR_API_FORBIDDEN"
}