astConfig
Returns AST V2 configuration
astConfig(
companyId: ID!
assetId: ID
branchId: ID
branchName: String
integrationId: ID
includeCustomRules: Boolean = false
dryRun: Boolean
): AstConfig
Arguments
astConfig.companyId ● ID! non-null scalar
astConfig.assetId ● ID scalar
astConfig.branchId ● ID scalar
Resolves the configuration this branch runs with (branch -> asset -> company -> global). Requires asset_id.
astConfig.branchName ● String scalar
Same as branchId, for a caller that only knows the branch by name -- the AST CLI, which reads it off the checkout. Requires asset_id, is mutually exclusive with branchId, and resolves to the asset-level configuration when the asset has no branch by that name.
astConfig.integrationId ● ID scalar
Resolves a GitHub organization's configuration (organization -> company -> global), for its module selection. Excludes asset_id.
astConfig.includeCustomRules ● Boolean scalar
astConfig.dryRun ● Boolean scalar
true needs run_ast, false needs write_ast_results; left out, the caller must be an Admin.
Type
AstConfig object
Example request
This generated query uses placeholders for required values. Replace them with values available to your API key before running 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 GetAstConfig($companyId: ID!) {\n astConfig(companyId: $companyId) { config }\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 GetAstConfig($companyId: ID!) {\n astConfig(companyId: $companyId) { config }\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 GetAstConfig($companyId: ID!) {\n astConfig(companyId: $companyId) { config }\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