Skip to main content
API docs by Redocly

Truss API (1.0.0)

Download OpenAPI specification:Download

Truss Team: info@truss-security.com URL: https://truss-security.com

A security API

search products

Search for products

Request Body schema: application/json
required

Search parameters are optional. Items matching all search parameters will be returned.

startdate
number <Unix Epoch Time>

return products that were uploaded on or after this date

enddate
number <Unix Epoch Time>

return products that were uploaded on or before this date

category
string

Exact match for category name

source
string

Exact match for source name

author
Array of strings

Author name contains any of the strings

title
string

Returns products where the product title contains the specified string

tags
Array of strings

Return products that contain any of the specified tags

validators
Array of strings

Return products that contain any of the specified validators

industry
Array of strings

Return products that contain any of the specified industries

region
Array of strings

Return products that contain any of the specified regions

indicators
object

Return products that contain any of the specified indicators

limit
number

maximum number of results to return

object (StartKey)

when paging, use the LastEvaluatedKey returned from the previous query as the startKey for the next query

scanOldestToNewest
boolean
Default: false

Sort order of the products according to the product timestamp (true = oldest to newest)

Responses

Request samples

Content type
application/json
{
  • "startdate": 1717377710394,
  • "enddate": 1717379710282,
  • "category": "Ransomware",
  • "source": "Cisco Talos",
  • "author": [
    ],
  • "title": "GhostSec joint ransomware operation",
  • "tags": [
    ],
  • "validators": [
    ],
  • "industry": [
    ],
  • "region": [
    ],
  • "indicators": {},
  • "limit": 10,
  • "startKey": {
    },
  • "scanOldestToNewest": true
}

Response samples

Content type
application/json
{
  • "$metadata": {
    },
  • "Count": "string",
  • "Items": [
    ],
  • "LastEvaluatedKey": {
    },
  • "ScannedCount": 0
}

create product

creates a new security product

Request Body schema: application/json
required

Create a new security product

title
string
author
Array of strings
type
string
category
string
source
string
pubDate
string
reference
Array of strings
tags
Array of strings
industry
Array of strings
region
Array of strings
indicators
object

Responses

Request samples

Content type
application/json
{
  • "title": "TOR-ExitNodes_New Zealand_06/02/2024 08:00 UTC",
  • "author": [
    ],
  • "type": "Indicator",
  • "category": "TOR",
  • "source": "TOR Project",
  • "pubDate": "June 02, 2024",
  • "reference": [],
  • "tags": [
    ],
  • "industry": [
    ],
  • "region": [
    ],
  • "indicators": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "TOR-ExitNodes_New Zealand_06/02/2024 08:00 UTC",
  • "author": [
    ],
  • "type": "Indicator",
  • "category": "TOR",
  • "source": "TOR Project",
  • "pubDate": "June 02, 2024",
  • "reference": [],
  • "tags": [
    ],
  • "industry": [
    ],
  • "region": [
    ],
  • "indicators": {
    }
}

find product by id

Returns a product based on a product ID

path Parameters
id
required
integer <int64>

ID of product to fetch

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "TOR-ExitNodes_New Zealand_06/02/2024 08:00 UTC",
  • "author": [
    ],
  • "type": "Indicator",
  • "category": "TOR",
  • "source": "TOR Project",
  • "pubDate": "June 02, 2024",
  • "reference": [],
  • "tags": [
    ],
  • "industry": [
    ],
  • "region": [
    ],
  • "indicators": {
    }
}

update product

updates a product

Request Body schema: application/json
required

Create a new security product

title
string
author
Array of strings
type
string
category
string
source
string
pubDate
string
reference
Array of strings
tags
Array of strings
industry
Array of strings
region
Array of strings
indicators
object

Responses

Request samples

Content type
application/json
{
  • "title": "TOR-ExitNodes_New Zealand_06/02/2024 08:00 UTC",
  • "author": [
    ],
  • "type": "Indicator",
  • "category": "TOR",
  • "source": "TOR Project",
  • "pubDate": "June 02, 2024",
  • "reference": [],
  • "tags": [
    ],
  • "industry": [
    ],
  • "region": [
    ],
  • "indicators": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

delete product

deletes a single product based on a product ID

path Parameters
id
required
integer <int64>

ID of product to delete

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}