Skip to main content
GET
/
api
/
v1
/
codemaps
/
{indexName}
/
status
Get generation status
curl --request GET \
  --url https://neo.api.projectdiscovery.io/api/v1/codemaps/{indexName}/status \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "commit_sha": "<string>",
  "completed_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "freshness": {
    "index_age_seconds": 123,
    "is_stale": true,
    "indexed_at": "2023-11-07T05:31:56Z",
    "indexed_branch": "<string>",
    "indexed_commit_sha": "<string>"
  },
  "generation_id": "<string>",
  "index_name": "<string>",
  "modules_generated": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "total_modules": 123,
  "wiki_progress": {}
}

Authorizations

Authorization
string
header
required

JWT authentication token

Path Parameters

indexName
string
required

Response

Status response

status
enum<string>
required
Available options:
pending,
running,
ready,
failed
success
boolean
required
commit_sha
string
completed_at
string<date-time>
error_message
string
freshness
object
generation_id
string
index_name
string
modules_generated
integer
started_at
string<date-time>
total_modules
integer
wiki_progress
object