Scan TasksUpdate scan task status
Scan Tasks

Update scan task status

Updates the status of an existing scan task.

curl -X PATCH "https://api.neostra.io/api/v1/scan-tasks/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -d '{
  "status": "PENDING"
}'
{
  "status": 200,
  "message": "Success",
  "data": {},
  "errors": [
    "example_string"
  ]
}
PATCH
/api/v1/scan-tasks/{taskId}
PATCH
Bearer Token (JWT)
Bearer Tokenstring
Required

JWT bearer token for authentication

JWT bearer token for authentication
path
taskIdstring
Required

The scan task identifier

Content-Typestring
Required

The media type of the request body

Options: application/json
statusstring
Required

New status of the scan task

Options: PENDING, RUNNING, COMPLETED, FAILED, CANCELLED
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). JWT bearer token for authentication

Path Parameters

taskIdstring
Required

The scan task identifier

Body

application/json
statusstring
Required

New status of the scan task

Allowed values:PENDINGRUNNINGCOMPLETEDFAILEDCANCELLED

Responses

statusinteger

HTTP status code

messagestring

Response message

dataobject

Response payload

errorsstring[]

List of error details, if any