Product SiteDocumentation Site

redborder REST 3.0

API Guide

Edition 1

Eneo Tecnología S.L.

Abstract

The specifications and information regardin the products in this manual are subject to change. Check out its Gitlab repository in order to get the last version available. All statements, information and recomendations in this manual are believed to be accurate, but are presented without warranty of any kind, express or implied. Users must take full responsibility for their application of any products.
The software license and limited warranty for the accompanying product are set forth in the information packet that shipped with the product and are incorporated herein by this reference. If you are unable to locate the software license or limited warranty. contact redborder for a copy at info@redborder.com or leaving your personal data in our contact form at redborder.com
This material may be distributed only under the terms and conditions set forth in the GNU Free Documentation License v1.3 (the latest version is available at http://fsf.org/).
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".
Check out the GNU Free Documentation License for more details. If you want you can receive a copy of it via redborder or directly check it out at https://www.gnu.org/licenses/fdl.html

ENEO Tecnología S.L.


          Plaza de las Naciones s/n, Torre Norte (Edificio Aljarafe Center). Planta 12.
          Mairena del Aljarafe
          Sevilla
          41927
           +34 955 60 11 60
          Spain
           

Preface
1. Document Conventions
1.1. Typographic Conventions
1.2. Pull-quote Conventions
1.3. Notes and Warnings
2. We need your feedback!
1. Full Application Programming Interface
1.1. Introduction
1.2. Authentication
1.3. JSON Params
1.4. Dimensions for rb_flow
1.5. Dimensions for rb_event
1.6. Dimensions for rb_monitor
1.7. Dimensions for rb_social
1.8. Dimensions for rb_state
1.9. Filters
1.10. Examples: rb_flow
1.11. Examples: rb_event
2. Model sharing with rB
2.1. Sensor tree listing
2.2. Domain creation
2.3. Flow sensor creation
2.4. Meraki sensor creation
2.5. MSE sensor creation
2.6. MSE sensor listing for a domain
2.7. Sensor elimination
2.8. Update a Domain sensor
2.9. Update Flow, MSE and Meraki sensors
2.10. Domain override
2.11. Domain Access Point override
2.12. Access Point listing
2.13. Access Point creation
2.14. Access Point Modification
2.15. Access Point destruction
2.16. User listing
2.17. User API key renewal
A. Revision History