controlPentestSession

Analyst holds, releases, stops a step or steers an assisted run

controlPentestSession(
  input: ControlPentestSessionInput!
): ControlPentestSessionPayload

Arguments

controlPentestSession.input ● ControlPentestSessionInput! non-null input

Parameters for ControlPentestSession

Type

ControlPentestSessionPayload object

Autogenerated return type of ControlPentestSession.

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 MutateControlPentestSession($input: ControlPentestSessionInput!) {\n  controlPentestSession(input: $input) { clientMutationId pentestSession { id commands { __typename } createdAt } }\n}","variables":{"input":{"executionId":"<execution_id>","action":"example"}}}'

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 MutateControlPentestSession($input: ControlPentestSessionInput!) {\n  controlPentestSession(input: $input) { clientMutationId pentestSession { id commands { __typename } createdAt } }\n}",
    variables: {
    "input": {
        "executionId": "<execution_id>",
        "action": "example"
    }
},
  }),
});

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 MutateControlPentestSession($input: ControlPentestSessionInput!) {\n  controlPentestSession(input: $input) { clientMutationId pentestSession { id commands { __typename } createdAt } }\n}",
        'variables': json.loads("{\"input\":{\"executionId\":\"<execution_id>\",\"action\":\"example\"}}"),
    },
    timeout=30,
)
response.raise_for_status()

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

print(payload['data'])