updateScanRun

Update a Scan Run

updateScanRun(
  input: UpdateScanRunInput!
): UpdateScanRunPayload

Arguments

updateScanRun.input ● UpdateScanRunInput! non-null input

Parameters for UpdateScanRun

Type

UpdateScanRunPayload object

Autogenerated return type of UpdateScanRun.

Example request

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

cURL

curl --request POST https://api.convisoappsec.com/graphql \
  --header "x-api-key: $CONVISO_API_KEY" \
  --header "content-type: application/json" \
  --data '{"query":"mutation MutateUpdateScanRun($input: UpdateScanRunInput!) {\n  updateScanRun(input: $input) { clientMutationId errors scanRun { id asset { __typename } assetId } }\n}","variables":{"input":{"id":"example-id","state":"REQUESTED"}}}'

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 MutateUpdateScanRun($input: UpdateScanRunInput!) {\n  updateScanRun(input: $input) { clientMutationId errors scanRun { id asset { __typename } assetId } }\n}",
    variables: {
    "input": {
        "id": "example-id",
        "state": "REQUESTED"
    }
},
  }),
});

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 MutateUpdateScanRun($input: UpdateScanRunInput!) {\n  updateScanRun(input: $input) { clientMutationId errors scanRun { id asset { __typename } assetId } }\n}",
        'variables': json.loads("{\"input\":{\"id\":\"example-id\",\"state\":\"REQUESTED\"}}"),
    },
    timeout=30,
)
response.raise_for_status()

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

print(payload['data'])