createCspmIntegration

Create a CSPM integration (Prowler engine or aggregator)

createCspmIntegration(
  input: CreateCspmIntegrationInput!
): CreateCspmIntegrationPayload

Arguments

createCspmIntegration.input ● CreateCspmIntegrationInput! non-null input

Parameters for CreateCspmIntegration

Type

CreateCspmIntegrationPayload object

Autogenerated return type of CreateCspmIntegration.

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 companies query first and use data.companies.collection[].id as companyId.

cURL

curl --request POST https://api.convisoappsec.com/graphql \
  --header "x-api-key: $CONVISO_API_KEY" \
  --header "content-type: application/json" \
  --data '{"query":"mutation MutateCreateCspmIntegration($input: CreateCspmIntegrationInput!) {\n  createCspmIntegration(input: $input) { clientMutationId cspmIntegration { id status cloudAccounts { __typename } } errors }\n}","variables":{"input":{"companyId":1,"tool":"example","mode":"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 MutateCreateCspmIntegration($input: CreateCspmIntegrationInput!) {\n  createCspmIntegration(input: $input) { clientMutationId cspmIntegration { id status cloudAccounts { __typename } } errors }\n}",
    variables: {
    "input": {
        "companyId": 1,
        "tool": "example",
        "mode": "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 MutateCreateCspmIntegration($input: CreateCspmIntegrationInput!) {\n  createCspmIntegration(input: $input) { clientMutationId cspmIntegration { id status cloudAccounts { __typename } } errors }\n}",
        'variables': json.loads("{\"input\":{\"companyId\":1,\"tool\":\"example\",\"mode\":\"example\"}}"),
    },
    timeout=30,
)
response.raise_for_status()

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

print(payload['data'])