v2

latestOpenAPI 3.0.3Apache-2.02026-08-07119359591.9 KB
Resource Restrictions

List resource restrictions the caller is permitted to manage.

List active resource restrictions the authenticated user is permitted to manage. A restriction is returned only if the caller can manage it — i.e. an account/org admin (via admin escalation), a holder of the PROJECT_RESTRICT permission in the project's space, or a holder of PROJECT_RESTRICT granted directly on the project.

Results are paginated; use limit and cursor for subsequent pages. Because entries are authorization-filtered after a page is read, a page may contain fewer items than limit (or be empty) while has_more is still true. Clients MUST keep paging until has_more is false — do not stop on an empty page.

Use the optional resource_type query param to filter to a single resource type. When omitted, PROJECT restrictions are returned (currently the only supported type).

<Note>This endpoint is in beta, read more here.</Note>

get/v2/resource-restrictions

Query parameters

resource_type'PROJECT'

Type of the restricted resource.

  • PROJECT - A project within a space.
Example:PROJECT

Filter restrictions to a single resource type.

  • PROJECT — Return only restricted projects.

When not specified, restrictions of all supported resource types are returned (currently only PROJECT).

limitinteger

Maximum items to return

cursorstring

Opaque pagination cursor returned from a previous response (pagination.next_cursor). Treat it as an unreadable token; do not attempt to parse or construct it.

Response

A list of resource restriction records.

Example response

{
  "resource_restrictions": [
    {
      "resource_type": "PROJECT",
      "resource_id": "TW9kZWw6MTIxOmFCY0Q="
    }
  ]
}