v1

latestOpenAPI 3.0.02026-07-263039205.4 KB

Custom

Create or Update a Custom API

Create or update the parameters and ruleset of an existing Custom API

post/custom

Request body

notesstring[]

An array of strings that can be added manually. The API automatically adds a notes specifying when the API was last updated.

apistring

The specific API being targeted. Always precede the API name with "/api/" as in "/api/article" except for "all")

urlPatternstring

A regex that defines the URLs for which the ruleset will be applied

testUrlstring

A URL that can be used to check that the rule still works as intended. This is the page that will load automatically when editing the ruleset in the Dashboard UI

renderOptionsstring

Rendering options

prefiltersstring[]

An array of string selectors that should be omitted from the DOM before extraction occurs

useProxystring

Used to disable proxies (when they have been set globally), by applying the value "none"

Response

Successful API Response

hashesstring[]