General integration guide

The Argus REST API consists of a number of API modules, for different parts of the system.

Each module has a name and a version, e.g. /events/v1 or /case/v2.

contents

• Compatibility and Deprecation
• Authentication and API-keys
  • Creating an API-key
  • Using an API-key
  • Session authentication
  • Signature authentication
    • Required claims
    • Generating a valid authentication header
• Access restrictions
• API documentation
• General endpoint structure
  • Result set
    • Empty results
    • count and size
  • Identifying fields
  • Info objects
  • Error codes
  • Parameter errors
  • Retrieving objects
  • Advanced search
  • Adding new objects
  • Updating objects
• Searching: simple search
  • Filtering
  • Limit, offset and sorting
    • limit
    • offset
      • Examples:
  • Pagination
    • Example:
• Advanced search
  • Include/exclude flags
  • Deleted objects
  • Keyword search
  • Time search
  • User search
  • Subcriteria
    • Excluding subcriteria
    • Required subcriteria
• Using Argus Search APIs - Time fields
  • Searching for time
  • Time formats
    • Millis since epoch
    • ISO8601 time string
    • Relative time format
  • Time field strategies
• API Validation and Sanitation
  • Input validation
    • Numeric and boolean fields
    • Enum and string fields
    • HTML string fields
  • Input validation vs. input sanitation