Custom domains

Retrieve a list of custom domains

Retrieve a list of custom domains.

Request
Security:
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

q
string

The partial search of the text fields.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

A list of custom domains was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/custom-domains
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/custom-domains?limit=1000&offset=0&sort=string&filter=string&q=string' \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Create a custom domain

Create a custom domain.

Request
Security:
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json
domain
required
string <= 255 characters

The fully qualified domain name.

Responses
201

Custom domain was created.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

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

Retrieve a custom domain

Retrieve a custom domain with specified identifier string.

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

The resource domain.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Custom domain was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/custom-domains/{domain}
Request samples
curl -i -X GET \
  https://api-sandbox.rebilly.com/organizations/unknown/custom-domains/:domain \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "domain": "string",
  • "isVerified": true,
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z"
}

Delete a custom domain

Delete a custom domain with predefined identifier string.

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

The resource domain.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
204

Custom domains was deleted.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

delete/custom-domains/{domain}
Request samples
curl -i -X DELETE \
  https://api-sandbox.rebilly.com/organizations/unknown/custom-domains/:domain \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": 400,
  • "title": "string",
  • "detail": "string",
  • "error": "string"
}