{"type":"api","title":"Get Deployment Status by Organization","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/cba65c33-1da3-3556-a885-2c67eb61196b","info":{"title":"Cisco Umbrella Reporting API","description":"The Reporting API provides the data to generate the Umbrella reports.","version":"2.0.0","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Activity"},{"name":"Top Identities"},{"name":"Identity Distribution"},{"name":"Top Destinations"},{"name":"Top Categories"},{"name":"Top Event Types"},{"name":"Top DNS Query Types"},{"name":"Organization Requests by Hour"},{"name":"Organization Requests by Timerange"},{"name":"Organization Requests by Hour and Category"},{"name":"Organization Requests by Timerange and Category"},{"name":"Deployment Status"},{"name":"Provider Deployment Status"},{"name":"Provider Requests by Hour"},{"name":"Provider Requests by Timerange"},{"name":"Provider Requests by Organization"},{"name":"Provider Requests by Category"},{"name":"Provider Requests by Destination"},{"name":"Provider Category Requests by Organization"},{"name":"Bandwidth by Hour"},{"name":"Bandwidth by Timerange"},{"name":"Top Files"},{"name":"Total Requests"},{"name":"Top Threats"},{"name":"Top Threat Types"},{"name":"Utility"},{"name":"Top IPs"},{"name":"Summary"},{"name":"Summaries by Category"},{"name":"Summaries by Destination"},{"name":"Summaries by Rule (Intrusion)"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/reports/reporting-overview.md","uri":"umbrella-api-reference-reporting-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.granularEvents:read":"Read reports granular events","reports.utilities:read":"Read reports utilities","reports.aggregations:read":"Read reports aggregations","reports.summariesByRule:read":"Read reports for the summaries of the rule","reports.customers:read":"Read reports for the customers"}}}}}},"spec":{"tags":["Provider Deployment Status","Umbrella"],"summary":"Get Deployment Status by Organization","description":"List the summary counts of deployment status for the organization within the timeframe.\n\n**Access Scope:** Reports \u003e Customer \u003e Read-Only","operationId":"getDeploymentStatusByOrganization","security":[{"oauthFlow":["reports.customers:read"]}],"parameters":[{"name":"from","in":"query","description":"A timestamp or relative time string (for example: '-1days').\nFilter for data that appears after this time.","required":true,"schema":{"type":"string"},"example":"1639146300000","$$ref":"#/components/parameters/fromParam"},{"name":"to","in":"query","description":"A timestamp or relative time string (for example: 'now').\nFilter for data that appears before this time.","required":true,"schema":{"type":"string"},"example":"1640010300000","$$ref":"#/components/parameters/toParam"},{"name":"threats","in":"query","description":"A threat name or comma-delimited list of threat names.","schema":{"type":"string"},"$$ref":"#/components/parameters/threatsParam"},{"name":"threattypes","in":"query","description":"A threat type or comma-delimited list of threat types.","schema":{"type":"string"},"$$ref":"#/components/parameters/threatTypesParam"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","description":"The deployment status for the organization.","required":["organization","counts"],"properties":{"organization":{"type":"object","description":"The information about the organization.","properties":{"id":{"type":"number","description":"orgid"},"label":{"type":"string","description":"The name of the organization."}},"$$ref":"#/components/schemas/Organization"},"counts":{"type":"array","items":{"type":"object","description":"The information about the provider's deployment status.","properties":{"identitytype":{"type":"object","description":"The information about the identity including the type.","properties":{"id":{"type":"number","description":"The ID of the origin type for the identity."},"label":{"type":"string","description":"The label of the origin type for the identity."},"type":{"type":"string","description":"The name of the origin type for the identity."}},"$$ref":"#/components/schemas/IdentityType"},"activecount":{"type":"number","description":"The number of active identity types."},"count":{"type":"number","description":"The total number of identity type."}},"required":["activecount","count","identitytype"],"example":{"identitytype":{"id":21,"label":"Sites","name":"site"},"activecount":1,"count":1},"$$ref":"#/components/schemas/ProviderDeploymentStatus"}}},"example":{"organization":{"id":232323,"label":"Company Name Goes Here"},"counts":[{"identitytype":{"id":21,"label":"Sites","name":"site"},"activecount":1,"count":1}]},"$$ref":"#/components/schemas/OrganizationDeploymentStatus"}},"meta":{"type":"object","description":"The properties of the metadata.","example":{},"$$ref":"#/components/schemas/Meta"}},"required":["data","meta"]},"example":{"data":[{"organization":{"id":232323,"label":"Company Name Goes Here"},"counts":[{"identitytype":{"id":21,"label":"Sites","type":"site"},"activecount":1,"count":1}]}],"meta":{}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Bad Request"}}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Unauthorized"}}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Forbidden"}}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Not Found"}}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Internal Server Error"}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getDeploymentStatusByOrganization","method":"get","path":"/providers/deployments"}}