Targets

Create a Target

POST
/targets

Creates a Target with its own configuration, Deliveries, and release history. Multiple Targets can use the same generator.

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

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

application/json

curl -X POST "https://example.com/targets" \  -H "Content-Type: application/json" \  -d '{    "project_id": "prj_4f8k2m7x9q1v6b3n",    "name": "Parcel CLI",    "type": "cli",    "config": {      "cli": {        "command_name": "parcel"      }    },    "deliveries": [      {        "type": "repository",        "repository": {          "provider": "github",          "identifier": "parcel-example/parcel-client",          "module_path": "github.com/parcel-example/parcel-client",          "publish_on_merge": false        }      }    ]  }'
{  "id": "tgt_5m8q2v7k1p9d4h6c",  "object": "target",  "project_id": "prj_4f8k2m7x9q1v6b3n",  "spec_id": "spec_2p8m4q7k1v9d6h3c",  "name": "Parcel CLI",  "type": "cli",  "status": "active",  "release_channel": "stable",  "version_current": null,  "draft_id": "drf_3q7m1v8k2p5d9h4c",  "checks": {    "generated": [      "build",      "package",      "public_entrypoint"    ],    "repository_required": [],    "customer": []  },  "config": {    "cli": {      "command_name": "parcel"    }  },  "deliveries": [    {      "id": "dlv_4q8m2v7k1p9d5h6c",      "object": "delivery",      "target_id": "tgt_5m8q2v7k1p9d4h6c",      "type": "repository",      "repository": {        "provider": "github",        "identifier": "parcel-example/parcel-client",        "directory": null,        "package_name": null,        "module_path": "github.com/parcel-example/parcel-client",        "publish_on_merge": false      },      "status": "active",      "issues": [],      "required_checks": [        "Typeship Release"      ],      "last_event": null,      "created_at": "2026-09-23T08:00:00Z",      "updated_at": "2026-09-23T08:00:00Z"    }  ],  "created_at": "2026-09-23T08:00:00Z",  "updated_at": "2026-09-23T08:00:00Z",  "request_id": "req_3k8m1v6q9p2d7h4c"}