{"type":"api","title":"Get Protocol","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/d2a1854d5c0ed9069a7f0bc54a9b813f3075ddc9/29468fdf-90c8-34ef-bf3f-a1b0fc9fc185","info":{"title":"Cisco Umbrella App Discovery API","description":"The App Discovery API provides an overall view of application and protocol activity in your environment\nand the potential risk indicated by this network traffic.","version":"2.0.1","contact":{"name":"Cloud Security Developer Community"}},"tags":[{"name":"Applications"},{"name":"Application Categories"},{"name":"Protocols"},{"name":"Identities"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/reports/app-discovery-overview.md","uri":"umbrella-api-reference-app-discovery-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrella.com/{basePath}","variables":{"basePath":{"default":"reports/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrella.com/auth/v2/token","scopes":{"reports.appDiscovery:write":"Write reports app discovery","reports.appDiscovery:read":"Read reports app discovery"}}}}}},"spec":{"tags":["Protocols","Umbrella"],"summary":"Get Protocol","description":"Get protocol by ID.","operationId":"getProtocol","parameters":[{"in":"path","name":"protocolId","description":"The ID of the protocol.","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/protocolId"},{"in":"query","name":"date","schema":{"type":"string","format":"date"},"description":"Specify a date to search for data within a twenty-four hour time period.\nIf you do not provide a date, the last 90 days period is used to query the collection.","example":"2022-01-01","$$ref":"#/components/parameters/date"}],"security":[{"oauthFlow":["reports.appDiscovery:read"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"The app's protocol information.","properties":{"id":{"type":"string","description":"The ID of the protocol.","example":"0j1b5EmA"},"name":{"type":"string","description":"The name of the protocol.","example":"ftp"},"description":{"type":"string","description":"The description of the protocol.","example":"File Transfer Protocol"},"identitiesCount":{"type":"integer","description":"The number of identities.","example":5},"events":{"type":"integer","description":"The number of identity events.","example":100},"blockedEvents":{"type":"integer","description":"The number of blocked events for the identities.","example":50},"firstDetected":{"type":"string","format":"date-time","description":"The date and time (ISO 8601 timestamp) when the protocol was first detected for the identities.","example":"2022-01-01T00:00:00.000Z"},"lastDetected":{"type":"string","format":"date-time","description":"The date and time (ISO 8601 timestamp) when the protocol was last detected for the identities.","example":"2022-01-01T00:00:00.000Z"}},"example":{"id":"0j1b5Em","name":"ftp","description":"File Transfer Protocol","identitiesCount":5,"events":100,"blockedEvents":40,"firstDetected":"2022-01-01T00:00:00.000Z","lastDetected":"2022-01-01T00:00:00.000Z"},"$$ref":"#/components/schemas/ProtocolObject"},"example":{"id":"0j1b5EmA","name":"ftp","description":"File Transfer Protocol","identitiesCount":5,"events":100,"blockedEvents":50,"firstDetected":"2022-01-01T00:00:00.000Z","lastDetected":"2022-01-01T00:00:00.000Z"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","description":"The error message returned in the response.","properties":{"message":{"type":"string"}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/InvalidRequest"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"type":"object","description":"The error message returned in the response.","properties":{"message":{"type":"string"}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/Unauthorized"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","description":"The error message returned in the response.","properties":{"message":{"type":"string"}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/Forbidden"},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","description":"The error message returned in the response.","properties":{"message":{"type":"string"}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/NotFound"},"500":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","description":"The error message returned in the response.","properties":{"message":{"type":"string"}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/ServerError"}},"__originalOperationId":"getProtocol","method":"get","path":"/appDiscovery/protocols/{protocolId}"}}