triggerAstScan

Triggers an AST scan for a repository asset on the customer pipeline

triggerAstScan(
  input: TriggerAstScanInput!
): TriggerAstScanPayload

Arguments

triggerAstScan.input ● TriggerAstScanInput! non-null input

Parameters for TriggerAstScan

Type

TriggerAstScanPayload object

Autogenerated return type of TriggerAstScan.

Example request

This generated mutation uses placeholders for required values. Replace them with values available to your API key before running it.

Before you run it

Run the assets query first and use data.assets.collection[].id as assetId.

cURL

curl --request POST https://api.convisoappsec.com/graphql \
  --header "x-api-key: $CONVISO_API_KEY" \
  --header "content-type: application/json" \
  --data '{"query":"mutation MutateTriggerAstScan($input: TriggerAstScanInput!) {\n  triggerAstScan(input: $input) { clientMutationId failureReason scanRun { id asset { __typename } assetId } }\n}","variables":{"input":{"assetId":"<asset_id>"}}}'

JavaScript

const response = await fetch('https://api.convisoappsec.com/graphql', {
  method: 'POST',
  headers: {
    'content-type': 'application/json',
    'x-api-key': process.env.CONVISO_API_KEY,
  },
  body: JSON.stringify({
    query: "mutation MutateTriggerAstScan($input: TriggerAstScanInput!) {\n  triggerAstScan(input: $input) { clientMutationId failureReason scanRun { id asset { __typename } assetId } }\n}",
    variables: {
    "input": {
        "assetId": "<asset_id>"
    }
},
  }),
});

const { data, errors } = await response.json();

if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);

Python

import json
import os
import requests

response = requests.post(
    'https://api.convisoappsec.com/graphql',
    headers={
        'content-type': 'application/json',
        'x-api-key': os.environ['CONVISO_API_KEY'],
    },
    json={
        'query': "mutation MutateTriggerAstScan($input: TriggerAstScanInput!) {\n  triggerAstScan(input: $input) { clientMutationId failureReason scanRun { id asset { __typename } assetId } }\n}",
        'variables': json.loads("{\"input\":{\"assetId\":\"<asset_id>\"}}"),
    },
    timeout=30,
)
response.raise_for_status()

payload = response.json()
if payload.get('errors'):
    raise RuntimeError(payload['errors'])

print(payload['data'])