Skip to main content
GET
Get an app's blocklist state
Returns the blocklist state for one app. To block an arbitrary host, write an organization rule instead. See Rules. The app’s predefined blockable hosts and whether each is blocked at the workspace or organization level. An organization block overrides the workspace’s view. To block an arbitrary host, write an organization policy rule instead.
Availability: Cloud · Community (self-hosted) · Enterprise (self-hosted)

Authorizations

Authorization
string
header
required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Path Parameters

provider
string
required

App provider identifier (for example gmail, github, jira).

Response

Blocklist state

hostId
string
ruleId
string | null

The backing rule ID, or null when the host has never been activated.

enabled
boolean
custom
boolean

Always false. Blocking an arbitrary host is a policy rule now; this surface only toggles the hosts the app itself declares.

name
string
hostPattern
string
scope
enum<string> | null

Where the backing rule lives. An organization rule overrides the workspace's view of that host.

Available options:
workspace,
organization,
null