Skip to main content
POST
Create or subscribe to a GitHub source

Authorizations

x-api-key
string
header
required

Bulkgrid API key

Body

application/json
repositoryUrl
string<uri>
required
visibility
enum<string>
default:private
Available options:
public,
private
public_source_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)$
connection_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)$
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)$
ref
string
Required string length: 1 - 255
includePaths
string[]
Maximum array length: 100
Required string length: 1 - 1024
excludePaths
string[]
Maximum array length: 100
Required string length: 1 - 1024
label
string
Required string length: 1 - 200
canonical_url
string | null
crawl_interval
enum<string>
default:weekly
Available options:
daily,
weekly,
monthly

Response

Successful response

source
object
required
run
object | null
required
dispatchDeferred
boolean
required
created
boolean