syncStatus
Returns sync status of a external scan
syncStatus(
assetId: ID!
integration: ToolTypeCategory!
startDate: ISO8601DateTime
): ScannersSyncStatus
Arguments
syncStatus.assetId ● ID! non-null scalar
syncStatus.integration ● ToolTypeCategory! non-null enum
syncStatus.startDate ● ISO8601DateTime scalar
Filter records by dates greater than this value
Type
ScannersSyncStatus 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 GetSyncStatus($assetId: ID!, $integration: ToolTypeCategory!) {\n syncStatus(assetId: $assetId, integration: $integration) { status failureReason }\n}","variables":{"assetId":"<asset_id>","integration":"CONVISO_AST"}}'
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 GetSyncStatus($assetId: ID!, $integration: ToolTypeCategory!) {\n syncStatus(assetId: $assetId, integration: $integration) { status failureReason }\n}",
variables: {
"assetId": "<asset_id>",
"integration": "CONVISO_AST"
},
}),
});
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 GetSyncStatus($assetId: ID!, $integration: ToolTypeCategory!) {\n syncStatus(assetId: $assetId, integration: $integration) { status failureReason }\n}",
'variables': json.loads("{\"assetId\":\"<asset_id>\",\"integration\":\"CONVISO_AST\"}"),
},
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