Update an information asset
curl --request PATCH \
--url https://api.trycomp.ai/v1/assets/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "Production PostgreSQL (AWS RDS)",
"description": "Primary application database holding patient records",
"type": "cloud_resource",
"status": "active",
"location": "AWS us-east-1",
"ephiCreated": true,
"ephiReceived": true,
"ephiMaintained": true,
"ephiTransmitted": true,
"dataDescription": "Patient demographics, lab results",
"vendorId": "vnd_abc123def456",
"integrationConnectionId": "icn_abc123def456",
"ownerId": "mem_abc123def456",
"sourceKey": "vendor:vnd_abc123def456",
"riskIds": [
"rsk_abc123def456"
]
}
'const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Production PostgreSQL (AWS RDS)',
description: 'Primary application database holding patient records',
type: 'cloud_resource',
status: 'active',
location: 'AWS us-east-1',
ephiCreated: true,
ephiReceived: true,
ephiMaintained: true,
ephiTransmitted: true,
dataDescription: 'Patient demographics, lab results',
vendorId: 'vnd_abc123def456',
integrationConnectionId: 'icn_abc123def456',
ownerId: 'mem_abc123def456',
sourceKey: 'vendor:vnd_abc123def456',
riskIds: ['rsk_abc123def456']
})
};
fetch('https://api.trycomp.ai/v1/assets/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.trycomp.ai/v1/assets/{id}"
payload = {
"name": "Production PostgreSQL (AWS RDS)",
"description": "Primary application database holding patient records",
"type": "cloud_resource",
"status": "active",
"location": "AWS us-east-1",
"ephiCreated": True,
"ephiReceived": True,
"ephiMaintained": True,
"ephiTransmitted": True,
"dataDescription": "Patient demographics, lab results",
"vendorId": "vnd_abc123def456",
"integrationConnectionId": "icn_abc123def456",
"ownerId": "mem_abc123def456",
"sourceKey": "vendor:vnd_abc123def456",
"riskIds": ["rsk_abc123def456"]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)Assets
Update an information asset | Comp AI API
Updates an asset in the ePHI inventory. riskIds replaces the full set of linked risks; omit it to leave links unchanged.
PATCH
/
v1
/
assets
/
{id}
Update an information asset
curl --request PATCH \
--url https://api.trycomp.ai/v1/assets/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "Production PostgreSQL (AWS RDS)",
"description": "Primary application database holding patient records",
"type": "cloud_resource",
"status": "active",
"location": "AWS us-east-1",
"ephiCreated": true,
"ephiReceived": true,
"ephiMaintained": true,
"ephiTransmitted": true,
"dataDescription": "Patient demographics, lab results",
"vendorId": "vnd_abc123def456",
"integrationConnectionId": "icn_abc123def456",
"ownerId": "mem_abc123def456",
"sourceKey": "vendor:vnd_abc123def456",
"riskIds": [
"rsk_abc123def456"
]
}
'const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Production PostgreSQL (AWS RDS)',
description: 'Primary application database holding patient records',
type: 'cloud_resource',
status: 'active',
location: 'AWS us-east-1',
ephiCreated: true,
ephiReceived: true,
ephiMaintained: true,
ephiTransmitted: true,
dataDescription: 'Patient demographics, lab results',
vendorId: 'vnd_abc123def456',
integrationConnectionId: 'icn_abc123def456',
ownerId: 'mem_abc123def456',
sourceKey: 'vendor:vnd_abc123def456',
riskIds: ['rsk_abc123def456']
})
};
fetch('https://api.trycomp.ai/v1/assets/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.trycomp.ai/v1/assets/{id}"
payload = {
"name": "Production PostgreSQL (AWS RDS)",
"description": "Primary application database holding patient records",
"type": "cloud_resource",
"status": "active",
"location": "AWS us-east-1",
"ephiCreated": True,
"ephiReceived": True,
"ephiMaintained": True,
"ephiTransmitted": True,
"dataDescription": "Patient demographics, lab results",
"vendorId": "vnd_abc123def456",
"integrationConnectionId": "icn_abc123def456",
"ownerId": "mem_abc123def456",
"sourceKey": "vendor:vnd_abc123def456",
"riskIds": ["rsk_abc123def456"]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)Authorizations
API key for authentication
Path Parameters
Asset ID
Example:
"ast_abc123def456"
Body
application/json
Asset name
Example:
"Production PostgreSQL (AWS RDS)"
What the asset is and how it is used
Example:
"Primary application database holding patient records"
Kind of asset
Available options:
vendor, cloud_resource, internal_system, workforce_devices, data_flow, physical_media, other Example:
"cloud_resource"
Lifecycle status; retired assets drop out of the assessment
Available options:
active, retired Where the asset lives
Example:
"AWS us-east-1"
ePHI is created at this asset
ePHI is received by this asset
ePHI is stored or maintained at this asset
ePHI is transmitted through this asset
What ePHI the asset holds or moves
Example:
"Patient demographics, lab results"
Vendor this asset represents, if any
Example:
"vnd_abc123def456"
Integration connection this asset was discovered through, if any
Example:
"icn_abc123def456"
Member ID of the asset owner
Example:
"mem_abc123def456"
Stable suggestion key ("vendor:vnd_x"). Creating with a key that already exists updates that asset instead of duplicating it.
Example:
"vendor:vnd_abc123def456"
Risk IDs that apply to this asset. Replaces the full set.
Example:
["rsk_abc123def456"]
Response
200
Was this page helpful?