Link a resource to a trail
Omit role and it is guessed from the kind. The release gates and the release phase read these links. Linking the same entity again changes its role.
Omit role and it is guessed from the kind. The release gates and the release phase read these links. Linking the same entity again changes its role.
Writes made through the CLI or MCP while SHIPEASY_TRAIL is set link themselves; use this for anything else.
Safe for the restricted ops key.
The agent created the flag checkout.v2 for the trail; it links it as ships_behind.
Authorization
bearerSdkKey Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".
In: header
Path Parameters
The trail's handle (T-12) or its id.
^(?:T-[0-9]+|[0-9a-fA-F-]{32,36})$1 <= length <= 64Header Parameters
Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
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
curl -X POST "https://shipeasy.ai/api/admin/trails/string/resources" \ -H "Content-Type: application/json" \ -d '{ "kind": "gate", "resourceKey": "checkout.v2", "role": "ships_behind" }'{
"id": "string",
"kind": "gate",
"resourceId": "string",
"resourceKey": "string",
"role": "ships_behind",
"source": "agent",
"state": {
"exists": true,
"archived": true,
"settled": true,
"summary": "string",
"prodRolloutPct": 0,
"status": "string",
"decision": "string",
"property1": null,
"property2": null
},
"createdAt": "string"
}{
"error": "Malformed request (bad JSON, missing project scope).",
"code": "BAD_REQUEST"
}{
"error": "Missing or invalid admin SDK key.",
"code": "UNAUTHORIZED"
}{
"error": "Key is valid but not allowed to act on this project.",
"code": "FORBIDDEN"
}{
"error": "The resource does not exist or is not visible to the caller.",
"code": "NOT_FOUND"
}{
"error": "A resource with this name already exists in the project.",
"code": "ALREADY_EXISTS"
}{
"error": "The request body failed structural (schema) validation.",
"code": "VALIDATION"
}