resources

Change a site's rules

Replaces all of a site's rules (the patterns go inside rules; omit it to keep the current ones) and, when provided, its schedule, then synchronises it: pages the new rules leave out are removed, new ones imported.

PUT/v1/resources/{resource_id}/rules

Request

curl --request PUT \
  --url 'https://api.lookio.app/v1/resources/<resource_id>/rules' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "rules": {
    "include": [],
    "exclude": [],
    "regex": "<string>",
    "excluded_urls": []
  },
  "schedule": "<string>"
}'

import json
import requests

url = "https://api.lookio.app/v1/resources/<resource_id>/rules"
headers = {
  "Authorization": "<api-key>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"rules\":{\"include\":[],\"exclude\":[],\"regex\":\"<string>\",\"excluded_urls\":[]},\"schedule\":\"<string>\"}")

response = requests.request("PUT", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://api.lookio.app/v1/resources/<resource_id>/rules", {
  method: "PUT",
  headers: {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "rules": {
      "include": [],
      "exclude": [],
      "regex": "<string>",
      "excluded_urls": []
    },
    "schedule": "<string>"
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.lookio.app/v1/resources/<resource_id>/rules");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"rules\":{\"include\":[],\"exclude\":[],\"regex\":\"<string>\",\"excluded_urls\":[]},\"schedule\":\"<string>\"}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

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

func main() {
  req, _ := http.NewRequest("PUT", "https://api.lookio.app/v1/resources/<resource_id>/rules", bytes.NewBuffer([]byte("{\"rules\":{\"include\":[],\"exclude\":[],\"regex\":\"<string>\",\"excluded_urls\":[]},\"schedule\":\"<string>\"}")))
  req.Header.Set("Authorization", "<api-key>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://api.lookio.app/v1/resources/<resource_id>/rules"))
    .header("Authorization", "<api-key>")
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{\"rules\":{\"include\":[],\"exclude\":[],\"regex\":\"<string>\",\"excluded_urls\":[]},\"schedule\":\"<string>\"}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.lookio.app/v1/resources/<resource_id>/rules")
request = Net::HTTP::Put.new(uri)
request["Authorization"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"rules\":{\"include\":[],\"exclude\":[],\"regex\":\"<string>\",\"excluded_urls\":[]},\"schedule\":\"<string>\"}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "id": "<string>",
    "title": "<string>",
    "type": "text",
    "status": "queued",
    "status_detail": null,
    "tags": [
      "<string>"
    ],
    "source_url": null,
    "source": null,
    "site": {
      "rules": {
        "include": [],
        "exclude": [],
        "excluded_urls": []
      },
      "schedule": "<string>",
      "last_synced_at": null
    },
    "created_at": "<string>",
    "updated_at": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

Requires resources:write.

PUT replaces all the rules. Send the complete set under rules: patterns sent anywhere else are refused with unknown_field. Omit rules to keep the current ones, for example to change only the schedule; send {} to import the whole site. Omit schedule to keep the site’s current interval.

Use manual, daily, weekly, monthly, or an interval such as every_3_days, every_2_weeks or every_1_month. Intervals range from 1 to 90 days, 1 to 52 weeks or 1 to 12 months. Recurring schedules require a paid plan; Free workspaces can use manual. The API returns feature_not_available if a Free workspace requests a recurring schedule.

The site is synchronised right away: pages the new rules leave out are removed, and new ones are imported. The resource must be a site, or the call fails with conflict.

Patterns apply to the path of a page. See Rules for the syntax. Use Preview a site to try rules before you commit.

Authorizations

Authorizationbearerin headerrequired

Path parameters

resource_idstringrequiredpattern: ^res_[abcdefghjkmnpqrstuvwxyz23456789]{12}$

Body

application/jsonrequired

rulesobject

The complete new rules, which replace the old ones. Omit to keep the current rules, for example to change only the schedule. Send {} to import the whole site.

Show child attributes

rules.includestring[]default: []items: ≤ 50 items

Path patterns to keep, such as /docs/**. * is one level, ** everything below. Empty keeps the whole site.

rules.excludestring[]default: []items: ≤ 50 items

Path patterns to leave out, such as /blog/**.

rules.regexstringlength: ≤ 500 chars

Advanced: a regular expression on the path; matching pages are left out.

rules.excluded_urlsstring[]default: []items: ≤ 5000 items

Single pages to leave out, by full address.

Omit to keep the site's current schedule. Recurring schedules require a paid plan.

Response

application/json

Change which pages of a site are imported

dataobjectrequired

Show child attributes

data.idstringrequiredpattern: ^res_[abcdefghjkmnpqrstuvwxyz23456789]{12}$

data.titlestringrequired

data.typeenum<string>requiredone of: text, file, url, site

data.statusenum<string>requiredone of: queued, processing, ready, failed, stale, ready_simulated

queued and processing: being read and indexed (pass wait=true or poll until it changes). ready: searchable. failed: see status_detail, then fix and call reindex.

data.status_detailstringnullrequired

data.tagsstring[]required

data.source_urlstringnullrequired

The page or site address, for url and site resources.

data.sourcestringnullrequired

Where it comes from, as shown with its citations.

data.siteobject | nullrequired

A site's page rules and schedule; null for other types.

Show child attributes

data.site.rulesobjectrequireddefault: {"include":[],"exclude":[],"excluded_urls":[]}

Show child attributes

data.site.rules.includestring[]requireddefault: []items: ≤ 50 items

Path patterns to keep, such as /docs/**. * is one level, ** everything below. Empty keeps the whole site.

data.site.rules.excludestring[]requireddefault: []items: ≤ 50 items

Path patterns to leave out, such as /blog/**.

data.site.rules.regexstringlength: ≤ 500 chars

Advanced: a regular expression on the path; matching pages are left out.

data.site.rules.excluded_urlsstring[]requireddefault: []items: ≤ 5000 items

Single pages to leave out, by full address.

manual syncs only on request. Recurring schedules accept daily, weekly, monthly, or every_N_days, every_N_weeks and every_N_months (1-90 days, 1-52 weeks, 1-12 months). Recurring schedules require a paid plan.

data.site.last_synced_atstringnullrequired

data.created_atstringrequired

data.updated_atstringrequired

request_idstringrequired

Change a site's rules

Authorizations

Path parameters

Body

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown