GetAssets

This method can be used for the following functionality: Get details for all assets user has access to.

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/assets HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

order (string) (optional)

Field and direction to sort the returned data. Direction must be ASC or DESC. Default is created DESC. The following fields can be sorted - created, external_id, id, modified (also accepted as last_modified), name, type, and custom_field_ followed by the custom field key e.g. custom_field_environment.

Example:

GET /api/ss/assets?order=type:DESC HTTP/1.1

skip (integer) (optional)

Number of records to skip. Default is 0 (do not skip any records).

Example:

GET /api/ss/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/assets?limit=100 HTTP/1.1

q (string) (optional)

Provides options to query a custom selection of assets.

Please visit the following link for more details on how to use this filter: https://support.attackforge.com/attackforge-enterprise/modules/self-service-restful-api/advanced-query-filter

Example

The following example is a cURL request to get all assets user has access to.

Request

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

curl -X GET 'https://demo.attackforge.com/api/ss/assets' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'

Response

Response contains an array of asset objects.

{
   "count": 999,
   "assets":[
      {
         "asset": "...",
         "created": "...",
         "last_updated": "...",
         "belongs_to_projects": [
            {
              "id": "...",
              "name": "..."
            }
         ],
         "id": "..."
      }
   ]
}