securityGateRun
Triggers a security gate execution for an asset
securityGateRun(
assetId: ID!
source: SecurityGateRuleSourceEnum
customRules: SecurityGateCustomRulesInput
branchId: ID
branchName: String
): SecurityGateExecution!
Arguments
securityGateRun.assetId ● ID! non-null scalar
securityGateRun.source ● SecurityGateRuleSourceEnum enum
securityGateRun.customRules ● SecurityGateCustomRulesInput input
securityGateRun.branchId ● ID scalar
Gate this branch instead of the asset's default branch
securityGateRun.branchName ● String scalar
Gate the branch with this name instead of the asset's default branch. Ignored when branchId is sent.
Type
SecurityGateExecution 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 assets query first and use data.assets.collection[].id as assetId.
- 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 GetSecurityGateRun($assetId: ID!) {\n securityGateRun(assetId: $assetId) { id status asset { id name activeDevelopers { __typename } } }\n}","variables":{"assetId":"<asset_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 GetSecurityGateRun($assetId: ID!) {\n securityGateRun(assetId: $assetId) { id status asset { id name activeDevelopers { __typename } } }\n}",
variables: {
"assetId": "<asset_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 GetSecurityGateRun($assetId: ID!) {\n securityGateRun(assetId: $assetId) { id status asset { id name activeDevelopers { __typename } } }\n}",
'variables': json.loads("{\"assetId\":\"<asset_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