Gluware API – GluAPI

Gluware API Enables Network Management Ecosystem

Network management and automation solutions must exist in an ecosystem of other products, all working together to provide monitoring, configuration management, IT system workflow management and more. To satisfy this critical customer requirement, Gluware has published its API, GluAPI, enabling a programmatic interface so customers can leverage the power of Gluware automation and orchestration capabilities via API. This first release of the GluAPI enables core API endpoint services with support to access all the device management capabilities including search, create, read, update and delete functions along with the Gluware Device Detect discovery actions and results.

GluAPI is delivered to customers with built-in documentation available at: https://[your_gluware_url]/api-docs

Introduction

The API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website’s client-side code). JSON is returned by all API responses, including errors.

Versioning

All requests should specify the API version being accessed. If no version is specified, v1 is used by default.

The version number should be included in either of the two allowed headers: “api-version” or “accept”.
Api-version: 1
Accept: application/vnd.gluware.v1+json

Examples

Examples of API usage and possible integrations will be made available on Gluware’s GitHub.

Authentication

Authenticate your account by including your username/password in API requests. Do not share your credentials in publicly accessible areas such as GitHub, client-side code, and so forth.

Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth username value. You do not need to provide a password.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Errors

The API uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with servers (these are rare).