Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Trigger Scan

POST
/registry/v1/workspaces/{workspace}/engines/qibdo/namespaces/{namespace}/repositories/{repository}/artifacts/{reference}/scan
 
curl --request POST \
  --url https://example.com/registry/v1/workspaces/example/engines/qibdo/namespaces/example/repositories/example/artifacts/example/scan \
  --header 'Content-Type: application/json' \
  --data '{ "workspace": "example", "namespace": "example", "repository": "example", "reference": "example" }'

Asks the configured scanner to begin a vulnerability scan against an artifact. The call returns immediately with a RegistryOperation; the report becomes available asynchronously and is fetched via GetScanReport once the scan completes.

Custom methods use body: "*" per AIP-136. Path parameters (workspace, namespace, repository, reference) are extracted from the URL; any future non-path fields are deserialized from the HTTP body. Follows industry practice from GCP, AWS, and Azure.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace
required
string

The unique identifier of the workspace that the repository belongs to

namespace
required
string

The unique identifier of the namespace that the repository belongs to

repository
required
string

The unique identifier of the parent repository

reference
required
string

Digest or tag identifying the artifact to scan

Request Body required

Section titled “Request Body required ”
Media type application/json

TriggerScanRequest

Request message for TriggerScan. Identifies the artifact to scan; reference is digest or tag.

object
workspace
required

The unique identifier of the workspace that the repository belongs to

string
namespace
required

The unique identifier of the namespace that the repository belongs to

string
repository
required

The unique identifier of the parent repository

string
reference
required

Digest or tag identifying the artifact to scan

string
Example generated
{
  "workspace": "example",
  "namespace": "example",
  "repository": "example",
  "reference": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
id
stringOutput only
resource_id
stringOutput only
resource_type
stringOutput only
operation_type
string format: enum Output only
Allowed values: REGISTRY_OPERATION_TYPE_UNSPECIFIED REGISTRY_OPERATION_TYPE_CREATE REGISTRY_OPERATION_TYPE_UPDATE REGISTRY_OPERATION_TYPE_DELETE REGISTRY_OPERATION_TYPE_TRIGGER
status
string format: enum Output only
Allowed values: REGISTRY_OPERATION_STATUS_UNSPECIFIED REGISTRY_OPERATION_STATUS_PENDING REGISTRY_OPERATION_STATUS_RUNNING REGISTRY_OPERATION_STATUS_DONE REGISTRY_OPERATION_STATUS_ERROR
insert_time
string format: date-time Output only
start_time
string format: date-time Output only
end_time
string format: date-time Output only
errors
Array<object>Output only
object
code
integer format: uint32
description
string
warnings
Array<object>Output only
object
code
integer format: uint32
description
string
progress
integer format: int32 Output only
Example 
{
  "operation_type": "REGISTRY_OPERATION_TYPE_UNSPECIFIED",
  "status": "REGISTRY_OPERATION_STATUS_UNSPECIFIED"
}

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}