My InterServer API
GET /home
Api key auth Session id header auth Session id cookie auth

Retrieves a general assortment of information useful for displaying a home page / dashboard overview.

Responses

  • 200 application/json

    Genreal information for use on the home page.

    Hide response attributes Show response attributes object
    • last_login_ip string Required

      Last login IP.

    • last_login string Required

      Last login time.

    • currency string Required

      Currency symbol.

    • amount string Required

      Amount with currency.

    • invoice_list integer Required

      Number of invoices.

    • balance string Required

      Balance with currency.

    • full_name string Required

      Users full name.

    • email string Required

      User email address.

    • tickets array[string] Required

      List of tickets.

    • ticketStatus object Required

      Ticket statuses.

      Hide ticketStatus attributes Show ticketStatus attributes object
      • Open integer

        Count of open tickets.

      • On Hold integer

        Count of tickets on hold.

    • ticketStatusView object Required

      Ticket statuses with view numbers.

      Hide ticketStatusView attributes Show ticketStatusView attributes object
      • 4 string

        Status corresponding to view number 4.

      • 5 string

        Status corresponding to view number 5.

      • 6 string

        Status corresponding to view number 6.

    • details array[string] Required

      Users details.

    • services object Required

      Users services.

      Hide services attributes Show services attributes object
      • domains object
        Hide domains attributes Show domains attributes object
        • links object
          Hide links attributes Show links attributes object
          • 376114 string

            Link to a domain.

          • 376503 string

            Link to a domain.

          • 592337 string

            Link to a domain.

        • count integer

          Number of domains.

      • webhosting object
        Hide webhosting attributes Show webhosting attributes object
        • links object
          Hide links attributes Show links attributes object
          • 376359 string

            Link to a website.

          • 376473 string

            Link to a website.

          • 386218 string

            Link to a website.

        • count integer

          Number of web hosting services.

      • vps object
        Hide vps attributes Show vps attributes object
        • links object
          Hide links attributes Show links attributes object
          • 465503 string

            Link to a VPS.

          • 2500081 string

            Link to a VPS.

          • 2578866 string

            Link to a VPS.

        • count integer

          Number of VPS services.

      • licenses object
        Hide licenses attributes Show licenses attributes object
        • links object
          Hide links attribute Show links attribute object
          • 386522 string

            Link to a license.

        • count integer

          Number of licenses.

      • servers object
        Hide servers attributes Show servers attributes object
        • links object
          Hide links attribute Show links attribute object
          • 16058 string

            Link to a server.

        • count integer

          Number of servers.

      • backups object
        Hide backups attributes Show backups attributes object
        • links array[string]

          List of backup links.

        • count integer

          Number of backups.

    • AFFILIATE_AMOUNT string Required

      Affiliate amount with currency.
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • code string Required
    • message string Required
GET /home 
curl \
 --request GET 'https://my.interserver.net/apiv2/home' \
 --header "X-API-KEY: $API_KEY"
Response examples (200) 
{
  "last_login_ip": "99.88.77.66",
  "last_login": "14:58:pm - 17 Aug, 2023",
  "currency": "$",
  "amount": "$23.50",
  "invoice_list": 5,
  "balance": "$0.60",
  "full_name": "John",
  "email": "user@domain.com",
  "tickets": [
    "string"
  ],
  "ticketStatus": {
    "Open": 4,
    "On Hold": 5
  },
  "ticketStatusView": {
    "4": "Open",
    "5": "On Hold",
    "6": "Closed"
  },
  "details": [
    "string"
  ],
  "services": {
    "domains": {
      "links": {
        "376114": "pimpmy.website",
        "376503": "hostingenuity.com",
        "592337": "detain.dev"
      },
      "count": 5
    },
    "webhosting": {
      "links": {
        "376359": "Doefamily.com",
        "376473": "fancytush.com",
        "386218": "admincoded.net"
      },
      "count": 8
    },
    "vps": {
      "links": {
        "465503": "vps465503",
        "2500081": "vps2500081",
        "2578866": "vps2578866"
      },
      "count": 20
    },
    "licenses": {
      "links": {
        "386522": "1.2.3.4"
      },
      "count": 1
    },
    "servers": {
      "links": {
        "16058": "anotherserver.com"
      },
      "count": 1
    },
    "backups": {
      "links": [
        "string"
      ],
      "count": 0
    }
  },
  "AFFILIATE_AMOUNT": "100"
}
Response examples (401) 
{
  "code": "string",
  "message": "string"
}