Project scoping
Send project context on collection operations and rely on resource ownership for item operations.
Loading documentation…
Every automation API key belongs to exactly one project. The API enforces that binding in addition to checking scopes.
Send project_id in the JSON body when creating a resource or calling a /list endpoint.
The ID must match the project bound to the API key. A mismatch returns 403 Forbidden.
Project-wide actions such as POST /v1/checks/summary and POST /v1/schedules/summary also require project_id in the body. They do not identify a single resource in the URL.
Do not send project context when the URL already identifies a resource:
For GET, PATCH, POST actions, and DELETE routes below a resource ID, the API loads the resource and derives its owning project.
Do not send project_id in the body or query string, and do not send
X-Project-Id. Item routes reject supplied project context with 400 Bad Request.
To avoid revealing whether another customer's resource exists, an item that is outside the key's project returns 404 Not Found, just like an unknown ID. Use a different API key for each project.
Include the key's project_id in the request body.
Include the key's project_id in the request body.
Omit all project context; ownership is derived from the item.
Projects themselves are managed with an interactive console session, not a project API key. See Projects.