ServerGrove Control Panel API Documentation

View in JSON

---

VirtualHost

• virtualHost/get
  Retrieves a virtual host associated with a domain.
• virtualHost/list
  List virtual hosts associated with domain.

---

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

---

Server

• server/get
  Retrieve server.
• server/getByHostname
  Retrieve server by hostname.
• server/getDefault
  Retrieve the current default server for account.
• server/list
  Retrieve list of servers available to account.
• server/restart
  Restarts/reboot server.
• server/start
  Starts/boot up server.
• server/stop
  Stops/shutdown server.
• server/discover
  Initiates discover process. The discover process will attemtp to retrieve server status information like running status, disk and memory usage, installed applications, system users.
• server/changeHostname
  Changes the hostname of server.
• server/resetImage
  Installs a new server OS image. All existing files will be permanantely lost. An email is sent to the authenticated user email address when the process is complete. The process may take between 5 and 15 minutes depending on the task queue for the host server.
• server/upgradeOS
  Upgrades the OS packages by running the corresponding upgrade command for the distribution.
• server/exec
  Executes a command in the server and returns the command output if async=0.
• server/getBWUsage
  Retrieves bandwidth consumption for a given date.
• server/getMonthBWUsage
  Retrieves bandwidth consumption for a given month.
• server/getDayBWUsage
  Retrieves bandwidth consumption for current day.
• server/setTimezone
  Changes the timezone of server.
• server/requestPrivateIpAddress
  Requests to add a private IP address.
• server/getTimeline
  Retrieves timeline of events for server.

---

Timeline

• timeline/getList
  Lists events in timeline.

---

Message

• message/get
  Retrieves message
• message/getAll
  Retrieves all messages associated with current authenticated user
• message/getAllUnsent
  Retrieves all unsent messages associated with current authenticated user
• message/getUnread
  Retrieves all unread messages associated with current authenticated user
• message/markRead
  Marks a message as read
• message/markAllRead
  Mark all messages associated with current authenticated user as read

---

Mongodb

• mongodb/listDatabases
  Retrieves a list of databases.
• mongodb/createDatabase
  Creates a database in the server.
• mongodb/dropDatabase
  Drops an existing database in the server.
• mongodb/listCollections
  Lists all the collections from an existing database.
• mongodb/createCollection
  Creates a collection in an existing database.
• mongodb/editCollection
  Renames a collection in an existing database.
• mongodb/convertCollectionToCapped
  Converts an existing collection to a capped one.
• mongodb/dropCollection
  Drops an existing collection from a given database.
• mongodb/cloneCollection
  Clones an existing collection.
• mongodb/createIndex
  Creates an Index on a given collection.
• mongodb/createGeospatialIndex
  Creates an Index on a given collection.
• mongodb/deleteIndex
  Deletes an Index from the given collection.
• mongodb/listUsers
  Retrieves all the users for a database.
• mongodb/addUser
  Adds a new database user to the to the server.
• mongodb/updateUser
  Updates an existing database user.
• mongodb/deleteUser
  Deletes an existing user.
• mongodb/listDocuments
  Retrieves a list of all documents of a collection.
• mongodb/getDocument
  Finds a document.
• mongodb/insertDocument
  Inserts a new document in a given collection.
• mongodb/updateDocument
  Updates an existent document in a given collection.
• mongodb/deleteDocument
  Removes an existent document from a given collection.
• mongodb/cloneDocument
  Creates an identical copy of a given document.
• mongodb/renameCollectionField
  Renames a field in a collection.
• mongodb/checkInstance
  Verifies the status of a given MongoDB server
• mongodb/instanceCurrentUsage
  Retrieves statistics about the current usage of a given MongoDB server.
• mongodb/updateInstanceStats
  Updates statistics about the current usage of a given MongoDB server.
• mongodb/instanceAvgUsage
  Retrieves statistics about the average usage of a given MongoDB server.
• mongodb/checkTask
  Checks the status of a task.
• mongodb/mongoExport
  Schedules a mongo export for a given database and collection name.
• mongodb/importMongoExport
  Import mongo export to given database and collection name.
• mongodb/importFromLocalDatabase
  Import from a local MongoDB database.
• mongodb/importFromRemoteDatabase
  Import from a remote database.
• mongodb/importMysqlDump
  Import from a mysql dump file.
• mongodb/analyzeSchema
  Analyze a database collection schema.
• mongodb/mongostat
  Return mongostat rows.
• mongodb/removeRemoteServer
  Add a remote server to manage.
• mongodb/addRemoteServer
  Add a remote server to manage.
• mongodb/validateJson
  Validate a MongoDB JSON string.
• mongodb/explainQuery
  Explains a JSON query for the given collection.
• mongodb/currentOperations
  Get the current operation list for a given server and database.

---

ControlPanel

• controlPanel/listLanguages
  Returns list of supported languages.

---

Filesystem

• filesystem/get
  Retrieves content of file from server filesystem.
• filesystem/fileInfo
  Retrieves information about a file or directory.
• filesystem/put
  Updates content of file.
• filesystem/tail
  Retrives last portion of file, like the tail unix command.
• filesystem/compress
  Compresses a file using gzip.
• filesystem/truncate
  Truncates a file to 0 bytes size.
• filesystem/list
  Lists files in a directory

---

Authentication

• authentication/checkPassword
  Checks if password is valid for username.
• authentication/login
  Authenticated user and creates a session.
• authentication/logout
  Logs out user and destroys current session.
• authentication/getLoggedUser
  Retrieves user of current session.
• authentication/getUserGroup
  Retrieves group of current session's user.

---

Test

• test/echo
  Returns input.

---

IpAddress

• ipAddress/getUsage
  Retrieves bandwidth consumption for a given IP address.

---

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.

---

User

• user/delete
  Removes a user to the client associated with the current authenticated user
• user/requestPasswordReset
  Requests a password reset for user.
• user/resetLogin
  Resets the user's password by sending a reset email message
• user/post
  Adds a user to the client associated with the current authenticated user
• user/put
  Updates a user to the client associated with the current authenticated user
• user/listContacts
  Lists contacts for current authenticated user
• user/listAlertConfig
  Lists alert configuration for current authenticated user
• user/addAlertConfig
  Adds an alert configuration for current authenticated user
• user/updateAlertConfig
  Updates an alert configuration for current authenticated user
• user/removeAlertConfig
  Deletes an alert configuration for current authenticated user

---

App

• app/get
  Retrieves application.
• app/list
  List applications installed in server.
• app/uninstall
  Uninstalls application from server.
• app/install
  Installs application in server.
• app/call
  Calls a method in the application.
• app/updateStatus
  Changes status of application. This can be used to enable or disable a server like Apache.
• app/getConfigFile
  Retrieves content of config file by file ID. Content will be returned only if async=2, otherwise it can be fethed by getting the task with task/get
• app/setConfigFile
  Updates content of config file by file ID.

---

Zone

• zone/get
  Gets information about an availability zone
• zone/list
  Lists all availabilty zones

---

Email

• email/getAccount
  Retrieves email account.
• email/deleteAccount
  Deletes email account.
• email/setAutoresponder
  Enables/disables an autoresponder.
• email/setAccountStatus
  Enables/disables an email account.
• email/putAccount
  Inserts or updates an email account.
• email/listAccounts
  Lists email accounts associated with domain.
• email/addRedirect
  Adds a redirect destination.
• email/removeRedirect
  Removes a redirect destination.
• email/addAlias
  Adds an email alias to an existing email account.
• email/removeAlias
  Removes an email alias.

---

ServerUser

• serverUser/get
  Retrieves a server user
• serverUser/delete
  Deletes a user from server
• serverUser/put
  Adds or updates a server user
• serverUser/list
  List users in server