cancelPentestExecution

Cancel a running AI Pentest execution

cancelPentestExecution(
  input: CancelPentestExecutionInput!
): CancelPentestExecutionPayload

Arguments

cancelPentestExecution.input ● CancelPentestExecutionInput! non-null input

Parameters for CancelPentestExecution

Type

CancelPentestExecutionPayload object

Autogenerated return type of CancelPentestExecution.

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 MutateCancelPentestExecution($input: CancelPentestExecutionInput!) {\n  cancelPentestExecution(input: $input) { clientMutationId pentestExecution { id status createdAt } }\n}","variables":{"input":{"id":"example-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 MutateCancelPentestExecution($input: CancelPentestExecutionInput!) {\n  cancelPentestExecution(input: $input) { clientMutationId pentestExecution { id status createdAt } }\n}",
    variables: {
    "input": {
        "id": "example-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 MutateCancelPentestExecution($input: CancelPentestExecutionInput!) {\n  cancelPentestExecution(input: $input) { clientMutationId pentestExecution { id status createdAt } }\n}",
        'variables': json.loads("{\"input\":{\"id\":\"example-id\"}}"),
    },
    timeout=30,
)
response.raise_for_status()

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

print(payload['data'])