Targets

Adopt a verified existing package as the latest release

POST
/targets/{target_id}/adopt

Checks the repository tag, package metadata, and registry artifact, then records the package as an Imported latest release. Opens the first Typeship Draft at the next major version; review it to establish the baseline for preserving existing code.

AuthorizationBearer <token>

Organization API key from the console (ak_...), or an OAuth access token with user:org:read, the organization selected during consent, and the capability required by the operation.

In: header

Path Parameters

target_id*string

Stable identifier for one configured generated product.

Match^tgt_[a-z0-9]{16}$

Header Parameters

Idempotency-Key?string

Identifies one logical write for 24 hours. The key is scoped to the authenticated organization and operation; generation without an organization uses a hashed network identity. Retrying the same method, path, query, If-Match header, and JSON body replays the original response. Reusing the key with changed intent returns 409. After expiry the key starts a new write.

Match^[!-~]+$
Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/targets/tgt_5m8q2v7k1p9d4h6c/adopt" \  -H "Content-Type: application/json" \  -d '{    "version": "1.0.0",    "tag": "v1.0.0"  }'
{  "id": "rel_7m2q8v4k1p9d5h6c",  "object": "release",  "target_id": "tgt_5m8q2v7k1p9d4h6c",  "generation_id": null,  "version": "1.0.0",  "channel": "stable",  "origin": "imported",  "repository": {    "provider": "github",    "identifier": "parcel-example/parcel-client"  },  "spec_revision_id": null,  "commit_sha": "0123456789abcdef0123456789abcdef01234567",  "checks": [],  "approvals": [],  "import_provenance": {    "tag": "v1.0.0",    "registry_url": "https://www.npmjs.com/package/parcel-client/v/1.0.0",    "artifact_digest": "sha256:3ccd2685803ba4c4db9bed78c3ef8d1993e119abbdafa1ab5dfa6d31846da05d",    "imported_at": "2026-09-23T08:00:00Z"  },  "publications": [],  "created_at": "2026-09-23T08:00:00Z",  "request_id": "req_3k8m1v6q9p2d7h4c"}