Contents Menu Expand Light mode Dark mode Auto light/dark mode
Argus documentation
Logo
Argus documentation

API documentation

  • Overview
  • General integration guide
    • Compatibility and Deprecation
    • Authentication and API-keys
    • Access restrictions
    • API documentation
    • General endpoint structure
    • Searching: simple search
    • Advanced search
    • Using Argus Search APIs - Time fields
    • API Validation and Sanitation
  • Services integration guides
    • Alarm Integration Guide
    • Asset Integration Guide
      • Asset V1 Integration Guide
      • Asset V2 Lexicon
      • Asset V2 Integration Guide
      • Asset V2 Search Guide
      • Asset V2 Typed References Guide
    • Authentication Integration Guide
      • The Argus Authentication Service
      • Administrator management of user authentication settings
      • Current user permission queries
      • Session management
      • Argus Identity Provider Integration Guide
        • OAuth2 Integration
        • OAuth2 Authorization Code Flow
        • OAuth2 Implicit Flow
        • OAuth2 Client Credentials Flow
        • OpenID Connect Support
        • Required information about the client
        • Configuring your Client
      • External Identity Provider Integration Guide
        • Understanding Argus OpenID Provider integration
        • Defining the OpenID Client in your provider
        • Sending information to mnemonic to set up the provider configuration
        • Setting up Argus to work with an external OpenID Provider - Implicit Flow
        • Setting up Argus to work with an external OpenID Provider - Authorization Code Flow
        • Automatic User mapping
        • Tested provider settings
        • Setting up OpenID Connect SSO with Azure AD
    • Case Integration Guide
      • Case General Integration Guide
      • Case Fields Integration Guide
      • Understanding Case Access Control
      • Case Websockets
      • Case History
    • Configuration Administration Integration Guide
    • Component Administration Integration Guide
    • Customer Networks Integration Guide
      • Networks
      • Network comments
      • Customer domains
    • Customer Integration Guide
      • Basic Customer API
      • Administrative Customer API
      • Property Descriptor API
    • Customer Contacts Integration Guide
    • DataStore Integration Guide
    • Document Integration Guide
    • EventFilter integration guide
    • Event Integration Guide
      • Event Service v1
      • Event Service v2
      • Submitting events via API
    • Metric Integration Guide
      • Metric Descriptors
      • Metrics
    • Notification Integration Guide
    • PassiveDNS Integration Guide
      • Public API
      • Private API
    • Reputation Integration Guide
      • Reputation v1 Integration Guide
      • Reputation v2 Sources
    • Sample Integration Guide
      • Key Concepts
      • Authentication
      • Sample
      • Analysis
      • Evidence
      • Link
      • Submission
      • Challenges
      • Jobs
      • Job tasks
      • Verdicts
      • Analysis Workers
      • Analysis Policy
      • Analysis Rule
      • Static Fact
      • Service Task Framework
    • Sensor Integration Guide
      • Sensors
      • Location
      • Sensor Interface
      • Sensor Status
      • Sensor Type/Application
    • User Integration Guide
      • Basic endpoints
      • Administration endpoints
      • Group administration
      • Permission administration
      • Functions
Back to top

Searching: simple search#

Simple search is using the GET method, and is accepting a set of basic query parameters for filtering, sorting, and limit/offset.

Filtering#

Filtering parameters are appended as query parameters, e.g.
GET /assets/v1/host?customerID=1 will search for host assets for customer 1

Many filtering parameters accept multiple values, the default behaviour is to search for any of the provided values, e.g. GET /assets/v1/host?customerID=1&customerID=2 will search for host assets for customer 1 or 2.

Combining different search criteria generally has an AND logic, e.g.
GET /assets/v1/host?customerID=1&keywords=myhost will mean to search for hosts for customer 1 which also matches the keyword myhost.

See API documentation for valid filtering parameters.

Limit, offset and sorting#

By default, any endpoint has a default limit of 25 elements : search endpoints (simple or advanced) will generally limit output to 25 rows, but allows user to override limit to get more/fewer rows, and set an offset to perform pagination.

The query parameters limit and offsetcan be added to override the defaults.

limit#

By setting limit=0, the endpoint will perform an unlimited search, up to the system-defined maximum limit.

If the user sets a limit above the maximum limit, the endpoint will return an argument error.

If the user requests an unlimited search, which would return more than the system defined maximum limit, the endpoint will return HTTP 412 (argument error).

Currently, the system defined maximum result limit is 100000.

offset#

By setting offset=X, the endpoint will return the number of results defined by limit, after skipping the first X entries.

Endpoints have a default sort order. To change the sorting, endpoints have a sortBy parameter, which allows changing the default sort property and direction, e.g.sortBy=id will sort by ID ascending, while sortBy=-id will sort by ID descending.

Adding multiple sortBy parameters will define a chained sorting order, e.g. sortBy=timestamp&sortBy=id will sort all entities by timestamp first, then by ID.

See API documentation for valid sorting parameters.

Examples:#

  • limit=10 will return the first 10 results (as defined by the default sort order)

  • limit=10&offset=10will return the next 10 results after the 10 first results (as defined by the default sort order)

  • limit=10&sortBy=timestampwill return the first 10 results when ordered by timestamp

  • limit=0 will return all available results. If the requested search would return more than the system-defined limit, this will return an argument error.

Pagination#

If fetching large amounts of data, using pagination can help speed up the process by conserving both client and system resources, and will give quicker response times.

By performing an initial search with a “moderate limit” (e.g. 1000 rows), the returned count allows the client to determine how much data there is to fetch, and paginate through it.

Example:#

GET /assets/v1/host?customerID=1&limit=1000

may return :

{ "count":19350,"size":1000,"data":[...]}

Then, the client can perform 19 additional GEToperations to fetch the rest:

  • GET /assets/v1/host?customerID=1&limit=1000&offset=1000

  • GET /assets/v1/host?customerID=1&limit=1000&offset=2000

  • GET /assets/v1/host?customerID=1&limit=1000&offset=3000

  • …

Next
Advanced search
Previous
General endpoint structure
Copyright © 2025, Mnemonic
Made with Furo
On this page
  • Searching: simple search
    • Filtering
    • Limit, offset and sorting
      • limit
      • offset
        • Examples:
    • Pagination
      • Example: