---
title: "Get VPS instance"
method: GET
path: "/vps/{deviceId}"
tags: ["VPS"]
---

# Get VPS instance

`GET /vps/{deviceId}`

## Headers

- `X-Fields` string, mask

## Response `200`

Success

- VPS
  - `cloudInit` string — Cloud-init script
  - `deviceId` integer — Device ID
  - `facilityCode` string — Facility Code. Example: `LAX3`
  - `isoId` string — The unique ID of the VPS ISO.
  - `memory` integer — Memory in MB
  - `nics` VPSNetworkInterface[]
    - `gateway` string — The gateway assigned to the VPS instance NIC.
    - `ipAddress` string — The IP address assigned to the VPS instance NIC.
    - `ipv6Address` string — The IPv6 address assigned to the VPS instance NIC.
    - `ipv6Cidr` string — The IPv6 CIDR assigned to the VPS instance NIC.
    - `ipv6Gateway` string — The IPv6 gateway assigned to the VPS instance NIC.
    - `macAddress` string — The MAC address of the VPS instance NIC.
    - `netmask` string — The netmask assigned to the VPS instance NIC.
    - `networkId` string — The unique ID of the VPS Network.
    - `networkName` string — The name of the VPS Network.
    - `nicId` string — The unique ID of the VPS instance NIC.
    - `nicName` string — The name of the VPS instance NIC.
    - `vlanId` integer — The VLAN ID of the VPS Network. This will be returned for VLAN enabled networks.
    - `vlanTag` integer — The VLAN tag of the VPS Network. This will be returned for VLAN enabled networks.
  - `password` string — VPS Instance root password
  - `sshKeyIds` integer[] — List of SSH Key IDs
  - `status` string — VPS Instance Status. Example: `Running`
  - `templateId` string — Template used for the install
  - `vcpu` integer — Number of vCPUs

## Other responses

- `403` — You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission.

---

[API](https://skmtc.net/hivelocity/apis/hivelocity-api.md) · [All operations](https://skmtc.net/hivelocity/apis/hivelocity-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hivelocity/hivelocity-api/versions/ee6b717b5015/schema)