Custom domains
GET https://virtualeyes.io/api/domains/
curl --request GET \
--url 'https://virtualeyes.io/api/domains/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://virtualeyes.io/api/domains/' \
--header 'Authorization: Bearer {api_key}' \
| Parameters | Details | Description |
|---|---|---|
| page | Optional Integer | The page number that you want results from. Defaults to 1. |
| results_per_page | Optional Integer | How many results you want per page. Allowed values are: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Defaults to 25. |
{
"data": [
{
"id": 1,
"scheme": "https://",
"host": "example.com",
"custom_index_url": "",
"is_enabled": true,
"last_datetime": null,
"datetime": "2021-02-04 23:29:18"
},
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://virtualeyes.io/api/domains?&page=1",
"last": "https://virtualeyes.io/api/domains?&page=1",
"next": null,
"prev": null,
"self": "https://virtualeyes.io/api/domains?&page=1"
}
}
GET https://virtualeyes.io/api/domains/{domain_id}
curl --request GET \
--url 'https://virtualeyes.io/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://virtualeyes.io/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}' \
{
"data": {
"id": 1,
"scheme": "https://",
"host": "example.com",
"custom_index_url": "",
"is_enabled": true,
"last_datetime": null,
"datetime": "2021-02-04 23:29:18"
}
}
POST https://virtualeyes.io/api/domains
| Parameters | Details | Description |
|---|---|---|
| host | Required String | - |
| custom_index_url | Optional String | - |
| custom_not_found_url | Optional String | - |
curl --request POST \
--url 'https://virtualeyes.io/api/domains' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=domain.com' \
--form 'custom_index_url=https://mywebsite.com/' \
--form 'custom_not_found_url=https://mywebsite.com/404-page'
--url 'https://virtualeyes.io/api/domains' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=domain.com' \
--form 'custom_index_url=https://mywebsite.com/' \
--form 'custom_not_found_url=https://mywebsite.com/404-page'
{
"data": {
"id": 1
}
}
POST https://virtualeyes.io/api/domains/{domain_id}
| Parameters | Details | Description |
|---|---|---|
| host | Optional String | - |
| custom_index_url | Optional String | - |
| custom_not_found_url | Optional String | - |
curl --request POST \
--url 'https://virtualeyes.io/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=domain.com' \
--url 'https://virtualeyes.io/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=domain.com' \
{
"data": {
"id": 1
}
}
DELETE https://virtualeyes.io/api/domains/{domain_id}
curl --request DELETE \
--url 'https://virtualeyes.io/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://virtualeyes.io/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}' \