Simple Hosting API

Query String

• Optional

  • fqdn ⁠string
    Filters 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 ⁠string
    Filters 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 ⁠string
    Sharing 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.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Apikey, followed by the user's API Key.
    Example: Apikey your-api-key

Headers

• • Total-Count ⁠integer
    Total number of items.

  Optional

  • Link ⁠string
    Links to next and last page.

Body

• application/json

  ⁠array

  Of 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"

    • expire_at ⁠datetime
    • id ⁠string
      UUID
    • language ⁠object

      With the following properties:

      • name ⁠string
      • single_application ⁠boolean
      • status ⁠string
      • version ⁠string
    • name ⁠string
    • sharing_space ⁠object

      With the following properties:

      • id ⁠string
        UUID

      Optional

      • name ⁠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
      • base ⁠object

        With the following properties:

        • unit ⁠string

          One of: "GB"

        • value ⁠integer
      • total ⁠object

        With the following properties:

        • unit ⁠string

          One of: "GB"

        • value ⁠integer

    Optional

    • autorenew ⁠object

      With the following properties:

      • duration ⁠integer
      • duration_type ⁠string

        One of: "m"

    • password_updated_at ⁠datetime
      Last password update date. Only present if a password is set.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • instance_id ⁠string
    UUID of an instance.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Apikey, followed by the user's API Key.
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With 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
      • host ⁠string

      Optional

      • port ⁠integer
        In case the database listens to an inet-type socket this field will contain the port number used by the database
      • socket ⁠string
        In the event this database listens to a UNIX-type socket this field will contain the path of the socket
    • 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 ⁠string
            Directory relative to the SFTP root where the vhost is located.
          • document_root ⁠string
            Directory relative to the SFTP root where the root of the exposed vhost is located.
          • server ⁠string
          • url ⁠string
        • vhost ⁠object

          With the following properties:

          • fqdn ⁠string
            FQDN linked to the vhost in ASCII (Punycode) format.
          • href ⁠string
            Link to vhost details
    • user ⁠string
  • available_upgrade ⁠boolean
  • console ⁠object
    The 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"

  • expire_at ⁠datetime
  • id ⁠string
    UUID
  • is_trial ⁠boolean
  • language ⁠object

    With the following properties:

    • name ⁠string
    • single_application ⁠boolean
    • status ⁠string
    • version ⁠string
  • name ⁠string
  • sharing_space ⁠object

    With the following properties:

    • id ⁠string
      UUID

    Optional

    • name ⁠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
    • base ⁠object

      With the following properties:

      • unit ⁠string

        One of: "GB"

      • value ⁠integer
    • total ⁠object

      With the following properties:

      • unit ⁠string

        One of: "GB"

      • value ⁠integer
  • vhosts ⁠array

    Of items of type:

    • object

      With the following properties:

      • fqdn ⁠string
        FQDN linked to the vhost in ASCII (Punycode) format.
      • href ⁠string
        Link to vhost details

  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
  • password_updated_at ⁠datetime
    Last 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 ⁠string
        Indicate whether the available upgrade is a database or a language upgrade.
      • version ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • instance_id ⁠string
    UUID of an instance.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Apikey, followed by the user's API Key.
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  Required

  • action ⁠string

    One of: "restart", "console", "reset_database_password"

Headers

• • Content-Location ⁠string
    Link to the instance on which the action is taken

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • instance_id ⁠string
    UUID of an instance.

Query String

• Optional

  • fqdn ⁠string
    Filters 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.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Apikey, followed by the user's API Key.
    Example: Apikey your-api-key

Headers

• • Total-Count ⁠integer
    Total number of items.

  Optional

  • Link ⁠string
    Links to next and last page.

Body

• application/json

  ⁠array

  Of items of type:

  • object

    With the following properties:

    • created_at ⁠datetime
    • fqdn ⁠string
      FQDN linked to the vhost in ASCII (Punycode) format.
    • is_a_test_vhost ⁠boolean
      True if the vhost is intended for testing purposes only.
    • linked_dns_zone ⁠object
      This field contains information on the DNS zone the vhost is linked to.

      With the following properties:

      • allow_alteration ⁠boolean
        True 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 ⁠datetime
        Date of the last check for zone validity
    • 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
    • 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.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • instance_id ⁠string
    UUID of an instance.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Apikey, followed by the user's API Key.
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  Required

  • fqdn ⁠string
    fqdn 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 ⁠boolean
      True 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.

Headers

• • Content-Location ⁠string
    Link to the new vhost.

Body

• application/json

  ⁠object

  With the following properties:

  • fqdn ⁠string
    fqdn 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 ⁠boolean
      True 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
  • status ⁠string

    One of: "being_created", "running", "being_deleted", "locked", "waiting_ownership", "ownership_validated", "validation_failed"

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • instance_id ⁠string
    UUID of an instance.
  • vhost_fqdn ⁠string
    fqdn of a vhost.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Apikey, followed by the user's API Key.
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  • created_at ⁠datetime
  • fqdn ⁠string
    FQDN linked to the vhost in ASCII (Punycode) format.
  • is_a_test_vhost ⁠boolean
    True if the vhost is intended for testing purposes only.
  • linked_dns_zone ⁠object
    This field contains information on the DNS zone the vhost is linked to.

    With the following properties:

    • allow_alteration ⁠boolean
      True 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 ⁠boolean
      True 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 ⁠string
      Canonical name of the web accelerator hosting your vhost. You need this if the vhost is not the apex (top level) of your zone
    • domain ⁠string
      FQDN of the zone to which you need to apply the DNS records
    • ipv4 ⁠string
      IPv4 pointing to the web accelerator hosting your vhost. You only need this if the vhost is at the root of your zone
    • ipv6 ⁠string
      IPv6 pointing to the web accelerator hosting your vhost. You only need this if the vhost is at the root of your zone
    • is_alterable ⁠boolean
      True if the zone can be automatically managed by Simple Hosting
    • is_root ⁠boolean
      True 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 ⁠string
      The 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 ⁠string
      TXT entry that needs to be present in your DNS zone to validate domain ownership.

    Optional

    • last_checked_at ⁠datetime
      Date of the last check for zone validity
    • last_checked_at ⁠datetime
      Date of the last check for zone validity
  • 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
  • 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.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • instance_id ⁠string
    UUID of an instance.
  • vhost_fqdn ⁠string
    fqdn of a vhost.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Apikey, followed by the user's API Key.
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With 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 ⁠boolean
      True 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.

Body

• application/json

  ⁠object

  With the following properties:

  • fqdn ⁠string
    fqdn 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 ⁠boolean
      True 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
  • status ⁠string

    One of: "being_created", "running", "being_deleted", "locked", "waiting_ownership", "ownership_validated", "validation_failed"

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • instance_id ⁠string
    UUID of an instance.
  • vhost_fqdn ⁠string
    fqdn of a vhost.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Apikey, followed by the user's API Key.
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string