---
title: "Register a BYOS machine"
method: POST
path: "/api/v1/machines"
tags: ["Machines"]
---

# Register a BYOS machine

`POST /api/v1/machines`

## Request

- Base URL: `http://:8080`
- URL: `http://:8080/api/v1/machines`
- Auth: none declared

Register a BYOS machine.

Auth: Required (bearer token).
Scope: Organization-scoped in authenticated context.
Side effects: May mutate server state.

## Headers

- `Accept` string

## Request body `*/*`

- CreateMachineRequest: CreateMachineRequest schema
  - `host` string, required
  - `name` string, required
  - `port` integer
  - `user` string

## Response `201`

Created

- CreateMachineResponse: CreateMachineResponse schema
  - `host` string
  - `id` string, uuid
  - `name` string
  - `port` integer
  - `public_key` string
  - `user` string

## Other responses

- `400`: Bad Request _(validation or deserialization error)_
- `500`: Internal Server Error _(panics)_
- `default`

## Changes

- **2026-04-26** `09f18af670c4`: 1 breaking, 3 info
  - removed the success response with the status `200`
  - api tag `Machines` added
  - api tag `api/v1/machines` removed
  - added the success response with the status `201`
- **2026-04-06** `6d5e3b7979d1`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/nixopus/apis/nixopus-api/changes/api/v1/machines/post.md)

---

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