{ "swagger": "2.0", "info": { "description": "vRealize Network Insight API Reference", "version": "6.4.0", "title": "vRealize Network Insight API Reference" }, "host": "vrni.example.com", "basePath": "/api/ni", "tags": [ { "name": "Authentication", "description": "Authentication APIs" }, { "name": "Data Sources", "description": "Data Source APIs" }, { "name": "Entities", "description": "Entities APIs" }, { "name": "Search", "description": "Search APIs" }, { "name": "Infrastructure", "description": "Infra APIs" }, { "name": "Applications", "description": "Applications APIs" }, { "name": "Microsegmentation", "description": "Micro-Segmentation APIs" }, { "name": "Info", "description": "Info APIs" }, { "name": "Settings", "description": "Settings APIs" }, { "name": "Schema", "description": "Schema APIs" }, { "name": "Metrics", "description": "Metrics APIs" }, { "name": "Path", "description": "Path Related APIs" }, { "name": "Logs", "description": "Logs APIs" }, { "name": "Pinboards", "description": "Pinboard Related APIs" } ], "schemes": [ "https" ], "securityDefinitions": { "ApiKeyAuth": { "description": "API Key - NetworkInsight {token}", "in": "header", "name": "Authorization", "type": "apiKey" } }, "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": { "Identifier": { "name": "id", "in": "path", "description": "The Entity ID of object requestion information on", "required": true, "type": "string" }, "Time": { "name": "time", "in": "query", "description": "Time in epoch seconds", "required": false, "type": "integer", "format": "int64" }, "Size": { "name": "size", "in": "query", "description": "Page size of results", "required": false, "type": "number", "default": 10 }, "Cursor": { "name": "cursor", "in": "query", "description": "Cursor from previous response", "required": false, "type": "string" }, "StartTime": { "name": "start_time", "in": "query", "description": "Start time for query in epoch seconds", "required": false, "type": "number" }, "EndTime": { "name": "end_time", "in": "query", "description": "End time for query in epoch seconds", "required": false, "type": "number" }, "UserType": { "name": "type", "in": "query", "description": "Type of user", "required": true, "type": "string" }, "UserGroupType": { "name": "type", "in": "query", "description": "Type of user-group", "required": true, "type": "string" }, "EventTags": { "name": "event_tags", "in": "query", "collectionFormat": "multi", "description": "Event tags", "required": false, "type": "array", "items": { "type": "string" } }, "EventStatus": { "name": "event_status", "in": "query", "description": "Status of event open or closed", "required": false, "type": "string", "default": "all", "enum": [ "open", "closed", "all" ] }, "EventType": { "name": "event_type", "in": "query", "description": "Type of event, e.g UserDefinedProblemEvent", "required": false, "type": "string" }, "UpdateTimeFrom": { "name": "update_time_from", "in": "query", "description": "Events that were created or updated or closed between this time and update_time_to, in seconds", "required": false, "type": "number" }, "UpdateTimeTo": { "name": "update_time_to", "in": "query", "description": "Events that were created or updated or closed between update_time_from and this time, in seconds", "required": false, "type": "number" }, "EventSeverityList": { "name": "event_severity", "in": "query", "collectionFormat": "multi", "description": "Event severity filter", "required": false, "type": "array", "items": { "type": "string", "enum": [ "Critical", "Warning", "Moderate", "Info" ] } }, "EventManagers": { "name": "managers", "in": "query", "collectionFormat": "multi", "description": "The entity ID of the manager of entity on which event is raised", "required": false, "type": "array", "items": { "type": "string" } }, "PinIdentifier": { "name": "pin-id", "in": "path", "description": "The ID of pin requesting information on", "required": true, "type": "string" }, "Filter": { "name": "filter", "in": "query", "description": "A filter expression is a predicate expression (similar to SQL where clause) used to define the search criteria", "required": false, "type": "string" }, "OrderBy": { "name": "order_by", "in": "query", "description": "order by", "required": false, "type": "string" }, "ShowCertificates": { "name": "show_certficates", "in": "query", "description": "show certificates and thumbprint", "required": false, "type": "boolean", "default": false } }, "paths": { "/auth/token": { "post": { "tags": [ "Authentication" ], "summary": "Create an auth token", "description": "
vRealize Network Insight supports token based authentication. Tokens are non-modifiable identifiers returned by the system when the user has successfully authenticated using valid credentials. Token expires after expiry time returned in the response. All API requests must provide the auth token in Authorization header in following format: