Skip to main content
POST
/
v0
/
sca
/
start-run
Start a new SCA run
curl --request POST \
  --url https://{hostname}.gable.ai/v0/sca/start-run \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "code_info": {
    "repo_uri": "<string>",
    "repo_branch": "<string>",
    "repo_commit": "<string>",
    "project_root": "<string>",
    "external_component_id": "<string>",
    "repo_name": "<string>"
  },
  "sca_info": {
    "name": "<string>",
    "version": "<string>",
    "config": {
      "ingress_signatures": [
        {
          "class_names": [
            "<string>"
          ],
          "method_names": [
            "<string>"
          ],
          "kind": "<string>"
        }
      ],
      "egress_signatures": [
        {
          "class_names": [
            "<string>"
          ],
          "method_names": [
            "<string>"
          ],
          "kind": "<string>"
        }
      ]
    }
  },
  "action": "register",
  "pr_link": "<string>",
  "include_unchanged_assets": false,
  "output_format": "json",
  "type": "CODE"
}'
{
  "runId": "<string>",
  "s3PresignedUrl": {
    "url": "<string>",
    "fields": {}
  },
  "config": {
    "config_type": "<string>",
    "language": "<string>",
    "repo": "<string>",
    "project_root": "<string>",
    "version": "<string>",
    "config_value": {},
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-API-KEY
string
header
required

Body

application/json
code_info
object
required
action
enum<string>
required
Available options:
register,
check,
upload
sca_info
object
include_unchanged_assets
boolean
default:false
output_format
enum<string>
Available options:
json,
text,
markdown
type
enum<string>
default:CODE
Available options:
CODE,
DATA_STORE,
EDGE

Response

runId
string
required
s3PresignedUrl
object
config
object