securityGateCoverageAssets
Returns the repositories in one security gate coverage state
securityGateCoverageAssets(
companyId: ID!
params: FilterParams
state: SecurityGateCoverageStateEnum!
pagination: BasePaginationInput
search: String
sortOption: SecurityGateCoverageSortOptionInput
): SecurityGateCoverageAssetCollection!
Arguments
securityGateCoverageAssets.companyId ● ID! non-null scalar
securityGateCoverageAssets.params ● FilterParams input
securityGateCoverageAssets.state ● SecurityGateCoverageStateEnum! non-null enum
securityGateCoverageAssets.pagination ● BasePaginationInput input
Defaults to the first page of 30
securityGateCoverageAssets.search ● String scalar
Part of the asset name
securityGateCoverageAssets.sortOption ● SecurityGateCoverageSortOptionInput input
Applied before the asset name
Type
SecurityGateCoverageAssetCollection object
SecurityGateCoverageAssetCollection type
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 GetSecurityGateCoverageAssets($companyId: ID!, $state: SecurityGateCoverageStateEnum!) {\n securityGateCoverageAssets(companyId: $companyId, state: $state) { collection { assetId assetName configurationOwner } metadata { currentPage limitValue totalCount } }\n}","variables":{"companyId":"<company_id>","state":"COVERED"}}'
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 GetSecurityGateCoverageAssets($companyId: ID!, $state: SecurityGateCoverageStateEnum!) {\n securityGateCoverageAssets(companyId: $companyId, state: $state) { collection { assetId assetName configurationOwner } metadata { currentPage limitValue totalCount } }\n}",
variables: {
"companyId": "<company_id>",
"state": "COVERED"
},
}),
});
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 GetSecurityGateCoverageAssets($companyId: ID!, $state: SecurityGateCoverageStateEnum!) {\n securityGateCoverageAssets(companyId: $companyId, state: $state) { collection { assetId assetName configurationOwner } metadata { currentPage limitValue totalCount } }\n}",
'variables': json.loads("{\"companyId\":\"<company_id>\",\"state\":\"COVERED\"}"),
},
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