Assets and applications
Use this page to manage an asset inventory. Start with the company scope, then reuse returned IDs in the mutations.
List applications
List applications in a company
This generated query uses placeholders for required values. Replace them with values available to your API key before running it.
- 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 GetApplications($companyId: ID!) {\n applications(companyId: $companyId) {\n id\n name\n }\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 GetApplications($companyId: ID!) {\n applications(companyId: $companyId) {\n id\n name\n }\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 GetApplications($companyId: ID!) {\n applications(companyId: $companyId) {\n id\n name\n }\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'])
List assets
List assets in a company
This generated query uses placeholders for required values. Replace them with values available to your API key before running it.
Use collection[].id as <asset_id> for update or archive operations.
- 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 GetAssets($companyId: ID!) {\n assets(companyId: $companyId) {\n collection { id name }\n metadata { currentPage limitValue totalCount }\n }\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 GetAssets($companyId: ID!) {\n assets(companyId: $companyId) {\n collection { id name }\n metadata { currentPage limitValue totalCount }\n }\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 GetAssets($companyId: ID!) {\n assets(companyId: $companyId) {\n collection { id name }\n metadata { currentPage limitValue totalCount }\n }\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'])
Create or update an asset
The exact optional fields depend on the asset type. The reference exposes the
complete CreateAssetInput and UpdateAssetInput shapes.
Create an asset
This generated mutation uses placeholders for required values. Replace them with values available to your API key before running it.
- 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":"mutation CreateAsset($input: CreateAssetInput!) {\n createAsset(input: $input) {\n errors\n asset { id name }\n }\n}","variables":{"input":{"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: "mutation CreateAsset($input: CreateAssetInput!) {\n createAsset(input: $input) {\n errors\n asset { id name }\n }\n}",
variables: {
"input": {
"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': "mutation CreateAsset($input: CreateAssetInput!) {\n createAsset(input: $input) {\n errors\n asset { id name }\n }\n}",
'variables': json.loads("{\"input\":{\"companyId\":\"<company_id>\"}}"),
},
timeout=30,
)
response.raise_for_status()
payload = response.json()
if payload.get('errors'):
raise RuntimeError(payload['errors'])
print(payload['data'])
Update an asset
This generated mutation uses placeholders for required values. Replace them with values available to your API key before running it.
- 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":"mutation UpdateAsset($input: UpdateAssetInput!) {\n updateAsset(input: $input) {\n asset { id name }\n }\n}","variables":{"input":{"companyId":"<company_id>","id":"<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: "mutation UpdateAsset($input: UpdateAssetInput!) {\n updateAsset(input: $input) {\n asset { id name }\n }\n}",
variables: {
"input": {
"companyId": "<company_id>",
"id": "<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': "mutation UpdateAsset($input: UpdateAssetInput!) {\n updateAsset(input: $input) {\n asset { id name }\n }\n}",
'variables': json.loads("{\"input\":{\"companyId\":\"<company_id>\",\"id\":\"<asset_id>\"}}"),
},
timeout=30,
)
response.raise_for_status()
payload = response.json()
if payload.get('errors'):
raise RuntimeError(payload['errors'])
print(payload['data'])
Archive assets
Archiving removes assets from active use while retaining their history.
Archive selected assets
This generated mutation uses placeholders for required values. Replace them with values available to your API key before running it.
- 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":"mutation ArchiveAssets($input: ArchiveAssetsInput!) {\n archiveAssets(input: $input) {\n clientMutationId\n }\n}","variables":{"input":{"companyId":"<company_id>","assetIds":["<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: "mutation ArchiveAssets($input: ArchiveAssetsInput!) {\n archiveAssets(input: $input) {\n clientMutationId\n }\n}",
variables: {
"input": {
"companyId": "<company_id>",
"assetIds": [
"<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': "mutation ArchiveAssets($input: ArchiveAssetsInput!) {\n archiveAssets(input: $input) {\n clientMutationId\n }\n}",
'variables': json.loads("{\"input\":{\"companyId\":\"<company_id>\",\"assetIds\":[\"<asset_id>\"]}}"),
},
timeout=30,
)
response.raise_for_status()
payload = response.json()
if payload.get('errors'):
raise RuntimeError(payload['errors'])
print(payload['data'])
For advanced asset, repository, and branch operations, use the complete schema.
Contribute to the Docs
Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.
How to contribute