Skip to main content
posthttps://your-instance.example.com/api/parse
Request example
Response
posthttps://your-instance.example.com/api/parse

Authorization

Authorizationstringheaderrequired#
API key generated from Personal Settings. See Authentication.

Body

application/json
repoUrlstringrequired#
HTTPS URL of the GitHub or GitLab repository
branchstring#
Branch to parse. Defaults to the repository's default branch
foldersstring[]#
Only index files under these paths. Empty means the entire repository
excludeFoldersstring[]#
Paths to skip during indexing
excludeFilesstring[]#
Glob patterns for files to exclude
forceboolean#
Re-parse even if the current commit is already indexed

Default: false

Responses

application/json
Parse job accepted and queued
messagestringrequired#

Example:"Parse queued"

projectstringrequired#
Project identifier assigned to this library (e.g. /your-org/your-repo)

Example:"/your-org/your-repo"

queueIdintegerrequired#
Numeric ID for this parse job

Example:5

positioninteger#
Position in the queue. null if the job started immediately

Example:1