updatePentestSessionState

Agent echoes the current phase and step of an assisted run

updatePentestSessionState(
  input: UpdatePentestSessionStateInput!
): UpdatePentestSessionStatePayload

Arguments

updatePentestSessionState.input ● UpdatePentestSessionStateInput! non-null input

Parameters for UpdatePentestSessionState

Type

UpdatePentestSessionStatePayload object

Autogenerated return type of UpdatePentestSessionState.

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

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

print(payload['data'])