Get scan status

GET

/scans/{scanId}

curl --request GET \
  --url https://api.invogi.com/v1/scans/example \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearerAuth

Parameters

Path Parameters

scanId

required

string

Responses

200

Scan

Media typeapplication/json

object

id

required

string

status

required

string

Allowed values: CREATED UPLOADED MAPPING_REQUIRED IMPORTING ANALYZING COMPLETE FAILED

rowCount

integer

createdAt

string format: date-time

completedAt

string | null format: date-time

Example

{
  "status": "CREATED"
}

401

Missing or invalid API key

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}

404

Resource not found

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}