Get Counts Connectors States - Cloud Security API

{"type":"api","title":"Get Counts Connectors States","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/d2a1854d5c0ed9069a7f0bc54a9b813f3075ddc9/285f00e0-2a84-3aa5-a063-4c30a2b82db0","info":{"title":"Cisco Secure Access Resource Connector Groups and Resource Connectors API","description":"Manage the Resource Connector Groups and Resource Connectors in the organization.\n","version":"1.0.0","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Connector Groups","description":"Manage the Resource Connector Groups."},{"name":"Connectors","description":"Manage the Resource Connectors."},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/deployments/connector-groups-overview.md","uri":"secure-access-api-reference-connector-groups-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"deployments/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"Client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"deployments.resourceconnectors:read":"Read the Resource Connector Group or Connector resources","deployments.resourceconnectors:write":"Write the Resource Connector Group or Connector resources"}}}}}},"spec":{"tags":["Connectors","Secure Access"],"summary":"Get Counts Connectors States","description":"Get the counts of the state information for the Connectors.","operationId":"getConnectorAgentCount","security":[{"oauthFlow":["deployments.resourceconnectors:read"]}],"responses":{"200":{"description":"OK","content":{"resource/json":{"schema":{"type":"object","description":"The counts of the state information for the Connectors in the organization.","properties":{"announced":{"type":"integer","description":"The number of Connectors in the organization that are in the announced state.","example":1},"connected":{"type":"integer","description":"The number of Connectors in the organization that are in the connected state.","example":3},"disabled":{"type":"integer","description":"The number of Connectors in the organization that are in the disabled state.","example":4},"disconnected":{"type":"integer","description":"The number of the Connectors in the organization that are in the disconnected state.","example":3},"expired":{"type":"integer","description":"The number of Connectors in the organization that are in the expired state.","example":2},"reachable":{"type":"integer","description":"The number of Connectors in the organization that are in the reachable state.","example":0},"unabledToSyncConnectorsCount":{"type":"integer","description":"The number of Connectors in the organization that are unabled to sync.","example":2},"needUpdateConnectorsCount":{"type":"integer","description":"The number of Connectors in the organization that require an update.","example":3},"total":{"type":"integer","description":"The total number of Connectors in the organization.","example":15},"upgrading":{"type":"integer","description":"The number of Connectors in the organziation that are in the upgrading state.","example":2}},"example":{"announced":1,"connected":3,"disabled":4,"disconnected":3,"expired":2,"reachable":0,"total":15,"upgrading":2},"$$ref":"#/components/schemas/connectorCountsResponse"},"example":{"announced":1,"connected":3,"disabled":4,"disconnected":3,"expired":2,"reachable":0,"total":15,"upgrading":2}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"The organization ID is a numeric value."},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Authorization token is invalid."},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Authorized"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Found"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Internal Server Error"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getConnectorAgentCount","method":"get","path":"/connectorAgents/counts"}}