Skip to main content
GET
/
apps
/
{provider}
/
blocklist
Get blocklist state
curl --request GET \
  --url https://api.onecli.sh/v1/apps/{provider}/blocklist \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.onecli.sh/v1/apps/{provider}/blocklist"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.onecli.sh/v1/apps/{provider}/blocklist', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.onecli.sh/v1/apps/{provider}/blocklist",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.onecli.sh/v1/apps/{provider}/blocklist"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.onecli.sh/v1/apps/{provider}/blocklist")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/apps/{provider}/blocklist")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
[
  {
    "hostId": "<string>",
    "ruleId": "<string>",
    "enabled": true,
    "custom": true,
    "name": "<string>",
    "hostPattern": "<string>"
  }
]
{
"error": "<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)

Response

Blocklist state

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