Retrieve a custom domain

Retrieve a custom domain with specified identifier string.

SecuritySecretApiKey or JWT
Request
path Parameters
domain
required
string <= 255 characters ^[@~\-\.\w]+$

Resource domain.

Responses
200

Custom domain retrieved.

Response Schema: application/json
domain
required
string <= 255 characters

Fully qualified domain name.

id
string <= 255 characters

ID of the custom domain.

isVerified
boolean

True if the domain is verified by Rebilly.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (Self) non-empty

Related resource links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/custom-domains/{domain}
Request samples
Response samples
application/json
{
  • "id": "string",
  • "domain": "string",
  • "isVerified": true,
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}