List additional domains (aliases) for the site

get https://api.rocket.net/v1/sites/{id}/domains

Get additional domains for given site

Responses

Response body

object

success

boolean

whether the request succeeded

errors

array of strings | null

ErrorsEmpty

messages

array of strings | null

MessagesEmpty

metadata

object

page

integer

Page number of the results

page_size

integer

Number of results per page

total

integer

Total number of results

sort

string

Sorting criteria

direction

string

Sorting direction

asc desc

result

object

additional_domains

array of objects

additional_domains

object

integer

ID of the additional domain

active_wordpress_domain

string

The name of the domain which is active in WordPress (WordPress can only have one domain)

cdn_url live_domain

base_domain

string

Base domain without any subdomains. Example is for sub.domain.tld

display_domain

string

Full domain name of the domain (UTF-8 characters present)

domain

string

Full domain name of the domain (UTF-8 converted to punycode)

domain_type

string

Type of domain (normal = apex [i.e. domain.tld], subdomain = subdomain other than www, www = www.$domain)

normal subdomain www

dns_provider

string

Where the DNS records for the domain live

hostname_status

string

Status of the domain (moved will require re-creation by changing the domain)

active active_redeploying blocked deleted moved pending pending_blocked pending_deletion pending_migration pending_provisioned provisioned test_active test_active_apex test_blocked test_failed test_pending

ssl_status

string

Status of the SSL Cert (pending_validation when DNS cannot be validated, active when live)

active backup_issued deactivating deleted deletion_timed_out deployment_timed_out expired holding_deployment inactive initializing initializing_timed_out issuance_timed_out pending_cleanup pending_deletion pending_deployment pending_expiration pending_issuance pending_validation staging_active staging_deployment validation_timed_out

show_go_live

integer

If the UI should show Go Live instructions

1

sub_domain

string

If this domain is a sub-domain this will be the sub-domain value. Otherwise it will be the domain without TLD. Example is for sub.domain.tld

validation_method

string

Validation method to use (http = http, txt = DNS)

http txt

validation_records

array of objects

validation_records

object

type

string

Type of DNS record

a cname txt

name

string

Name of the DNS record

value

string

Value of the DNS record

status

string

Status of the domain (pending_validation when DNS cannot be validated, active when live)

active active_redeploying backup_issued blocked deactivating deleted deletion_timed_out deployment_timed_out expired holding_deployment inactive initializing initializing_timed_out issuance_timed_out moved pending pending_blocked pending_cleanup pending_deletion pending_deployment pending_expiration pending_issuance pending_migration pending_provisioned pending_validation provisioned staging_active staging_deployment test_active test_active_apex test_blocked test_failed test_pending validation_timed_out

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.rocket.net/v1/sites/id/domains?page=1&per_page=100' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

401Authentication failed

403Not authorized to access endpoint

404Given site not found for user

405Invalid input

500Internal error