Simple Hosting API
https://api.gandi.net/v5/simplehosting/
Introduction ¶
This section of our documentation will assist you in the management of Simple Hosting instances at Gandi.net through our REST API.
Documentation on our XML-RPC API can be found at https://doc.rpc.gandi.net
General information on Gandi's Simple Hosting services can be found in our public documentation at:
https://docs.gandi.net/en/simple_hosting
Simple Hosting applications list ¶
https://api.gandi.net/v5/simplehosting/applications
get List Simple Hosting applications ¶
Request
Query String
Optional
- database ⁠stringFilters the list with the database they can use, with optional patterns.Example:
mysql
Example:pg*
- language ⁠stringFilters the list by the language they use, with optional patterns.Example:
php
Example:py*
- name ⁠stringFilters the list by application name, with optional patterns.Example:
nextcloud
Example:mato*
Example:*press
- page ⁠integer
Default: 1
Minimum: 1
Which result page to retrieve. If the number is greater than the last page, an empty list is returned. - per_page ⁠integer
Minimum: 1
How many items to display per page. - sharing_id ⁠stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- sort_by ⁠string
Default: "-created_at"
Indicate the field used to sort the results. The field's name may start with-
to reverse the order.
- database ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Headers
- Total-Count ⁠integerTotal number of items.
Optional
- Link ⁠stringLinks to next and last page.
- Total-Count ⁠integer
Body
application/json
⁠arrayOf items of type:
- object
With the following properties:
- name ⁠string
- name_label ⁠string
- requirements ⁠array
Of items of type:
- object
With the following properties:
- database ⁠objectDatabase supported by the application
With the following properties:
- name ⁠string
- status ⁠string
- version ⁠string
- instance_minimum_size ⁠stringMinimum required PaaS size for this application
- language ⁠objectLanguage used by the application
With the following properties:
- name ⁠string
- single_application ⁠boolean
true
if the application must be the only vhost of the instance - status ⁠string
- version ⁠string
- database ⁠object
- object
- object
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Authentication with API Key
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Simple Hosting application information ¶
https://api.gandi.net/v5/simplehosting/applications/{application_name}
get Application details ¶
Request
URI Parameters
- application_name ⁠stringName of an application.
- application_name ⁠string
Responses
200
Body
application/json
⁠objectWith the following properties:
- name ⁠string
- name_label ⁠string
- requirements ⁠array
Of items of type:
- object
With the following properties:
- database ⁠objectDatabase supported by the application
With the following properties:
- name ⁠string
- status ⁠string
- version ⁠string
- instance_minimum_size ⁠stringMinimum required PaaS size for this application
- language ⁠objectLanguage used by the application
With the following properties:
- name ⁠string
- single_application ⁠boolean
true
if the application must be the only vhost of the instance - status ⁠string
- version ⁠string
- database ⁠object
- object
Simple Hosting instances list ¶
https://api.gandi.net/v5/simplehosting/instances
get List Simple Hosting instances ¶
Request
Query String
Optional
- fqdn ⁠stringFilters the list by vhost domain name, with optional patterns.
The FQDN must be encoded in ASCII form (Punycode).Example:example.net
Example:example.*
Example:*example.com
- name ⁠stringFilters the list by instance name, with optional patterns.Example:
example
Example:examp*
Example:*mple
- page ⁠integer
Default: 1
Minimum: 1
Which result page to retrieve. If the number is greater than the last page, an empty list is returned. - per_page ⁠integer
Minimum: 1
How many items to display per page. - sharing_id ⁠stringSharing ID. Organization ID used as a filter or as a billing identifier. See the reference.
- size ⁠string
One of: "s", "s+", "m", "l", "xl", "xxl"
Filters the list by instance size. - sort_by ⁠string
Default: "-created_at"
Indicate the field used to sort the results. The field's name may start with-
to reverse the order. - status ⁠string
One of: "waiting_bill", "being_created", "active", "paused", "locked", "being_deleted"
Filters the list by instance status.
- fqdn ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Headers
- Total-Count ⁠integerTotal number of items.
Optional
- Link ⁠stringLinks to next and last page.
- Total-Count ⁠integer
Body
application/json
⁠arrayOf items of type:
- object
With the following properties:
- available_upgrade ⁠boolean
- created_at ⁠datetime
- database ⁠object
With the following properties:
- name ⁠string
- status ⁠string
- version ⁠string
- datacenter ⁠object
With the following properties:
- code ⁠string
One of: "FR-SD3", "FR-SD5", "FR-SD6", "LU-BI1"
- name ⁠string
- region ⁠string
One of: "FR", "LU"
- code ⁠string
- expire_at ⁠datetime
- id ⁠stringUUID
- language ⁠object
With the following properties:
- name ⁠string
- single_application ⁠boolean
true
if the application must be the only vhost of the instance - status ⁠string
- version ⁠string
- name ⁠string
- sharing_space ⁠object
With the following properties:
- id ⁠stringUUID
Optional
- name ⁠string
- id ⁠string
- size ⁠string
One of: "s", "s+", "m", "l", "xl", "xxl"
- snapshot_enabled ⁠boolean
- status ⁠string
One of: "waiting_bill", "being_created", "active", "paused", "locked", "being_deleted"
- storage ⁠object
With the following properties:
- additional ⁠object
With the following properties:
- unit ⁠string
One of: "GB"
- value ⁠integer
- unit ⁠string
- base ⁠object
With the following properties:
- unit ⁠string
One of: "GB"
- value ⁠integer
- unit ⁠string
- total ⁠object
With the following properties:
- unit ⁠string
One of: "GB"
- value ⁠integer
- unit ⁠string
- additional ⁠object
Optional
- autorenew ⁠object
With the following properties:
- duration ⁠integer
- duration_type ⁠string
One of: "m"
- password_updated_at ⁠datetimeLast password update date. Only present if a password is set.
- object
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Authentication with API Key
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Simple Hosting instance information ¶
https://api.gandi.net/v5/simplehosting/instances/{instance_id}
get Instance details ¶
Request
URI Parameters
- instance_id ⁠stringUUID of an instance.
- instance_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Body
application/json
⁠objectWith the following properties:
- access_information ⁠object
With the following properties:
- admin_url ⁠string
- database ⁠object
With the following properties:
- admins ⁠array
Of items of type:
- object
With the following properties:
- type ⁠string
One of: "phpMyAdmin", "phpPgAdmin", "Adminer"
- url ⁠string
Optional
- username ⁠string
- type ⁠string
- object
- host ⁠string
Optional
- port ⁠integerIn case the database listens to an inet-type socket this field will contain the port number used by the database
- socket ⁠stringIn the event this database listens to a UNIX-type socket this field will contain the path of the socket
- admins ⁠array
- deploy ⁠array
Of items of type:
- object
With the following properties:
- cli ⁠object
With the following properties:
- init ⁠string
- git ⁠object
With the following properties:
- deploy ⁠string
- remote ⁠string
- url ⁠string
- sftp ⁠object
With the following properties:
- directory ⁠stringDirectory relative to the SFTP root where the vhost is located.
- document_root ⁠stringDirectory relative to the SFTP root where the root of the exposed vhost is located.
- server ⁠string
- url ⁠string
- directory ⁠string
- vhost ⁠object
With the following properties:
- fqdn ⁠stringFQDN linked to the vhost in ASCII (Punycode) format.
- href ⁠stringLink to vhost details
- fqdn ⁠string
- cli ⁠object
- object
- user ⁠string
- available_upgrade ⁠boolean
- console ⁠objectThe emergency console is a serial-like console you can access via SSH.
With the following properties:
- enabled ⁠boolean
- url ⁠string
- created_at ⁠datetime
- database ⁠object
With the following properties:
- name ⁠string
- status ⁠string
- version ⁠string
- datacenter ⁠object
With the following properties:
- code ⁠string
One of: "FR-SD3", "FR-SD5", "FR-SD6", "LU-BI1"
- name ⁠string
- region ⁠string
One of: "FR", "LU"
- code ⁠string
- expire_at ⁠datetime
- id ⁠stringUUID
- is_trial ⁠boolean
- language ⁠object
With the following properties:
- name ⁠string
- single_application ⁠boolean
true
if the application must be the only vhost of the instance - status ⁠string
- version ⁠string
- name ⁠string
- sharing_space ⁠object
With the following properties:
- id ⁠stringUUID
Optional
- name ⁠string
- id ⁠string
- size ⁠string
One of: "s", "s+", "m", "l", "xl", "xxl"
- snapshot_enabled ⁠boolean
- status ⁠string
One of: "waiting_bill", "being_created", "active", "paused", "locked", "being_deleted"
- storage ⁠object
With the following properties:
- additional ⁠object
With the following properties:
- unit ⁠string
One of: "GB"
- value ⁠integer
- unit ⁠string
- base ⁠object
With the following properties:
- unit ⁠string
One of: "GB"
- value ⁠integer
- unit ⁠string
- total ⁠object
With the following properties:
- unit ⁠string
One of: "GB"
- value ⁠integer
- unit ⁠string
- additional ⁠object
- vhosts ⁠array
Of items of type:
- object
With the following properties:
- fqdn ⁠stringFQDN linked to the vhost in ASCII (Punycode) format.
- href ⁠stringLink to vhost details
- fqdn ⁠string
- object
Optional
- autorenew ⁠object
With the following properties:
- duration ⁠integer
- duration_type ⁠string
One of: "m"
- compatible_applications ⁠array
Of items of type:
- object
With the following properties:
- name ⁠string
Optional
- parameters ⁠object
- object
- password_updated_at ⁠datetimeLast password update date. Only present if a password is set.
- upgrade_to ⁠array
Of items of type:
- object
With the following properties:
- name ⁠string
- status ⁠string
- type ⁠stringIndicate whether the available upgrade is a database or a language upgrade.
- version ⁠string
- object
- access_information ⁠object
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Authentication with API Key
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Simple Hosting instance actions ¶
https://api.gandi.net/v5/simplehosting/instances/{instance_id}/action
post Perform an action on the instance ¶
Request
URI Parameters
- instance_id ⁠stringUUID of an instance.
- instance_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Body
application/json
⁠objectWith the following properties:
Required
- action ⁠string
One of: "restart", "console", "reset_database_password"
- action ⁠string
Responses
202
Headers
- Content-Location ⁠stringLink to the instance on which the action is taken
- Content-Location ⁠string
Body
application/json
⁠objectWith the following properties:
- message ⁠stringConfirmation message.
- message ⁠string
204
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Authentication with API Key
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Simple Hosting instance vhost list and create ¶
https://api.gandi.net/v5/simplehosting/instances/{instance_id}/vhosts
get List vhosts ¶
Request
URI Parameters
- instance_id ⁠stringUUID of an instance.
- instance_id ⁠string
Query String
Optional
- fqdn ⁠stringFilters the list by vhost domain name, with optional patterns.
The FQDN must be encoded in ASCII form (Punycode).Example:example.net
Example:example.*
Example:*example.com
- page ⁠integer
Default: 1
Minimum: 1
Which result page to retrieve. If the number is greater than the last page, an empty list is returned. - per_page ⁠integer
Minimum: 1
How many items to display per page. - sort_by ⁠string
Default: "-created_at"
Indicate the field used to sort the results. The field's name may start with-
to reverse the order. - status ⁠string
One of: "being_created", "running", "being_deleted", "locked", "waiting_ownership", "ownership_validated", "validation_failed"
Filters the list by vhost status.
- fqdn ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Headers
- Total-Count ⁠integerTotal number of items.
Optional
- Link ⁠stringLinks to next and last page.
- Total-Count ⁠integer
Body
application/json
⁠arrayOf items of type:
- object
With the following properties:
- created_at ⁠datetime
- fqdn ⁠stringFQDN linked to the vhost in ASCII (Punycode) format.
- is_a_test_vhost ⁠booleanTrue if the vhost is intended for testing purposes only.
- linked_dns_zone ⁠objectThis field contains information on the DNS zone the vhost is linked to.
With the following properties:
- allow_alteration ⁠booleanTrue if you authorized Gandi to modify your DNS zone so that your vhost points to our Simple Hosting public endpoints. If set to True and your DNS zone is managed by our liveDNS platform, you will not have to manually change your DNS configuration to validate your vhost ownership. Check last_checked_status to validate.
- last_checked_status ⁠string
One of: "altered", "livedns_conflict", "livedns_done", "livedns_error", "unknown"
DNS zone validity when last checked
Optional
- last_checked_at ⁠datetimeDate of the last check for zone validity
- allow_alteration ⁠boolean
- status ⁠string
One of: "being_created", "running", "being_deleted", "locked", "waiting_ownership", "ownership_validated", "validation_failed"
Optional
- application ⁠object
With the following properties:
- name ⁠string
Optional
- parameters ⁠object
- certificates ⁠array
Of items of type:
- object
With the following properties:
- href ⁠string
- id ⁠string
- pending ⁠boolean
- object
- https_strategy ⁠string
One of: "HTTP_only", "allow_HTTP_and_HTTPS", "redirect_HTTP_to_HTTPS"
Describes the strategy used regarding secure connection to your vhost (HTTP/HTTPS). This field is only present if you have a certificate.
- object
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Authentication with API Key
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
post Create a new vhost ¶
Request
URI Parameters
- instance_id ⁠stringUUID of an instance.
- instance_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Body
application/json
⁠objectWith the following properties:
Required
- fqdn ⁠stringfqdn of the vhost.
Optional
- application ⁠object
With the following properties:
Required
- name ⁠string
Optional
- parameters ⁠object
- linked_dns_zone ⁠object
With the following properties:
Required
- allow_alteration ⁠booleanTrue if you authorized Gandi to modify your DNS zone so that your vhost points to our Simple Hosting public endpoints. If set to True and your DNS zone is managed by our liveDNS platform, you will not have to manually change your DNS configuration to validate your vhost ownership. Check last_checked_status to validate.
Optional
- allow_alteration_override ⁠boolean
Default: false
True to override your DNS zone if there already is a record on your vhost fqdn.
- allow_alteration ⁠boolean
- fqdn ⁠string
Responses
202
Headers
- Content-Location ⁠stringLink to the new vhost.
- Content-Location ⁠string
Body
application/json
⁠objectWith the following properties:
- fqdn ⁠stringfqdn of the vhost.
- https_strategy ⁠string
One of: "HTTP_only", "allow_HTTP_and_HTTPS", "redirect_HTTP_to_HTTPS"
Describes the strategy used regarding secure connection to your vhost (HTTP/HTTPS). This field is only present if you have a certificate. - linked_dns_zone ⁠object
With the following properties:
- allow_alteration ⁠booleanTrue if you authorized Gandi to modify your DNS zone so that your vhost points to our Simple Hosting public endpoints. If set to True and your DNS zone is managed by our liveDNS platform, you will not have to manually change your DNS configuration to validate your vhost ownership. Check last_checked_status to validate.
- last_checked_status ⁠string
One of: "altered", "livedns_conflict", "livedns_done", "livedns_error", "unknown"
DNS zone validity when last checked
- allow_alteration ⁠boolean
- status ⁠string
One of: "being_created", "running", "being_deleted", "locked", "waiting_ownership", "ownership_validated", "validation_failed"
- fqdn ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
422
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Authentication with API Key
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Simple Hosting vhost information ¶
https://api.gandi.net/v5/simplehosting/instances/{instance_id}/vhosts/{vhost_fqdn}
get Vhost details ¶
Request
URI Parameters
- instance_id ⁠stringUUID of an instance.
- vhost_fqdn ⁠stringfqdn of a vhost.
- instance_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Body
application/json
⁠objectWith the following properties:
- created_at ⁠datetime
- fqdn ⁠stringFQDN linked to the vhost in ASCII (Punycode) format.
- is_a_test_vhost ⁠booleanTrue if the vhost is intended for testing purposes only.
- linked_dns_zone ⁠objectThis field contains information on the DNS zone the vhost is linked to.
With the following properties:
- allow_alteration ⁠booleanTrue if you authorized Gandi to modify your DNS zone so that your vhost points to our Simple Hosting public endpoints. If set to True and your DNS zone is managed by our liveDNS platform, you will not have to manually change your DNS configuration to validate your vhost ownership. Check last_checked_status to validate.
- allow_alteration ⁠booleanTrue if you authorized Gandi to modify your DNS zone so that your vhost points to our Simple Hosting public endpoints. If set to True and your DNS zone is managed by our liveDNS platform, you will not have to manually change your DNS configuration to validate your vhost ownership. Check last_checked_status to validate.
- cname ⁠stringCanonical name of the web accelerator hosting your vhost. You need this if the vhost is not the apex (top level) of your zone
- domain ⁠stringFQDN of the zone to which you need to apply the DNS records
- ipv4 ⁠stringIPv4 pointing to the web accelerator hosting your vhost. You only need this if the vhost is at the root of your zone
- ipv6 ⁠stringIPv6 pointing to the web accelerator hosting your vhost. You only need this if the vhost is at the root of your zone
- is_alterable ⁠booleanTrue if the zone can be automatically managed by Simple Hosting
- is_root ⁠booleanTrue if the vhost is on the root of the zone. It means you have to add A and AAAA entries to your zone rather than a CNAME.
- key ⁠stringThe name associated with the entries to add to your zone, if the vhost is the root of your zone it should be
@
. - last_checked_status ⁠string
One of: "altered", "livedns_conflict", "livedns_done", "livedns_error", "unknown"
DNS zone validity when last checked - last_checked_status ⁠string
One of: "altered", "livedns_conflict", "livedns_done", "livedns_error", "unknown"
DNS zone validity when last checked - txt ⁠stringTXT entry that needs to be present in your DNS zone to validate domain ownership.
Optional
- last_checked_at ⁠datetimeDate of the last check for zone validity
- last_checked_at ⁠datetimeDate of the last check for zone validity
- allow_alteration ⁠boolean
- status ⁠string
One of: "being_created", "running", "being_deleted", "locked", "waiting_ownership", "ownership_validated", "validation_failed"
Optional
- application ⁠object
With the following properties:
- name ⁠string
- name ⁠string
- status ⁠string
One of: "error", "running", "being_created", "cancelled"
Optional
- parameters ⁠object
- parameters ⁠object
- certificates ⁠array
Of items of type:
- object
With the following properties:
- href ⁠string
- id ⁠string
- pending ⁠boolean
- object
- https_strategy ⁠string
One of: "HTTP_only", "allow_HTTP_and_HTTPS", "redirect_HTTP_to_HTTPS"
Describes the strategy used regarding secure connection to your vhost (HTTP/HTTPS). This field is only present if you have a certificate.
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Authentication with API Key
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
patch Update a vhost ¶
Request
URI Parameters
- instance_id ⁠stringUUID of an instance.
- vhost_fqdn ⁠stringfqdn of a vhost.
- instance_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Body
application/json
⁠objectWith the following properties:
Optional
- application ⁠object
With the following properties:
Required
- name ⁠string
Optional
- parameters ⁠object
- https_strategy ⁠string
One of: "HTTP_only", "allow_HTTP_and_HTTPS", "redirect_HTTP_to_HTTPS"
Describes the strategy used regarding secure connection to your vhost (HTTP/HTTPS). This field is only present if you have a certificate. - linked_dns_zone ⁠object
With the following properties:
Required
- allow_alteration ⁠booleanTrue if you authorized Gandi to modify your DNS zone so that your vhost points to our Simple Hosting public endpoints. If set to True and your DNS zone is managed by our liveDNS platform, you will not have to manually change your DNS configuration to validate your vhost ownership. Check last_checked_status to validate.
Optional
- allow_alteration_override ⁠boolean
Default: false
True to override your DNS zone if there already is a record to link your instance to your vhost fqdn.
- allow_alteration ⁠boolean
- application ⁠object
Responses
200
Body
application/json
⁠objectWith the following properties:
- fqdn ⁠stringfqdn of the vhost.
- https_strategy ⁠string
One of: "HTTP_only", "allow_HTTP_and_HTTPS", "redirect_HTTP_to_HTTPS"
Describes the strategy used regarding secure connection to your vhost (HTTP/HTTPS). This field is only present if you have a certificate. - linked_dns_zone ⁠object
With the following properties:
- allow_alteration ⁠booleanTrue if you authorized Gandi to modify your DNS zone so that your vhost points to our Simple Hosting public endpoints. If set to True and your DNS zone is managed by our liveDNS platform, you will not have to manually change your DNS configuration to validate your vhost ownership. Check last_checked_status to validate.
- last_checked_status ⁠string
One of: "altered", "livedns_conflict", "livedns_done", "livedns_error", "unknown"
DNS zone validity when last checked
- allow_alteration ⁠boolean
- status ⁠string
One of: "being_created", "running", "being_deleted", "locked", "waiting_ownership", "ownership_validated", "validation_failed"
- fqdn ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Authentication with API Key
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
delete Delete a vhost ¶
Request
URI Parameters
- instance_id ⁠stringUUID of an instance.
- vhost_fqdn ⁠stringfqdn of a vhost.
- instance_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Responses
204
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Authentication with API Key
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string