Get Assets

GET 
/v1/assets

List and filter data assets to build out your data asset inventory. This call returns a list of assets that match the provided filters, with basic asset details. To get full asset details, use ‘/v1/assets/id’

Request

Query Parameters

region.in string[]
region.equals string
cloudProvider.in string[]

Possible values: [AWS, AZURE, GCP, SNOWFLAKE, FILE_SHARE, O365]

cloudProvider.equals string

Possible values: [AWS, AZURE, GCP, SNOWFLAKE, FILE_SHARE, O365]

serviceType.in string[]

Possible values: [ATHENA, AURORA, AWS_BACKUP, DOCUMENTDB, DYNAMODB, DAX, EMR, EBS, EFS, ELASTICACHE, FSX, KINESIS_DELIVERY_STREAM, MEMORYDB, NEPTUNE, QLDB, RDS, REDSHIFT, S3, TIMESTREAM, OPENSEARCH, OPENSEARCH_SERVERLESS, COSMOS_DB, SYNAPSE, CACHE_FOR_REDIS, MARIA_DB, MYSQL_SERVER, POSTGRESQL_SERVER, SQL_SERVER, STORAGE_ACCOUNT, SQL_MANAGED_INSTANCE, ANF, CLOUD_STORAGE, CLOUD_SQL, BIG_QUERY, FILE_STORE, CLOUD_SPANNER, MEMORY_STORE, BIG_TABLE, FIRE_STORE, UNMANAGED_AWS_MYSQL, UNMANAGED_AWS_ORACLE_SERVER, UNMANAGED_AWS_MONGO_DB, UNMANAGED_AWS_POSTGRESQL, UNMANAGED_AWS_REDIS, UNMANAGED_AWS_SQLITE, UNMANAGED_AWS_MS_SQL, UNMANAGED_AWS_MARIA_DB, UNMANAGED_AWS_NEO4_J, UNMANAGED_AWS_ELASTIC, UNMANAGED_AWS_COCKROACH_DB, UNMANAGED_AWS_AEROSPIKE, UNMANAGED_AWS_SCYLLA_DB, UNMANAGED_AZURE_MYSQL, UNMANAGED_AZURE_ORACLE_SERVER, UNMANAGED_AZURE_MONGO_DB, UNMANAGED_AZURE_POSTGRESQL, UNMANAGED_AZURE_REDIS, UNMANAGED_AZURE_SQLITE, UNMANAGED_AZURE_MS_SQL, UNMANAGED_AZURE_MARIA_DB, UNMANAGED_AZURE_NEO4_J, UNMANAGED_AZURE_ELASTIC, UNMANAGED_AZURE_COCKROACH_DB, UNMANAGED_AZURE_AEROSPIKE, UNMANAGED_AZURE_SCYLLA_DB, UNMANAGED_GCP_MYSQL, UNMANAGED_GCP_ORACLE_SERVER, UNMANAGED_GCP_MONGO_DB, UNMANAGED_GCP_POSTGRESQL, UNMANAGED_GCP_REDIS, UNMANAGED_GCP_SQLITE, UNMANAGED_GCP_MS_SQL, UNMANAGED_GCP_MARIA_DB, UNMANAGED_GCP_NEO4_J, UNMANAGED_GCP_ELASTIC, UNMANAGED_GCP_COCKROACH_DB, UNMANAGED_GCP_AEROSPIKE, UNMANAGED_GCP_SCYLLA_DB, SNOWFLAKE_DB, FILE_SHARE, ONE_DRIVE, SHARE_POINT, AZURE_OPEN_AI_DEPLOYMENT, VERTEX_ENDPOINT, BEDROCK_PROVISIONED_THROUGHPUT, BEDROCK_AGENT]

serviceType.equals string

Possible values: [ATHENA, AURORA, AWS_BACKUP, DOCUMENTDB, DYNAMODB, DAX, EMR, EBS, EFS, ELASTICACHE, FSX, KINESIS_DELIVERY_STREAM, MEMORYDB, NEPTUNE, QLDB, RDS, REDSHIFT, S3, TIMESTREAM, OPENSEARCH, OPENSEARCH_SERVERLESS, COSMOS_DB, SYNAPSE, CACHE_FOR_REDIS, MARIA_DB, MYSQL_SERVER, POSTGRESQL_SERVER, SQL_SERVER, STORAGE_ACCOUNT, SQL_MANAGED_INSTANCE, ANF, CLOUD_STORAGE, CLOUD_SQL, BIG_QUERY, FILE_STORE, CLOUD_SPANNER, MEMORY_STORE, BIG_TABLE, FIRE_STORE, UNMANAGED_AWS_MYSQL, UNMANAGED_AWS_ORACLE_SERVER, UNMANAGED_AWS_MONGO_DB, UNMANAGED_AWS_POSTGRESQL, UNMANAGED_AWS_REDIS, UNMANAGED_AWS_SQLITE, UNMANAGED_AWS_MS_SQL, UNMANAGED_AWS_MARIA_DB, UNMANAGED_AWS_NEO4_J, UNMANAGED_AWS_ELASTIC, UNMANAGED_AWS_COCKROACH_DB, UNMANAGED_AWS_AEROSPIKE, UNMANAGED_AWS_SCYLLA_DB, UNMANAGED_AZURE_MYSQL, UNMANAGED_AZURE_ORACLE_SERVER, UNMANAGED_AZURE_MONGO_DB, UNMANAGED_AZURE_POSTGRESQL, UNMANAGED_AZURE_REDIS, UNMANAGED_AZURE_SQLITE, UNMANAGED_AZURE_MS_SQL, UNMANAGED_AZURE_MARIA_DB, UNMANAGED_AZURE_NEO4_J, UNMANAGED_AZURE_ELASTIC, UNMANAGED_AZURE_COCKROACH_DB, UNMANAGED_AZURE_AEROSPIKE, UNMANAGED_AZURE_SCYLLA_DB, UNMANAGED_GCP_MYSQL, UNMANAGED_GCP_ORACLE_SERVER, UNMANAGED_GCP_MONGO_DB, UNMANAGED_GCP_POSTGRESQL, UNMANAGED_GCP_REDIS, UNMANAGED_GCP_SQLITE, UNMANAGED_GCP_MS_SQL, UNMANAGED_GCP_MARIA_DB, UNMANAGED_GCP_NEO4_J, UNMANAGED_GCP_ELASTIC, UNMANAGED_GCP_COCKROACH_DB, UNMANAGED_GCP_AEROSPIKE, UNMANAGED_GCP_SCYLLA_DB, SNOWFLAKE_DB, FILE_SHARE, ONE_DRIVE, SHARE_POINT, AZURE_OPEN_AI_DEPLOYMENT, VERTEX_ENDPOINT, BEDROCK_PROVISIONED_THROUGHPUT, BEDROCK_AGENT]

digTagKey.contains string
digTagValue.contains string
lifecycle.in string[]

Possible values: [RUNNING, STOPPED, DELETED]

lifecycle.equals string

Possible values: [RUNNING, STOPPED, DELETED]

sort string

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

page string

Default value: 0

size integer

Possible values: <= 50

Default value: 20

Header Parameters

dig-api-key stringrequired

Dig token header

Responses

200

Returns a list of assets

Response Headers

• X-Total-Count integer

  The total number of items in the page

application/json

Schema

Schema

• Array [
projectId string
projectName string
name string
cloudProvider string

Possible values: [AWS, AZURE, GCP, SNOWFLAKE, FILE_SHARE, O365]

cloudEnvironment string

Possible values: [UNKNOWN, DEVELOPMENT, STAGING, TESTING, PRODUCTION]

serviceType string

Possible values: [ATHENA, AURORA, AWS_BACKUP, DOCUMENTDB, DYNAMODB, DAX, EMR, EBS, EFS, ELASTICACHE, FSX, KINESIS_DELIVERY_STREAM, MEMORYDB, NEPTUNE, QLDB, RDS, REDSHIFT, S3, TIMESTREAM, OPENSEARCH, OPENSEARCH_SERVERLESS, COSMOS_DB, SYNAPSE, CACHE_FOR_REDIS, MARIA_DB, MYSQL_SERVER, POSTGRESQL_SERVER, SQL_SERVER, STORAGE_ACCOUNT, SQL_MANAGED_INSTANCE, ANF, CLOUD_STORAGE, CLOUD_SQL, BIG_QUERY, FILE_STORE, CLOUD_SPANNER, MEMORY_STORE, BIG_TABLE, FIRE_STORE, UNMANAGED_AWS_MYSQL, UNMANAGED_AWS_ORACLE_SERVER, UNMANAGED_AWS_MONGO_DB, UNMANAGED_AWS_POSTGRESQL, UNMANAGED_AWS_REDIS, UNMANAGED_AWS_SQLITE, UNMANAGED_AWS_MS_SQL, UNMANAGED_AWS_MARIA_DB, UNMANAGED_AWS_NEO4_J, UNMANAGED_AWS_ELASTIC, UNMANAGED_AWS_COCKROACH_DB, UNMANAGED_AWS_AEROSPIKE, UNMANAGED_AWS_SCYLLA_DB, UNMANAGED_AZURE_MYSQL, UNMANAGED_AZURE_ORACLE_SERVER, UNMANAGED_AZURE_MONGO_DB, UNMANAGED_AZURE_POSTGRESQL, UNMANAGED_AZURE_REDIS, UNMANAGED_AZURE_SQLITE, UNMANAGED_AZURE_MS_SQL, UNMANAGED_AZURE_MARIA_DB, UNMANAGED_AZURE_NEO4_J, UNMANAGED_AZURE_ELASTIC, UNMANAGED_AZURE_COCKROACH_DB, UNMANAGED_AZURE_AEROSPIKE, UNMANAGED_AZURE_SCYLLA_DB, UNMANAGED_GCP_MYSQL, UNMANAGED_GCP_ORACLE_SERVER, UNMANAGED_GCP_MONGO_DB, UNMANAGED_GCP_POSTGRESQL, UNMANAGED_GCP_REDIS, UNMANAGED_GCP_SQLITE, UNMANAGED_GCP_MS_SQL, UNMANAGED_GCP_MARIA_DB, UNMANAGED_GCP_NEO4_J, UNMANAGED_GCP_ELASTIC, UNMANAGED_GCP_COCKROACH_DB, UNMANAGED_GCP_AEROSPIKE, UNMANAGED_GCP_SCYLLA_DB, SNOWFLAKE_DB, FILE_SHARE, ONE_DRIVE, SHARE_POINT, AZURE_OPEN_AI_DEPLOYMENT, VERTEX_ENDPOINT, BEDROCK_PROVISIONED_THROUGHPUT, BEDROCK_AGENT]

dataTypeGroups string[]
dataTypes object[]
Array [
type string
numberOfFindings int64
]
lifecycle string

Possible values: [RUNNING, STOPPED, DELETED]

openRisksCount int32
openAlertsCount int32
encrypted boolean
openToWorld boolean
tags object
property name* string
assetDigTags object[]
Array [
digTagId int64
key string
value string
]
id string
• ]

Example (from schema)

[
  {
    "projectId": "string",
    "projectName": "string",
    "name": "string",
    "cloudProvider": "AWS",
    "cloudEnvironment": "UNKNOWN",
    "serviceType": "ATHENA",
    "dataTypeGroups": [
      "string"
    ],
    "dataTypes": [
      {
        "type": "string",
        "numberOfFindings": 0
      }
    ],
    "lifecycle": "RUNNING",
    "openRisksCount": 0,
    "openAlertsCount": 0,
    "encrypted": true,
    "openToWorld": true,
    "tags": {},
    "assetDigTags": [
      {
        "digTagId": 0,
        "key": "string",
        "value": "string"
      }
    ],
    "id": "string"
  }
]

Loading...