---
title: "Read whether the Impreza agent can be installed on a VPS, and the install state"
method: GET
path: "/platform/services/{id}/agent-install"
tags: ["Platform"]
---

# Read whether the Impreza agent can be installed on a VPS, and the install state

`GET /platform/services/{id}/agent-install`

## Request

- Base URL: `https://api.imprezahost.com/v1`
- URL: `https://api.imprezahost.com/v1/platform/services/{id}/agent-install`
- Auth: API key in header `X-API-Key` and API key in header `X-API-Secret`

For one Proxmox VPS of the account: whether the one-click agent
install applies now (agent_installable, and the reason when it does
not), what the agent is, the install job and the agent once it
registers. When the install applies, confirm_token is a consent
token for the POST, valid 5 minutes, bound to this account, this
service, the API key that asked and the hash of the install script.
No address is returned. Scope read.

## Path parameters

- `id` integer, required

## Response `200`

The install state

## Other responses

- `401`: Invalid or missing API credentials
- `404`: Resource not found

---

[API](https://skmtc.dev/imprezahost/apis/impreza-host-public-api.md) · [All operations](https://skmtc.dev/imprezahost/apis/impreza-host-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/imprezahost/apis/impreza-host-public-api/revisions/db86511f604f?raw)