onboarding

Exchange a short-lived repository-adoption code for a project-scoped API credential and its selected workspace/Product binding.

The endpoint first applies a 30-per-15-minute caller-IP limit before parsing the body, then a separate 300-per-hour bucket keyed by the submitted code digest. The raw long-lived key is returned only to the CLI and is never sent to the browser or embedded in the copied shell command. A returning CLI may send its existing pm_live_ Bearer key: if that exact user/workspace write credential is valid, the endpoint binds and reuses it. After a code is consumed, only the exact bound key may resume the same exchanging session; possession of the code alone is insufficient. Success responses set Cache-Control: no-store.

post/api/v1/onboarding/repo/exchange

Request body

codestring required

The 32-character pm_adopt_ code generated by the authenticated onboarding page. It expires after 15 minutes and is consumed once.

Response

Code claimed; returns the selected binding and either a newly minted apiKey or reusedCredential:true.

object required

Changes

Changed in 1 of the 14 revisions of this API.1