---
title: "Get a one-time install secret for a CI machine, by name, creating the machine if needed"
method: POST
path: "/api/ci/install/"
tags: ["CI"]
---

# Get a one-time install secret for a CI machine, by name, creating the machine if needed

`POST /api/ci/install/`

## Request

- Base URL: `https://eyalsec.com`
- URL: `https://eyalsec.com/api/ci/install/`
- Auth: one of:
  - API key in header `X-API-Key`
  - API key in cookie `__Host-es2session`

For a pipeline that holds only an API key. Finds your es-python machine with this machine_name, or creates it when there is none (distro and arch are then required, and your machine limit applies exactly as for POST /api/add_new_machine/). An existing machine is reset for a fresh install, as POST /api/get_eyalsec_install_script_data/ does, and keeps its name, configuration, rules and events, so one machine serves every run of a pipeline. distro and arch sent for an existing machine update its OS. Returns a single-use install secret that expires after 10 minutes, the install script URL, and server_time, the moment to pass as since to GET /api/ci/findings/ after the run. Requires attested=true. Add format=text for key=value lines. 409 when more than one es-python machine has the name, or when python_version differs from the existing machine's; 403 without es-python on your account.

This is a **write**: a read-only API key is refused with 403.

## Response `200`

OK.

- object

## Other responses

- `401`: The API key is missing, wrong, revoked or expired.
- `429`: A rate limit was hit, or the account is locked after wrong passwords. Retry-After gives the seconds to wait.
- `default`: An error. Check the status first; the body carries a short message, as JSON ({"error": "..."}) on most endpoints and as plain text on some. 400: malformed JSON, an invalid regex, an unreadable cursor or date, or an unknown value. 401: the API key is missing, wrong, revoked or expired. 403: a failed CSRF check, a read-only key trying to write, a product or feature not enabled on your account, a wrong password, or a write on an account limited to reading. 404: not found, including things that belong to another account. 409: conflict with the current state. 422: a field is missing or invalid. 429: a rate limit was hit, or the account is locked after wrong passwords. 500: something failed on our side.

---

[API](https://skmtc.dev/eyalsec/apis/eyalsec-api.md) · [All operations](https://skmtc.dev/eyalsec/apis/eyalsec-api/llms.txt) · [OpenAPI document](https://skmtc.dev/eyalsec/apis/eyalsec-api/revisions/dc7520689cf1?raw)