Path parameters

  • id integer Required

    The order ID number.

Responses

  • 200 application/json

    Server details

    Hide response attributes Show response attributes object
    • ipmiAuth boolean Required
    • billingDetails object Required
      Hide billingDetails attributes Show billingDetails attributes object
      • service_last_invoice_date string
      • service_payment_status string
      • service_frequency string
      • next_date string
      • service_next_invoice_date string
      • service_currency string
      • service_currency_symbol string
      • service_cost_info string
      • service_extra array[string]
      • service_extra_json string
    • custCurrency string Required
    • custCurrencySymbol string Required
    • package string Required
    • serviceExtra array[string] Required
    • locations object Required
      Hide locations attribute Show locations attribute object
      • 1 object
        Hide 1 attributes Show 1 attributes object
        • location_id integer Required
        • location_name string Required
        • location_description string
        • location_lat string Required
        • location_long string Required
        • location_ipmi_group integer
    • networkInfo object Required
      Hide networkInfo attributes Show networkInfo attributes object
      • vlans array[string] Required

        List of VLANs.

      • vlans6 array[string] Required

        List of IPv6 VLANs.

      • assets object Required

        Object containing asset information.

        Hide assets attribute Show assets attribute object
        • 3497 object Required
          Hide 3497 attributes Show 3497 attributes object
          • id integer Required

            Unique identifier for the asset.

          • order_id string Required

            Order identifier for the asset.

          • hostname string Required

            Hostname associated with the asset.

          • status string Required

            Status of the asset.

          • primary_ipv4 string Required

            Primary IPv4 address of the asset.

          • primary_ipv6 string Required

            Primary IPv6 address of the asset.

          • mac

            MAC address associated with the asset.

          • datacenter string Required

            Datacenter identifier for the asset.

          • type_id string Required

            Type identifier for the asset.

          • asset_tag string Required

            Asset tag associated with the asset.

          • rack string Required

            Rack identifier for the asset.

          • row string Required

            Row identifier for the asset.

          • col string Required

            Column identifier for the asset.

          • unit_start string Required

            Starting unit identifier for the asset.

          • unit_end string Required

            Ending unit identifier for the asset.

          • unit_sub string Required

            Subunit identifier for the asset.

          • ipmi_mac string Required

            IPMI MAC address associated with the asset.

          • ipmi_ip string Required

            IPMI IP address associated with the asset.

          • ipmi_admin_username

            IPMI admin username associated with the asset.

          • ipmi_admin_password

            IPMI admin password associated with the asset.

          • ipmi_client_username

            IPMI client username associated with the asset.

          • ipmi_client_password

            IPMI client password associated with the asset.

          • ipmi_updated

            IPMI update status associated with the asset.

          • ipmi_working string Required

            IPMI working status associated with the asset.

          • company string Required

            Company associated with the asset.

          • comments string Required

            Comments associated with the asset.

          • make string Required

            Make of the asset.

          • model string Required

            Model of the asset.

          • description string Required

            Description of the asset.

          • customer_id string Required

            Customer identifier for the asset.

          • external_id string Required

            External identifier for the asset.

          • billing_status string Required

            Billing status of the asset.

          • overdue string Required

            Overdue status of the asset.

          • create_timestamp

            Timestamp of asset creation.

          • update_timestamp

            Timestamp of asset update.

          • asset_id string Required

            Asset identifier for the asset.

          • asset_name string Required

            Name of the asset.

          • rack_id string Required

            Rack identifier for the asset.

          • rack_name string Required

            Rack name associated with the asset.

          • rack_location string Required

            Location of the rack associated with the asset.

          • rack_size string Required

            Size of the rack associated with the asset.

          • rack_x string Required

            X-coordinate of the asset within the rack.

          • rack_y string Required

            Y-coordinate of the asset within the rack.

          • comment

            Comment associated with the asset.

          • switchports array[integer] Required

            List of switchports associated with the asset.

          • vlans array[string] Required

            List of VLANs associated with the asset.

          • vlans6 array[string] Required

            List of IPv6 VLANs associated with the asset.

          • lease object Required
            Hide lease attributes Show lease attributes object
            • mac string Required

              MAC address associated with the lease.

            • authenticated boolean Required

              Indicates if the lease is authenticated.

            • group string Required

              Group identifier for the lease.

      • switchports object Required

        Object containing switchport information.

        Hide switchports attribute Show switchports attribute object
        • 10414 object Required
          Hide 10414 attributes Show 10414 attributes object
          • switchport_id integer Required

            Unique identifier for the switchport.

          • switch_id string Required

            Unique identifier for the switch associated with the switchport.

          • switch string Required

            Name of the switch associated with the switchport.

          • port string Required

            Port name on the switch.

          • blade string Required

            Blade name associated with the port.

          • justport string Required

            Port identifier.

          • graph_id string Required

            Identifier for the graph associated with the switchport.

          • vlans array[string]

            List of VLANs associated with the switchport.

          • vlans6 array[string]

            List of IPv6 VLANs associated with the switchport.

          • asset_id integer Required

            Unique identifier of the asset associated with the switchport.

    • extraInfoTables object Required
      Hide extraInfoTables attribute Show extraInfoTables attribute object
      • assets object Required
        Hide assets attributes Show assets attributes object
        • title string Required

          The title of the assets.

        • size integer Required

          The size of the assets.

        • type string Required

          The type of the assets.

        • header array[string] Required

          The header of the assets table.

        • rows array[array] Required

          The rows of the assets table.

    • serviceInfo object Required
      Hide serviceInfo attributes Show serviceInfo attributes object
      • server_id string

        The ID of the server.

      • server_hostname string

        The hostname of the server.

      • server_custid string

        The customer ID associated with the server.

      • server_type string

        The type of the server.

      • server_currency string

        The currency used for billing.

      • server_order_date string

        The date when the server was ordered.

      • server_invoice string

        The invoice number for the server.

      • server_coupon string

        The coupon associated with the server.

      • server_status string

        The status of the server.

      • server_root string

        The root of the server.

      • server_dedicated_tag string

        The dedicated tag of the server.

      • server_custom_tag string

        The custom tag of the server.

      • server_comment string

        Comments related to the server.

      • server_initial_bill string

        The initial billing amount for the server.

      • server_hardware string

        The hardware information of the server.

      • server_ips string

        The number of IPs associated with the server.

      • server_monthly_bill string

        The monthly billing amount for the server.

      • server_setup string

        The setup status of the server.

      • server_discount

        Discount information for the server.

      • server_rep string

        The reputation of the server.

      • server_date string

        The date related to the server.

      • server_total_cost string

        The total cost of the server.

      • server_location

        The location of the server.

      • server_hardware_ordered string

        The ordered hardware for the server.

      • server_billed string

        The billed amount for the server.

      • server_welcome_email string

        Indicates whether a welcome email was sent.

      • server_dedicated_cpu string

        The number of dedicated CPUs for the server.

      • server_dedicated_memory string

        The amount of dedicated memory for the server.

      • server_dedicated_hd1 string

        The size of the first dedicated hard drive.

      • server_dedicated_hd2

        The size of the second dedicated hard drive.

      • server_dedicated_bandwidth string

        The bandwidth of the server.

      • server_dedicated_ips string

        The number of dedicated IPs for the server.

      • server_dedicated_os string

        The operating system of the server.

      • server_dedicated_cp

        The control panel of the server.

      • server_dedicated_raid string

        The RAID configuration of the server.

      • server_extra string

        Additional information about the server.

  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • code string Required
    • message string Required
GET /servers/{id}
curl \
 --request GET 'https://my.interserver.net/apiv2/servers/{id}' \
 --header "X-API-KEY: $API_KEY"
Response examples (200)
{
  "ipmiAuth": true,
  "client_links": [
    {
      "label": "string",
      "link": "string",
      "icon": "string",
      "icon_text": "string",
      "help_text": "string"
    }
  ],
  "billingDetails": {
    "service_last_invoice_date": "string",
    "service_payment_status": "string",
    "service_frequency": "string",
    "next_date": "string",
    "service_next_invoice_date": "string",
    "service_currency": "string",
    "service_currency_symbol": "string",
    "service_cost_info": "string",
    "service_extra": [
      "string"
    ],
    "service_extra_json": "string"
  },
  "custCurrency": "string",
  "custCurrencySymbol": "string",
  "package": "string",
  "serviceExtra": [
    "string"
  ],
  "locations": {
    "1": {
      "location_id": 42,
      "location_name": "string",
      "location_description": "string",
      "location_lat": "string",
      "location_long": "string",
      "location_ipmi_group": 42
    }
  },
  "networkInfo": {
    "vlans": [
      "string"
    ],
    "vlans6": [
      "string"
    ],
    "assets": {
      "3497": {
        "id": 3497,
        "order_id": "16058",
        "hostname": "myserver.host.com",
        "status": "active",
        "primary_ipv4": "1.2.3.250",
        "primary_ipv6": "string",
        "datacenter": "2",
        "type_id": "1",
        "asset_tag": "string",
        "rack": "68",
        "row": "017",
        "col": "06",
        "unit_start": "37",
        "unit_end": "37",
        "unit_sub": "0",
        "ipmi_mac": "0c:c4:7a:af:35:00",
        "ipmi_ip": "10.8.69.7",
        "ipmi_working": "0",
        "company": "int",
        "comments": "string",
        "make": "Supermicro",
        "model": "SYS-6018R-TDW",
        "description": "string",
        "customer_id": "int5377",
        "external_id": "string",
        "billing_status": "active",
        "overdue": "0",
        "asset_id": "1",
        "asset_name": "server",
        "rack_id": "68",
        "rack_name": "112.16",
        "rack_location": "2",
        "rack_size": "44",
        "rack_x": "25",
        "rack_y": "5",
        "switchports": [
          10414
        ],
        "vlans": [
          "string"
        ],
        "vlans6": [
          "string"
        ],
        "lease": {
          "mac": "0c:c4:7a:af:35:00",
          "authenticated": false,
          "group": "1"
        }
      }
    },
    "switchports": {
      "10414": {
        "switchport_id": 10414,
        "switch_id": "118",
        "switch": "edge1",
        "port": "Ethernet1/33",
        "blade": "Ethernet1",
        "justport": "33",
        "graph_id": "12622",
        "vlans": [
          "string"
        ],
        "vlans6": [
          "string"
        ],
        "asset_id": 3497
      }
    }
  },
  "extraInfoTables": {
    "assets": {
      "assets": {
        "rows": [
          [
            "3497",
            "myserver.host.com",
            "CPU:..............2x Intel Xeon E5-2620v4 @2.10GHz\r\nMemory:...........128GB DDR3 1600MHz\r\nHard Drive 1:.....Crucial 500 GB SSD\r\nHard Drive 2:.....Crucial 500 GB SSD\r\nRAID:.............none\r\nOS:...............Ubuntu 20\r\nControl Panel:....none\r\nNetwork...........10G Card\r\nIP(s):............Vlan 3497\r\nBandwidth:........10Tb @ 10gb port",
            "TEB2",
            "112.16",
            "active",
            "1.2.3.250",
            ""
          ]
        ],
        "size": 2,
        "type": "table",
        "title": "Assets",
        "header": [
          "Id",
          "Hostname",
          "Description",
          "Location Name",
          "Rack Name",
          "Status",
          "Primary Ipv4",
          "Comments"
        ]
      }
    }
  },
  "serviceInfo": {
    "server_id": "16058",
    "server_hostname": "myserver.host.com",
    "server_custid": "771282",
    "server_type": "600",
    "server_currency": "USD",
    "server_order_date": "2020-05-08T17:22:36.000Z",
    "server_invoice": "18738142",
    "server_coupon": "0",
    "server_status": "active",
    "server_root": "string",
    "server_dedicated_tag": "0",
    "server_custom_tag": "string",
    "server_comment": "string",
    "server_initial_bill": "0",
    "server_hardware": "0",
    "server_ips": "0",
    "server_monthly_bill": "0",
    "server_setup": "0",
    "server_rep": "0",
    "server_date": "1588972956",
    "server_total_cost": "230",
    "server_hardware_ordered": "0",
    "server_billed": "0",
    "server_welcome_email": "1",
    "server_dedicated_cpu": "38",
    "server_dedicated_memory": "22",
    "server_dedicated_hd1": "20",
    "server_dedicated_bandwidth": "3",
    "server_dedicated_ips": "5",
    "server_dedicated_os": "30",
    "server_dedicated_raid": "0",
    "server_extra": "[]"
  }
}
Response examples (401)
{
  "code": "string",
  "message": "string"
}