Resolve SCA config and run ID - Gable Docs

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

POST

/ v0 /sca /start-run

Try it

Resolve SCA config and run ID

cURL

curl --request POST \
  --url https://demo-api.gable.ai/v0/sca/start-run \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '\n{\n  "code_info": {\n    "repo_uri": "<string>",\n    "repo_branch": "<string>",\n    "repo_commit": "<string>",\n    "project_root": "<string>",\n    "repo_ui_url": "<string>",\n    "external_component_id": "<string>",\n    "repo_name": "<string>",\n    "event_repo": "<string>",\n    "repo_commit_timestamp": "<string>",\n    "is_default_branch": true,\n    "namespace": "<string>",\n    "docker_image_version": "<string>",\n    "has_uncommitted_changes": true,\n    "operating_system": "<string>",\n    "sca_config_version": "<string>",\n    "scan_duration_ms": 123,\n    "raw_payload_size_bytes": 123,\n    "upload_duration_ms": 123,\n    "pr_base_branch": {\n      "branch": "<string>",\n      "commit": "<string>"\n    },\n    "pr_number": 123,\n    "gable_cli_version": "<string>",\n    "sca_prime_version": "<string>",\n    "dependencies": [\n      {\n        "repo_name": "<string>",\n        "commit_sha": "<string>",\n        "commit_timestamp": "<string>"\n      }\n    ]\n  },\n  "pr_link": "<string>",\n  "include_unchanged_assets": false,\n  "type": "CODE",\n  "run_id": "<string>",\n  "collection_mechanism": "BYOL"\n}

Python

import requests

url = "https://demo-api.gable.ai/v0/sca/start-run"

payload = {
    "code_info": {
        "repo_uri": "<string>",
        "repo_branch": "<string>",
        "repo_commit": "<string>",
        "project_root": "<string>",
        "repo_ui_url": "<string>",
        "external_component_id": "<string>",
        "repo_name": "<string>",
        "event_repo": "<string>",
        "repo_commit_timestamp": "<string>",
        "is_default_branch": True,
        "namespace": "<string>",
        "docker_image_version": "<string>",
        "has_uncommitted_changes": True,
        "operating_system": "<string>",
        "sca_config_version": "<string>",
        "scan_duration_ms": 123,
        "raw_payload_size_bytes": 123,
        "upload_duration_ms": 123,
        "pr_base_branch": {
            "branch": "<string>",
            "commit": "<string>"
        },
        "pr_number": 123,
        "gable_cli_version": "<string>",
        "sca_prime_version": "<string>",
        "dependencies": [\n            {\n                "repo_name": "<string>",\n                "commit_sha": "<string>",\n                "commit_timestamp": "<string>"\n            }\n        ]
    },
    "pr_link": "<string>",
    "include_unchanged_assets": False,
    "type": "CODE",
    "run_id": "<string>",
    "collection_mechanism": "BYOL"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

JavaScript

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    code_info: {
      repo_uri: '<string>',
      repo_branch: '<string>',
      repo_commit: '<string>',
      project_root: '<string>',
      repo_ui_url: '<string>',
      external_component_id: '<string>',
      repo_name: '<string>',
      event_repo: '<string>',
      repo_commit_timestamp: '<string>',
      is_default_branch: true,
      namespace: '<string>',
      docker_image_version: '<string>',
      has_uncommitted_changes: true,
      operating_system: '<string>',
      sca_config_version: '<string>',
      scan_duration_ms: 123,
      raw_payload_size_bytes: 123,
      upload_duration_ms: 123,
      pr_base_branch: {branch: '<string>', commit: '<string>'},
      pr_number: 123,
      gable_cli_version: '<string>',
      sca_prime_version: '<string>',
      dependencies: [{repo_name: '<string>', commit_sha: '<string>', commit_timestamp: '<string>'}]
    },
    pr_link: '<string>',
    include_unchanged_assets: false,
    type: 'CODE',
    run_id: '<string>',
    collection_mechanism: 'BYOL'
  })
};

fetch('https://demo-api.gable.ai/v0/sca/start-run', 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://demo-api.gable.ai/v0/sca/start-run",
  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([
    'code_info' => [
        'repo_uri' => '<string>',
        'repo_branch' => '<string>',
        'repo_commit' => '<string>',
        'project_root' => '<string>',
        'repo_ui_url' => '<string>',
        'external_component_id' => '<string>',
        'repo_name' => '<string>',
        'event_repo' => '<string>',
        'repo_commit_timestamp' => '<string>',
        'is_default_branch' => true,
        'namespace' => '<string>',
        'docker_image_version' => '<string>',
        'has_uncommitted_changes' => true,
        'operating_system' => '<string>',
        'sca_config_version' => '<string>',
        'scan_duration_ms' => 123,
        'raw_payload_size_bytes' => 123,
        'upload_duration_ms' => 123,
        'pr_base_branch' => [
                'branch' => '<string>',
                'commit' => '<string>'
        ],
        'pr_number' => 123,
        'gable_cli_version' => '<string>',
        'sca_prime_version' => '<string>',
        'dependencies' => [
                [
                                'repo_name' => '<string>',
                                'commit_sha' => '<string>',
                                'commit_timestamp' => '<string>'
                ]
        ]
    ],
    'pr_link' => '<string>',
    'include_unchanged_assets' => false,
    'type' => 'CODE',
    'run_id' => '<string>',
    'collection_mechanism' => 'BYOL'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

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

curl_close($curl);

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

Go

package main

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

func main() {

url := "https://demo-api.gable.ai/v0/sca/start-run"

payload := strings.NewReader("{\n  \"code_info\": {\n    \"repo_uri\": \"<string>\",\n    \"repo_branch\": \"<string>\",\n    \"repo_commit\": \"<string>\",\n    \"project_root\": \"<string>\",\n    \"repo_ui_url\": \"<string>\",\n    \"external_component_id\": \"<string>\",\n    \"repo_name\": \"<string>\",\n    \"event_repo\": \"<string>\",\n    \"repo_commit_timestamp\": \"<string>\",\n    \"is_default_branch\": true,\n    \"namespace\": \"<string>\",\n    \"docker_image_version\": \"<string>\",\n    \"has_uncommitted_changes\": true,\n    \"operating_system\": \"<string>\",\n    \"sca_config_version\": \"<string>\",\n    \"scan_duration_ms\": 123,\n    \"raw_payload_size_bytes\": 123,\n    \"upload_duration_ms\": 123,\n    \"pr_base_branch\": {\n      \"branch\": \"<string>\",\n      \"commit\": \"<string>\"\n    },\n    \"pr_number\": 123,\n    \"gable_cli_version\": \"<string>\",\n    \"sca_prime_version\": \"<string>\",\n    \"dependencies\": [\n      {\n        \"repo_name\": \"<string>\",\n        \"commit_sha\": \"<string>\",\n        \"commit_timestamp\": \"<string>\"\n      }\n    ]\n  },\n  \"pr_link\": \"<string>\",\n  \"include_unchanged_assets\": false,\n  \"type\": \"CODE\",\n  \"run_id\": \"<string>\",\n  \"collection_mechanism\": \"BYOL\"}")

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

req.Header.Add("X-API-KEY", "<api-key>")
    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))
}

Response

200

application/json

The SCA config and canonical run ID for this upload

The response from the postScaStartRun function

{
  "runId": "<string>",
  "config": {
    "config_type": "<string>",
    "project_root": "<string>",
    "version": "<string>",
    "config_value": {},
    "namespace": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "language": "<string>",
    "repo": "<string>"
  }
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}