---
title: "Install the Impreza agent on a VPS, with the customer's consent"
method: POST
path: "/platform/services/{id}/agent-install"
tags: ["Platform"]
---

# Install the Impreza agent on a VPS, with the customer's consent

`POST /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`

Queues the same install as the client area's one-click button
(through the QEMU guest agent). Send the confirm_token from the GET,
only after the customer agreed to install a service that runs as
root on the server. The token is spent once. Every eligibility rule
is checked again here. Scope manage.

## Path parameters

- `id` integer, required

## Request body

- object
  - `confirm_token` string, required

## Response `202`

Install queued

## Other responses

- `400`: CONFIRMATION_REQUIRED, CONFIRMATION_INVALID or INVALID_REQUEST
- `401`: Invalid or missing API credentials
- `403`: The key lacks the manage scope
- `404`: Resource not found
- `409`: CONFIRM_TOKEN_USED, NOT_INSTALLABLE (the message names the reason) or AGENT_PRESENT
- `503`: PLATFORM_UNAVAILABLE or CONFIRMATION_UNAVAILABLE; nothing was installed

---

[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)