-
Notifications
You must be signed in to change notification settings - Fork 5
Web Service API
[User Guide](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 |
###Responses
All data is received as a JSON object. The Web API [Data Model](Data Model) provides a description of all retrievable objects.
##Web Service API Reference
Resource | Description | Supported HTTPS Method | Endpoint |
---|---|---|---|
[Alerts](Alerts Resource) | Provide methods to manipulate alerts | PUT, POST, GET, DELETE | /alerts |
[Audit](Audit resource) | Provides methods to examine audit history information for data objects | GET | /audit/ |
[Authentication](Authentication resource) | Provides methods to authenticate users | POST, GET | /auth |
[Annotation](Annotation Resource) | Provides methods to query annotations | GET | /annotations |
[Collection](Collection Resource) | Provides methods to collect annotation events and metric data | PUT, POST, GET, DELETE | /collection |
[Dashboards](Dashboard Resource) | Provides methods to manipulate dashboards | PUT, POST, GET, DELETE | /dashboards |
[Discover](Discover Resource) | Provides methods to discovery resources | GET | /discover |
[History](History Resource) | Provides methods to examine object history details | GET | /history |
[Management](Management Resource) | Provides methods to manage the services | PUT, GET | /management |
[Metrics](Metrics Resource) | Provides methods to query and transform metrics | GET | /metrics |
[Namespaces](Namespace Resource) | Provides methods to manipulate namespaces | PUT, POST, GET | /namespaces |
[Users](Users Resource) | Provides methods to manipulate users | PUT, POST, GET | /users |
Home
[Getting Started](Getting Started)
##[User Guide](User Guide)
Alerts
Annotations
Dashboards
Metrics
Namespaces
[Data Model](Data Model)
Transforms
[Web Service API](Web Service API)
- [/alerts](Alerts Resource)
- [/annotations](Annotation Resource)
- [/audit](Audit Resource)
- [/authentication](Authentication Resource)
- [/collection](Collection Resource)
- [/dashboards](Dashboard Resource)
- [/discover](Discover Resource)
- [/history](History Resource)
- [/management](Management Resource)
- [/metrics](Metrics Resource)
- [/namespace](Namespace Resource)
- [/users](Users Resource)