Get parse status

Returns the status of all active and queued parse jobs

GET /parse-status

Get parse status

cURL

curl --request GET \
  --url https://your-instance.example.com/api/parse-status \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://your-instance.example.com/api/parse-status"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://your-instance.example.com/api/parse-status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://your-instance.example.com/api/parse-status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://your-instance.example.com/api/parse-status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://your-instance.example.com/api/parse-status")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-instance.example.com/api/parse-status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "activeParses": {
    "/your-org/your-repo": {
      "status": "parsing",
      "startedAt": "2025-01-01T12:00:00.000Z",
      "duration": 8.6,
      "statusMessage": "Scanning 16 files"
    },
    "/other-org/other-repo": {
      "status": "queued",
      "position": 1,
      "createdAt": "2025-01-01T12:00:01.000Z"
    }
  }
}

{
  "error": "Authentication required"
}

{
  "error": "An unexpected error occurred"
}

Authorizations

Authorization · string · header · required

API key generated from Personal Settings. See Authentication.

Response

200

application/json

Active parse jobs and their status

activeParses · object · required

Map of project name to its current parse job status

Show child attributes