Skip to main content
POST
/
api
/
v4
/
products
/
{productId}
/
images
/
{imageId}
/
scans
/
{scanId}
/
states
{
  "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "createTime": "2024-01-01T01:00:00Z",
  "author": {
    "userId": "<string>",
    "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "createTime": "2024-01-01T01:00:00Z",
    "email": "[email protected]",
    "status": "active",
    "resourceType": "Org"
  },
  "parent": "<string>",
  "latestScanState": {
    "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "type": "new",
    "createTime": "2024-01-01T01:00:00Z",
    "parent": "<string>",
    "author": {
      "userId": "<string>",
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "createTime": "2024-01-01T01:00:00Z",
      "email": "[email protected]",
      "status": "active",
      "resourceType": "Org"
    },
    "source": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
productId
string<ulid>
required

Product ID

Required string length: 26
Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

​
imageId
string<ulid>
required

Image ID

Required string length: 26
Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

​
scanId
string<ulid>
required

Scan ID

Required string length: 26
Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

Body

application/json
​
type
enum<string>
required
Available options:
new,
running,
failed,
done,
cancelled

Response

success

​
id
string<ulid>
required
Required string length: 26
Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

​
createTime
string
required
Example:

"2024-01-01T01:00:00Z"

​
author
object
required
​
parent
string<path>

URI path (path-noscheme) without the leading /

​
latestScanState
object