Refresh a library

Re-parse an existing library using its stored settings

POST /projects/{projectId}/refresh

Refresh a library

cURL

curl --request POST \
  --url https://your-instance.example.com/api/projects/{projectId}/refresh \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://your-instance.example.com/api/projects/{projectId}/refresh"

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

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

print(response.text)

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

fetch('https://your-instance.example.com/api/projects/{projectId}/refresh', 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/projects/{projectId}/refresh",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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/projects/{projectId}/refresh"

	req, _ := http.NewRequest("POST", 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.post("https://your-instance.example.com/api/projects/{projectId}/refresh")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-instance.example.com/api/projects/{projectId}/refresh")

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

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

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

202

Example

{
  "message": "Parse queued",
  "project": "/your-org/your-repo",
  "queueId": 5,
  "position": 1
}

Authorizations

Authorization · string · header · required

API key generated from Personal Settings. See Authentication.

Path Parameters

projectId · string · required

Project identifier without the leading slash. For repositories use owner/repo (e.g. upstash/ratelimit-js). For websites use websites/hostname (e.g. websites/upstash). For OpenAPI specs use openapi/derived-name.

Response

202

application/json

Parse job accepted and queued

message · string · required

Example:

"Parse queued"

project · string · required

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

Example:

"/your-org/your-repo"

queueId · integer · required

Numeric ID for this parse job

Example:

5

position · integer | null

Position in the queue. null if the job started immediately

Example:

1