---
title: "Onboard Client"
method: POST
path: "/v2/polaris/onboard"
tags: ["Polaris"]
---

# Onboard Client

`POST /v2/polaris/onboard`

## Request

- Base URL: `https://api.carbonarc.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.carbonarc.co/v2/polaris/onboard`
- Auth: none declared

## Request body

- OnboardRequest
  - `client_name` string, required
  - `properties` object, nullable: Optional principal properties (string->string), forwarded to Polaris.

## Response `201`

Successful Response

- OnboardResponse
  - `principal_name` string, required
  - `polaris_client_id` string, required
  - `polaris_client_secret` string, required

## Other responses

- `404`: Not Found
- `422`: Validation Error

---

[API](https://skmtc.dev/carbonarc/apis/carbon-arc-api-documentation.md) · [All operations](https://skmtc.dev/carbonarc/apis/carbon-arc-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonarc/apis/carbon-arc-api-documentation/revisions/7362ca3a398d?raw)