Shipeasy
APIOperations

List a trail's resources

Use case: Check which flag a trail ships behind, and how far it has rolled out, before stepping it up.

Use case

Check which flag a trail ships behind, and how far it has rolled out, before stepping it up.

GET
/api/admin/trails/{handle}/resources

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Path Parameters

handle*string

The trail's handle (T-12) or its id.

Match^(?:T-[0-9]+|[0-9a-fA-F-]{32,36})$
Length1 <= length <= 64

Header Parameters

X-Project-Id?string

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).

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://shipeasy.ai/api/admin/trails/string/resources"
{
  "data": [
    {
      "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"
}
Was this page helpful?