Director Console API¶

Non-Breaking Changes¶

• A new resource or API endpoint

• A new optional parameter

• A new optional key in the JSON POST body

• A new key returned in the JSON response body

Breaking Changes¶

• All changes except the non-breaking mentioned above. For example,

• A new required parameter

• A new required key in POST body

• Removal of a mandatory property (a key that is mandatory when creating the entity) from the response

• Renaming a property in a response. For example: changing ‘device_name’ to ‘name’

• Changing a response to respond with an unexpected type. For example: changing ‘hostname’ type from String to List

• Removal of an existing endpoint

• Removal of an existing endpoint request method

• A substantially different internal behavior of an API call – such as a change to the default behaviour

General Guidelines¶

• Do safely ignore unknown and unexpected data in API responses

• Do safely ignore additional fields and object attributes in API responses

• Some services MAY add fields to responses without changing versions numbers. Services that do so MUST make this clear in their documentation and clients MUST ignore unknown fields

• Avoid relying on the order in which data appears in API JSON responses, unless order is explicitly defined as part of the service contract.

• Make sure that you call the RefreshList endpoint (if provided) for all the APIs after making updates to the configuration. This is to ensure that the API returns the latest data while using Get or List endpoints.

API Usage Guidelines¶

1. How to obtain Bearer Token?

   Bearer token can be obtained from Director Console’s left navigation bar’s Profile tab by clicking on Generate Token option. The token is valid only for 8 hours from the time it is generated. For times when the script runs for an extended period, you can use the Refresh Token API to obtain the new token automatically once the existing token expires.

2. How to obtain pool_UUID of the Fabric-enabled LogPoint?

   The value of the pool_UUID parameter can be obtained by logging into the Logpoint Search Master(LPSM) and navigating to the Settings >> Configurations >> LogPoint Pool section. Here a list of LPSM pools are displayed, and you can select the pool_UUID(UUID) by their Pool Name from the UUID column.

3. How to obtain logpoint_identifier?

   The value of the logpoint_identifier parameter be obtained by logging into Logpoint Search Master(LPSM) and navigating to the Settings >> Configurations >> LogPoint Pool section. You can find the details of all Fabric-enabled LogPoints associated with the pool by clicking on the Details icon under the Actions column. Click on the Details icon and find the name of your LogPoint and its identifier.

4. Since add, edit and delete operations are asynchronous, it might take some time to process them. Hence, a GET request might not always return the latest data. Also, if a Director console API request (PUT/POST/DELETE) is successful, it will return a JSON with a success message. It will also have a key called ‘message’ with an endpoint URL as value. Making a GET request to this URL will give the status of the request and response.

Following is an example of a request and its response:

Request

GET

https://api-server-host-name/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}

Response

{
    "request":{
        },
    "response":{
        "node_change_count":-1,
        "errors":[
            ],
        "delete_remote_device":[
            "192.168.34.23"
            ],
        "message":"Device deleted",
        "success":true
    }
}