Skip to main content
POST
/
apps
/
{provider}
/
blocklist
Activate or add a blocklist entry
curl --request POST \
  --url https://api.onecli.sh/v1/apps/{provider}/blocklist \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hostId": "<string>"
}
'
{
  "hostId": "<string>",
  "ruleId": "<string>",
  "enabled": true,
  "custom": true,
  "name": "<string>",
  "hostPattern": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key obtained from the dashboard or GET /user/api-key

Path Parameters

​
provider
string
required

App provider identifier (e.g., gmail, github, jira)

Body

application/json
​
hostId
string
required

Response

Blocklist entry created or activated

State of one blocklist entry — a predefined host or a custom rule.

​
hostId
string
​
ruleId
string | null

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

​
enabled
boolean
​
custom
boolean

True for custom rules, false for the app's predefined hosts.

​
name
string
​
hostPattern
string
​
scope
enum<string> | null
Available options:
project,
organization,
null