{"type":"api","title":"List Agents","meta":{"id":"/apps/pubhub/media/edge-intelligence-api/4eb0d8a649b4839c3bde782b4820822ee1b60b79/5459c39a-b81c-31ea-bf4d-bf7500ba3d5c","info":{"contact":{"email":"ei-cloud@cisco.com"},"description":"This is EI manager core service","license":{"name":"Licensing is primarily subscription based. Call Andy now!","url":"https://www.cisco.com"},"termsOfService":"http://swagger.io/terms/","title":"EI Manager Core Service","version":"1.0.0"},"security":[{"httpBearer":[]}],"tags":[{"description":"This tag will be used for EI agent configurations specific apis","name":"AgentConfig"},{"description":"This tag will be used for Asset Type configurations specific apis","name":"AssetTypeConfig"}],"externalDocs":{"description":"Find out more about Swagger","url":"http://swagger.io"},"x-parser-conf":{"apiKeyGenerator":{"$remoteModule":"./config/apikey.js"},"overview":{"markdownPath":"reference/overview.md"},"meta":{"useProxy":true},"disableAuthEditing":true,"serverConfig":"https://us.ciscoiot.com/nbapi/ei/v1"},"openapi":"3.0.3","servers":[{"url":"https://us.ciscoiot.com/nbapi/ei/v1"}],"securitySchemes":{"httpBearer":{"in":"header","name":"Authorization","type":"apiKey"}}},"spec":{"description":"Returns a list of all ei agents that matches the query conditions (in a paginated way)\u003cbr /\u003e One of the below permissions is needed to invoke this API\u003cbr /\u003e- Asset Management\u003cbr /\u003e- Data Management\u003cbr /\u003e- Develop and Manage Data Logics\u003cbr /\u003e- EI System Management\u003cbr /\u003e- Operations Management","operationId":"getAgents","parameters":[{"description":"The uuid of the tenant in whose context we are calling the api","in":"header","name":"x-tenant-id","required":true,"schema":{"type":"string","default":"1d5aafe3-6282-4fc1-a67a-585659d90038"}},{"description":"Boolean value representing whether this API should fllow graphql API path internally or not","in":"query","name":"graphql-path","schema":{"default":false,"type":"boolean"}},{"description":"particular page number to return","in":"query","name":"page","schema":{"default":1,"maximum":200,"minimum":1,"type":"integer"}},{"description":"The numbers of items to return","in":"query","name":"size","schema":{"default":10,"maximum":200,"minimum":1,"type":"integer"}},{"description":"sort criteria for retrieved records. Sort the data using any field of agent details from label, hardwareSerial, hardwareModel, brokerVersion, numOfMappedAssets, connectionState, and dataPipelinesStatus","in":"query","name":"orderBy","schema":{"default":"label","type":"string"}},{"description":"order to sorting the retrieved records. The default sort order is ascending, Provide value true to specify a descending sort order","in":"query","name":"desc","schema":{"default":false,"type":"boolean"}},{"description":"Search criteria can be any string which is part of agent detail like label, hardwareSerial, hardwareModel, brokerVersion, numOfMappedAssets, connectionState, and dataPipelinesStatus","in":"query","name":"search","schema":{"default":"","type":"string"}},{"description":"Search data by the EI agent name","in":"query","name":"label","schema":{"default":"","type":"string"}},{"description":"Search data by the network device serial number","in":"query","name":"hardwareSerial","schema":{"default":"","type":"string"}},{"description":"Search data by the network device model","in":"query","name":"hardwareModel","schema":{"default":"","type":"string"}},{"description":"Search data by the EI agent version","in":"query","name":"brokerVersion","schema":{"default":"","type":"string"}},{"description":"Search data by number of mapped assets to the agent","in":"query","name":"numOfMappedAssets","schema":{"default":-1,"type":"integer"}},{"description":"Search data by the EI agent connection status","in":"query","name":"connectionState","schema":{"default":"","type":"string"}},{"description":"Search data by data pipelines status","in":"query","name":"dataPipelinesStatus","schema":{"default":"","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"agents":{"items":{"properties":{"brokerVersion":{"type":"string"},"connectionState":{"type":"string"},"creationTime":{"type":"number"},"dataPipelinesStatus":{"type":"string"},"hardwareModel":{"type":"string"},"hardwareSerial":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"numOfMappedAssets":{"type":"integer"},"offlineTime":{"type":"string"},"startTime":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/AgentDetail"},"type":"array"},"count":{"type":"integer"},"page":{"type":"integer"},"size":{"type":"integer"},"totalCount":{"type":"integer"}},"type":"object","$$ref":"#/components/schemas/AgentsListResponse"}}},"description":"successful retrieval"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string"},"path":{"type":"string"},"status":{"type":"integer"},"timestamp":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ForbiddenErrorResponse"}}},"description":"Forbidden"},"404":{"description":"Not found"},"500":{"description":"Server failure"}},"summary":"List Agents","tags":["AgentConfig"],"__originalOperationId":"getAgents","security":[{"httpBearer":[]}],"method":"get","path":"/agents"}}