Skip to main content
POST
/
v1
/
operations
/
dispatch-workflow-scan
Dispatch a managed workflow scan
curl --request POST \
  --url https://api.app.chainloop.dev/v1/operations/dispatch-workflow-scan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflow_id": "<string>",
  "version_name": "<string>"
}
'
import requests

url = "https://api.app.chainloop.dev/v1/operations/dispatch-workflow-scan"

payload = {
"workflow_id": "<string>",
"version_name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({workflow_id: '<string>', version_name: '<string>'})
};

fetch('https://api.app.chainloop.dev/v1/operations/dispatch-workflow-scan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.app.chainloop.dev/v1/operations/dispatch-workflow-scan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workflow_id' => '<string>',
'version_name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.app.chainloop.dev/v1/operations/dispatch-workflow-scan"

payload := strings.NewReader("{\n \"workflow_id\": \"<string>\",\n \"version_name\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.app.chainloop.dev/v1/operations/dispatch-workflow-scan")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_id\": \"<string>\",\n \"version_name\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.app.chainloop.dev/v1/operations/dispatch-workflow-scan")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_id\": \"<string>\",\n \"version_name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "operation_id": "operation_id"
}
{
"code": 0,
"details": [
"details",
"details"
],
"message": "message"
}
{
"code": 6,
"details": [
"details",
"details"
],
"message": "message"
}
{
"code": 1,
"details": [
"details",
"details"
],
"message": "message"
}
{
"code": 5,
"details": [
"details",
"details"
],
"message": "message"
}
{
"code": 5,
"details": [
{
"@type": "@type"
},
{
"@type": "@type"
}
],
"message": "message"
}

Authorizations

Authorization
string
header
required

Bearer token for authentication

Body

application/json
workflow_id
string

Workflow this dispatch attests under. The org, project, workflow name, and the task to run are all resolved server-side from this ID.

version_name
string

Project version this attestation records. Optional — when omitted, the version is resolved from the repository's .chainloop.yaml, falling back to the project's latest existing version.

Response

A successful response.

operation_id
string

ID of the AsyncOperation the caller polls via GetOperation.