Skip to main content
Returns a single boundary. By default {id} is the boundary ID. Set by_custom_id=true to look the boundary up by its custom_id instead.
Permission required: boundary:read. This shows which scope the boundary declares, not what is in it: searching through the boundary still checks permission on the projects, actor and agent it names.

Path Parameters

string
required
Boundary ID, or the boundary’s custom_id when by_custom_id is true.

Query Parameters

boolean
default:"false"
When true, the path parameter is read as the boundary’s custom_id rather than its ID.

Response

object