Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

Web Service API

textractor edited this page May 11, 2018 · 6 revisions

User Guide


About the Web Service API

Our web service API provides users with fast and reliable access to Argus data. You can use the Argus Web Service API to retrieve and manage Argus content.

Requests

Based on simple REST principles, our web service API endpoints return metadata in JSON format.

List of available endpoints: http://<base_url>/help

Detailed endpoint help: http://<base_url>/<endpoint>/help

Verb Description
GET Used for retrieving resources
POST Used for creating resources
PUT Used for changing and replacing resources
DELETE Used for deleting resources

NOTE: If you are posting data from the command line (with curl, for example), be sure to encapsulate the payload with single quotes.

Responses

All data is received as a JSON object. The Web API [Data Model](Data Model) provides a description of all retrievable objects.

NOTE: A 401 error usually indicates an expired token. See Authentication for more information.

Web Service API Reference

Resource Description Supported HTTPS Method Endpoint
Alerts Provide methods to manipulate alerts PUT, POST, GET, DELETE /alerts
Audit Provides methods to examine audit history information for data objects GET /audit
Authentication Provides methods to authenticate users POST, GET /auth
Annotation Provides methods to query annotations GET /annotations
Batches Provides methods to manipulate batches GET, DELETE /batches
Collection Provides methods to collect annotation events and metric data PUT, POST, GET, DELETE /collection
Dashboards Provides methods to manipulate dashboards PUT, POST, GET, DELETE /dashboards
Discover Provides methods to discovery resources GET /discover
History Provides methods to examine object history details GET /history
Management Provides methods to manage the services PUT, GET /management
Metrics Provides methods to query and transform metrics GET /metrics
Namespaces Provides methods to manipulate namespaces PUT, POST, GET /namespaces
Users Provides methods to manipulate users PUT, POST, GET /users
Clone this wiki locally