Custom domains

Retrieve all

GET https://qrcode.co.uk/api/domains/
curl --request GET \
--url 'https://qrcode.co.uk/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://qrcode.co.uk/api/domains?&page=1", "last": "https://qrcode.co.uk/api/domains?&page=1", "next": null, "prev": null, "self": "https://qrcode.co.uk/api/domains?&page=1" } }

Retrieve one

GET https://qrcode.co.uk/api/domains/{domain_id}
curl --request GET \
--url 'https://qrcode.co.uk/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" } }

Create

POST https://qrcode.co.uk/api/domains
Parameters Details Description
host Required String -
custom_index_url Optional String -
custom_not_found_url Optional String -
curl --request POST \
--url 'https://qrcode.co.uk/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 } }

Update

POST https://qrcode.co.uk/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://qrcode.co.uk/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=domain.com' \
{ "data": { "id": 1 } }

Delete

DELETE https://qrcode.co.uk/api/domains/{domain_id}
curl --request DELETE \
--url 'https://qrcode.co.uk/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}' \