ServerGrove Control Panel API Documentation

View in JSON


Email


Zone


ControlPanel


IpAddress


Mongodb


User


Test


App


Filesystem


Dns

  • dns/get
    Retrieves a record from a DNS domain zone.
  • dns/delete
    Deletes a record from a DNS domain zone.
  • dns/post
    Inserts a record into a DNS domain zone
  • dns/put
    Updates a record from a DNS domain zone
  • dns/list
    List records of a DNS domain zone.
  • dns/reset
    Resets a DNS domain zone, deleting all existing records and creating new ones from a zone template.
  • dns/setGoogleApps
    Sets DNS records needed for Google Apps. This will remove any existing MX records and create ones for Google Apps.
  • dns/check
    Checks a hostname/type agaist ServerGrove's nameservers.

Server


VirtualHost


Message


Timeline


ServerUser


Authentication


Domain

  • domain/get
    Retrieves a domain.
  • domain/list
    Lists domains associated with server.
  • domain/delete
    Deletes a domain.
  • domain/post
  • domain/put
    Adds a domain to a server. A corresponding DNS zone will be created in ServerGrove DNS servers. A corresponding virtual host entry will be added to the Apache2 configuration if Apache2 is installed in the server. The domain will also be added to the ServerGrove email servers.
  • domain/whois
    Retrives WHOIS information for a domain.
  • domain/check
    Checks the status of a domain
  • domain/putAlias
    Adds a domain alias to a server associated with a parent domain. A corresponding DNS zone will be linked to the parent domain. The domain alias will be also added as a ServerAlias to the parent domain virtual host.
  • domain/deleteAlias
    Deletes a domain alias.
  • domain/putSubdomain
    Adds a subdomain to a server associated with a parent domain. A corresponding DNS record will be added to the DNS zone of the parent domain. A virtual host will be added to the Apache2's server if it is installed.
  • domain/deleteSubdomain
    Deletes a subdomain.
  • domain/getServices
    Lists services (Web Hosting, DNS, Email) for domain.
  • domain/updateService
    Updates service status. Valid services are DNS, Web, Email.
  • domain/requestEpp
    Request the EPP code / authorization key to transfer the domain out of ServerGrove.
  • domain/updateLockStatus
    Updates the domain lock status
  • domain/listTLDs
    Lists TLDs available for domain registration at ServerGrove.
  • domain/register
    Checks / Registers a domain name