API Reference

The pages available, their functionality, along with examples are listed below. The details refer to the most recent protocol.

FAQ / Wiki

  • wiki/search

    Searches the FAQ and provides meta-data about results with the most relevant first.

    Each result item contains a title, URL, excerpt, category, and relevance. The "text-state" attribute on the excerpt is currently raw, this means without code tags applied. The relevance is the order of results and is calculated depending on the number of occurrences and grouping of search terms found in the FAQ answer.

    Examples:

    1. search?query=licence – search for a term.
    2. search?query=why google checkout – multiple search terms.
    3. search – error: no search term passed.
    4. search?query=a a a a a a a a a a a – warning: too many search terms, some ignored.

Site

  • site/configuration

    Retrieves common configuration key / values used by the pages.

    This generally includes values or constants that are not hard coded into the pages themselves, instead they are retrieved from this configuration pool. For example the a "really large value" was chosen to represent "not throttled" on the servers, this value would be stored in the configuration so it can be changed in the future if required. They change very infrequently (if at all) and can be safely cached for a day or longer.

    Example:

    1. site/configuration – list key / value configuration values.
  • site/plan-list

    Lists plans available for purchase and their availability.

    An array of plans available for purchase (others may still exist) are listed along with their availability. The availability given is an authoritative answer and a precise measurement, it may differ from the website and is the ideal method for collecting stats.

    Example:

    1. site/plan-list – display a list of public plans.
  • site/plan-detail

    Provides more detail about a particular slot.

    Displays details such as a name, description about a particular slot. It accepts both an ID or a label with the first match being displayed, both are unique identifiers for a plan.

    Example:

    1. plan-detail?id=96 – display the Radon-2 slot with supplied ID.
    2. plan-detail?label=radon-2 – display the Radon-2 slot with supplied label.
    3. plan-detail – error: no ID or label passed.

Account

  • account/plan-list

    Lists all account plans not expired.

    There may be multiple account plans to a single server, please be sure to collate the results over the "server-id" key. The "plan-id" element should be used as a unique identifier for the service sold in the account and further details can be pulled from the account/plan-detail page. Please check the site/configuration for the current value of "not throttled" as high throttle values represent this.

    Example:

    1. account/plan-list – list all account plans for the current user.

Server

  • server/detail

    Provides further detail on a particular server.

    Displays further details about a server. It accepts the server name (without the ".feralhosting.com" part) which will uniquely identify the server.

    Example:

    1. server/detail?name=seal – display information for the server "seal.feralhoting.com".
  • server/disk

    Lists the current disk usage for each server the user has a plan on.

    The disk elements returned are grouped by server. This means that if a user has multiple account plans on the same server, the totals are added up for all plans on it. It is possible for a user to go over their allotted disk amount. Normally, disk space is updated daily unless explicitly instructed to again.

    Example:

    1. server/disk – list disk usage for a provided.
  • server/bandwidth

    Lists the current bandwidth for each server the user has a plan on.

    The bandwidth elements returned are grouped by server. This means that if a user has multiple account plans on the same server, the totals are added up for all plans on it. Even if the bandwidth totals exceed the plan-detail limits, the user may not be limited and should only be reported as limited if the account/plan-list page displays a throttle. Normally, bandwidth is updated hourly unless explicitly instructed to again.

    Example:

    1. server/bandwidth – list bandwidth usage for all plans.