Refresh a library

Re-parse an existing library using its stored settings

1 min read

posthttps://your-instance.example.com/api/projects/{projectId}/refresh

Request example

curl --request POST \
  --url https://your-instance.example.com/api/projects/upstash%2Fratelimit-js/refresh

Response

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

posthttps://your-instance.example.com/api/projects/{projectId}/refresh

Path parameters

projectIdstringrequired#

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.

Responses

application/json

Parse job accepted and queued

messagestringrequired#

projectstringrequired#

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

queueIdintegerrequired#

Numeric ID for this parse job

positioninteger#

Position in the queue. null if the job started immediately

Parse a website Get parse status