---
title: "Register a new self-hosted deployment"
method: POST
path: "/orgs/{org_id}/deployments"
tags: ["Licensing"]
---

# Register a new self-hosted deployment

`POST /orgs/{org_id}/deployments`

## Request

- Base URL: `https://api.mnemom.ai/v1`
- URL: `https://api.mnemom.ai/v1/orgs/{org_id}/deployments`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Mnemom-Api-Key`
  - API key in cookie `mnemom_session`

Requires org `owner` or `admin`. The `license_id` must already exist and belong to this org (verified via `verify_org_license` RPC). The deployment starts in `active` status.

## Path parameters

- `org_id` string, required

## Request body

- object
  - `instance_name` string, required
  - `instance_id` string, required
  - `license_id` string, required
  - `region` string, nullable
  - `version` string, nullable
  - `instance_metadata` object

## Response `201`

Deployment registered.

- SelfHostedDeployment: A self-hosted Mnemom deployment registered by an org.
  - `deployment_id` string: Prefixed `dep-…` identifier assigned on registration.
  - `org_id` string
  - `license_id` string
  - `instance_name` string
  - `instance_id` string
  - `region` string, nullable
  - `status` 'active' | 'inactive' | 'degraded'
  - `version` string, nullable
  - `heartbeat_data` object
  - `instance_metadata` object
  - `last_heartbeat_at` string, date-time, nullable
  - `created_at` string, date-time
  - `updated_at` string, date-time

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Forbidden
- `404`: Resource not found
- `429`: Rate-limit exceeded. The global per-IP limiter (100 requests/minute, applied to every `/v1/*` route) rejected this request. Back off until the window resets — `Retry-After` carries the cooldown in seconds and `X-RateLimit-Reset` the absolute reset time.
- `500`: Server error — request was well-formed but the server failed to fulfill it. Typically a downstream dependency (DB / RPC / external API) returned an unexpected error.

---

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