Skip to main content
POST
Create or subscribe to a source

Authorizations

x-api-key
string
header
required

Bulkgrid API key

Body

application/json
type
enum<string>
required
Available options:
domain
identifier
string
required
workspace_id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
label
string
visibility
enum<string>
Available options:
public,
private
source_mode
enum<string>
Available options:
discover,
selected_pages
crawl_config
object
metadata
object
crawl_interval
enum<string>
Available options:
hourly,
daily,
weekly,
monthly,
custom
custom_interval_minutes
number
analysis_id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Successful response

source
object
required
created
boolean
required