AttackForge
Search
K

GetAssetsInLibrary

This method can be used for the following: Get assets in the library (must have Assets Module enabled in your tenant configuration!);

Parameters

The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.

Headers

GET /api/ss/library/assets HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

name (string) (optional)
Name of the asset.
Example:
{
"name": "..."
}
type (string) (optional)
Type of asset. Must be one of the following: Web App, API, Mobile, Cloud, Infrastructure, Network, Wifi, Hardware, Other
Example:
{
"type": "Web App"
}
external_id (string) (optional)
External id for the asset. For example id associated with the assest in Configuration Management Database.
Example:
{
"external_id": "..."
}
skip (integer) (optional)
Number of records to skip. Default is 0 (do not skip any records).
Example:
GET /api/ss/library/assets?skip=10 HTTP/1.1
limit (integer) (optional)
Number of records to limit to. Default limit is 500. Max limit is 500.
Example:
GET /api/ss/library/assets?limit=100 HTTP/1.1

Example

The following example is a cURL request to get all assets from the library of type 'Web App'.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
curl -X GET 'https://demo.attackforge.com/api/ss/library/assets' -H 'Host: localhost:3000' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
"type": "Web App"
}'

Response

Response contains an asset library count and array of asset library objects.
{
"count": 999,
"assets": [
{
"id": "...",
"created": "...",
"created_by": "...",
"modified": "...",
"name": "...",
"type": "...",
"external_id": "...",
"details": "...",
"groups": [
{
"name": "...",
"id": "..."
}
],
"projects": [
{
"name": "...",
"id": "..."
}
],
"asset_library_ids": [
{
"id": "...",
"name": "..."
}
],
"custom_fields" : [
{
"key" : "...",
"value" : "..."
}
]
}
]
}