GetAssetInLibrary

This method can be used for the following: Get an asset 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/asset?id=:id HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

id (string)

Id of the asset.

Example:

GET /api/ss/library/asset?id=60c92f6113100562a6a58a6f HTTP/1.1

cf_key_allowlist (string) (optional)

List of custom field keys to include in response. Add multiple for more than one key e.g. ?cf_key_allowlist=key1&cf_key_allowlist=key2 or specify no keys to exclude all fields e.g. ?cf_key_allowlist=

Example:

GET /api/ss/library/asset?cf_key_allowlist=key1&cf_key_allowlist=key2 HTTP/1.1

cf_key_blocklist (string) (optional)

List of custom field keys to exclude from response. Add multiple for more than one key e.g. ?cf_key_blocklist=key1&cf_key_blocklist=key2

Example:

GET /api/ss/library/asset?cf_key_blocklist=key1&cf_key_blocklist=key2 HTTP/1.1

Example

The following example is a cURL request to get an asset from the library.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.

curl -X GET 'http://localhost:3000/api/ss/library/asset?id=60c92f6113100562a6a58a6f' -H 'Host: localhost:3000' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'

Response

Response contains an asset library object.

{
   "asset": {
      "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" : "..."
        }
      ]
   }
}