saltSecurityConfiguration
DEPRECATED
Use saltSecurityConfigurations, which supports N environments per company
Gets one Salt Security environment. Raises when the company has several and none is named — use saltSecurityConfigurations instead.
saltSecurityConfiguration(
companyId: ID!
integrationId: ID
): SaltSecurityIntegration! @deprecated
Arguments
saltSecurityConfiguration.companyId ● ID! non-null scalar
saltSecurityConfiguration.integrationId ● ID scalar
Required once the company has more than one Salt environment.
Type
SaltSecurityIntegration object
Example request
This generated query 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
- JavaScript
- Python
curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"query GetSaltSecurityConfiguration($companyId: ID!) {\n saltSecurityConfiguration(companyId: $companyId) { id name assetsCount }\n}","variables":{"companyId":"<company_id>"}}'
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: "query GetSaltSecurityConfiguration($companyId: ID!) {\n saltSecurityConfiguration(companyId: $companyId) { id name assetsCount }\n}",
variables: {
"companyId": "<company_id>"
},
}),
});
const { data, errors } = await response.json();
if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);
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': "query GetSaltSecurityConfiguration($companyId: ID!) {\n saltSecurityConfiguration(companyId: $companyId) { id name assetsCount }\n}",
'variables': json.loads("{\"companyId\":\"<company_id>\"}"),
},
timeout=30,
)
response.raise_for_status()
payload = response.json()
if payload.get('errors'):
raise RuntimeError(payload['errors'])
print(payload['data'])
Contribute to the Docs
Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.
How to contribute