Chrome Management API
The Chrome Management API is a suite of services that allows Chrome administrators to view, manage and gain insights on their Chrome OS and Chrome Browser…
Developer tools#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Chrome Management API is a suite of services that allows Chrome administrators to view, manage and gain insights on their Chrome OS and Chrome Browser devices.
Endpoints 53
operations
- GETLists operations that match the specified filter in the request
/v1/:name?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. - DELETEDeletes a long-running operation
/v1/:nameDeletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If… - POSTStarts asynchronous cancellation on a long-running operation
/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the…
customers.connectorConfigs
- PATCHUpdates a connector config.
/v1/:name?updateMask=stringUpdates a connector config. - GETLists connector configs of a customer.
/v1/:parent/connectorConfigs?pageSize=0&pageToken=stringLists connector configs of a customer. - POSTCreates a connector config.
/v1/:parent/connectorConfigs?connectorConfigId=stringCreates a connector config.
customers.apps
- GETGenerate summary of app installation requests.
/v1/:customer/apps:countChromeAppRequests?orderBy=string&orgUnitId=string&pageSize=0&pageToken=stringGenerate summary of app installation requests. - GETGet a list of devices that have requested to install an extension.
/v1/:customer/apps:fetchDevicesRequestingExtension?extensionId=string&orgUnitId=string&pageSize=0&pageToken=stringGet a list of devices that have requested to install an extension. - GETGet a list of users that have requested to install an extension.
/v1/:customer/apps:fetchUsersRequestingExtension?extensionId=string&orgUnitId=string&pageSize=0&pageToken=stringGet a list of users that have requested to install an extension.
customers.certificateProvisioningProcesses
- POSTClaims a certificate provisioning process
/v1/:name:claimClaims a certificate provisioning process. For each certificate provisioning process, this operation can succeed only for one caller_instance_id. - POSTMarks a certificate provisioning process as failed.
/v1/:name:setFailureMarks a certificate provisioning process as failed. - POSTRequests the client that initiated a certificate provisioning process to sign data
/v1/:name:signDataRequests the client that initiated a certificate provisioning process to sign data. This should only be called after ClaimCertificateProvisioningProcess has… - POSTUploads a successfully issued certificate for a certificate provisioning process.
/v1/:name:uploadCertificateUploads a successfully issued certificate for a certificate provisioning process.
customers.chromeBrowsers
- GETRetrieves all Chrome Browsers of a customer (paginated).
/v1/:parent/chromeBrowsers?filter=string&orderBy=string&pageSize=0&pageToken=stringRetrieves all Chrome Browsers of a customer (paginated). - POSTMoves managed Chrome Browsers to a new Organizational Unit (OU)
/v1/:parent/chromeBrowsers:moveMoves managed Chrome Browsers to a new Organizational Unit (OU). If there is an error while moving any of the browsers, none of the browsers will be moved.
customers.enrollmentTokens
- GETLists all browser device enrollment tokens.
/v1/:parent/enrollmentTokens?filter=string&pageSize=0&pageToken=stringLists all browser device enrollment tokens. - POSTCreates a new enrollment token for a browser device
/v1/:parent/enrollmentTokens?enrollmentTokenId=stringCreates a new enrollment token for a browser device. Creation fails if there is already an active token for this customer under the same org unit. - POSTRevokes a browser device enrollment token.
/v1/:name:revokeRevokes a browser device enrollment token.
customers.enterprise.securityInsights
- GETGets the setting state of the insights feature for the customer.
/v1/:customer/enterprise/securityInsights:checkEnablementStatusGets the setting state of the insights feature for the customer. - POSTDisables insights for the customer.
/v1/:customer/enterprise/securityInsights:disableDisables insights for the customer. - POSTEnables insights for the customer and sets up required chrome connectors.
/v1/:customer/enterprise/securityInsights:enableEnables insights for the customer and sets up required chrome connectors. - GETReturns a high-level summary of content transfers for a given customer.
/v1/:customer/enterprise/securityInsights:queryContentTransfers?filter=stringReturns a high-level summary of content transfers for a given customer. - GETReturns summaries of content transfers for a given metric and breakdown dimension.
/v1/:customer/enterprise/securityInsights:queryContentTransfersBreakdowns?breakdown=CONTENT_TRANSFERS_BREAKDOWN_DIMENSION_UNSPECIFIED&filter=string&fixedTimeRange=FIXED_TIME_RANGE_UNSPECIFIED&metric=CONTENT_TRANSFERS_METRIC_UNSPECIFIED&pageSize=0&pageToken=stringReturns summaries of content transfers for a given metric and breakdown dimension. - GETReturns a high-level summary of URL visits for a given customer
/v1/:customer/enterprise/securityInsights:queryUrlVisits?filter=stringReturns a high-level summary of URL visits for a given customer. Requires a Chrome Enterprise Premium subscription. If the customer does not have this… - GETReturns summaries of URL visits for a given metric and breakdown dimension
/v1/:customer/enterprise/securityInsights:queryUrlVisitsBreakdowns?breakdown=URL_VISITS_BREAKDOWN_DIMENSION_UNSPECIFIED&filter=string&fixedTimeRange=FIXED_TIME_RANGE_UNSPECIFIED&metric=URL_VISITS_METRIC_UNSPECIFIED&pageSize=0&pageToken=stringReturns summaries of URL visits for a given metric and breakdown dimension. Requires a Chrome Enterprise Premium subscription. If the customer does not have…
customers.profiles
- GETLists Chrome browser profiles of a customer based on the given search and sorting criteria.
/v1/:parent/profiles?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Chrome browser profiles of a customer based on the given search and sorting criteria.
customers.profiles.commands
- GETLists remote commands of a Chrome browser profile.
/v1/:parent/commands?pageSize=0&pageToken=stringLists remote commands of a Chrome browser profile. - POSTCreates a Chrome browser profile remote command.
/v1/:parent/commandsCreates a Chrome browser profile remote command.
customers.reports
- GETGet a count of active devices per set time frames.
/v1/:customer/reports:countActiveDevices?date.day=0&date.month=0&date.year=0Get a count of active devices per set time frames. - GETCount of Chrome Browsers that have been recently enrolled, have new policy to be synced, or have no recent activity.
/v1/:customer/reports:countChromeBrowsersNeedingAttention?orgUnitId=stringCount of Chrome Browsers that have been recently enrolled, have new policy to be synced, or have no recent activity. - GETGet a count of Chrome crash events.
/v1/:customer/reports:countChromeCrashEvents?filter=string&orderBy=string&orgUnitId=stringGet a count of Chrome crash events. - GETGenerate report of the number of devices expiring in each month of the selected time frame
/v1/:customer/reports:countChromeDevicesReachingAutoExpirationDate?maxAueDate=string&minAueDate=string&orgUnitId=stringGenerate report of the number of devices expiring in each month of the selected time frame. Devices are grouped by auto update expiration date and model.… - GETCounts of ChromeOS devices that have not synced policies or have lacked user activity in the past 28 days, are out of…
/v1/:customer/reports:countChromeDevicesThatNeedAttention?orgUnitId=string&readMask=stringCounts of ChromeOS devices that have not synced policies or have lacked user activity in the past 28 days, are out of date, or are not complaint. Further… - GETCounts of devices with a specific hardware specification from the requested hardware type (for example model name,…
/v1/:customer/reports:countChromeHardwareFleetDevices?orgUnitId=string&readMask=stringCounts of devices with a specific hardware specification from the requested hardware type (for example model name, processor type). Further information can be… - GETGenerate report of installed Chrome versions on managed profiles.
/v1/:customer/reports:countChromeProfileVersions?filter=string&orgUnitId=string&pageSize=0&pageToken=stringGenerate report of installed Chrome versions on managed profiles. - GETGenerate report of installed Chrome versions.
/v1/:customer/reports:countChromeVersions?filter=string&orgUnitId=string&pageSize=0&pageToken=stringGenerate report of installed Chrome versions. - GETGet a count of devices per boot type.
/v1/:customer/reports:countDevicesPerBootType?date.day=0&date.month=0&date.year=0Get a count of devices per boot type. - GETGet a count of devices per channel.
/v1/:customer/reports:countDevicesPerReleaseChannel?date.day=0&date.month=0&date.year=0Get a count of devices per channel. - GETGenerate report of app installations.
/v1/:customer/reports:countInstalledApps?filter=string&orderBy=string&orgUnitId=string&pageSize=0&pageToken=stringGenerate report of app installations. - GETGet a summary of printing done by each printer.
/v1/:customer/reports:countPrintJobsByPrinter?filter=string&orderBy=string&pageSize=0&pageToken=string&printerOrgUnitId=stringGet a summary of printing done by each printer. - GETGet a summary of printing done by each user.
/v1/:customer/reports:countPrintJobsByUser?filter=string&orderBy=string&pageSize=0&pageToken=string&printerOrgUnitId=stringGet a summary of printing done by each user. - GETGet a list of print jobs.
/v1/:customer/reports:enumeratePrintJobs?filter=string&orderBy=string&pageSize=0&pageToken=string&printerOrgUnitId=stringGet a list of print jobs. - GETGenerate report of managed Chrome browser devices that have a specified app installed.
/v1/:customer/reports:findInstalledAppDevices?appId=string&appType=APP_TYPE_UNSPECIFIED&filter=string&orderBy=string&orgUnitId=string&pageSize=0&pageToken=stringGenerate report of managed Chrome browser devices that have a specified app installed. - GETGenerate report of managed Chrome profiles that have a specified app installed.
/v1/:customer/reports:findInstalledAppProfiles?appId=string&appType=APP_TYPE_UNSPECIFIED&filter=string&orderBy=string&orgUnitId=string&pageSize=0&pageToken=stringGenerate report of managed Chrome profiles that have a specified app installed. - GETFind SaaS usage reports of a customer based on the given search and sorting criteria.
/v1/:customer/reports:findSaasUsage?filter=string&orderBy=string&pageSize=0&pageToken=stringFind SaaS usage reports of a customer based on the given search and sorting criteria. - GETFind SaaS usage reports of a customer grouped by browsers based on the given search and sorting criteria.
/v1/:customer/reports:findSaasUsageBrowsers?app=string&filter=string&orderBy=string&pageSize=0&pageToken=stringFind SaaS usage reports of a customer grouped by browsers based on the given search and sorting criteria. - GETFind SaaS usage reports of a customer grouped by profiles based on the given search and sorting criteria.
/v1/:customer/reports:findSaasUsageProfiles?app=string&filter=string&orderBy=string&pageSize=0&pageToken=stringFind SaaS usage reports of a customer grouped by profiles based on the given search and sorting criteria.
customers.telemetry.devices
- GETList all telemetry devices.
/v1/:parent/telemetry/devices?filter=string&pageSize=0&pageToken=string&readMask=stringList all telemetry devices.
customers.telemetry.events
- GETList telemetry events.
/v1/:parent/telemetry/events?filter=string&pageSize=0&pageToken=string&readMask=stringList telemetry events.
customers.telemetry.notificationConfigs
- GETList all telemetry notification configs.
/v1/:parent/telemetry/notificationConfigs?pageSize=0&pageToken=stringList all telemetry notification configs. - POSTCreate a telemetry notification config.
/v1/:parent/telemetry/notificationConfigsCreate a telemetry notification config.
customers.telemetry.users
- GETList all telemetry users.
/v1/:parent/telemetry/users?filter=string&pageSize=0&pageToken=string&readMask=stringList all telemetry users.
customers.thirdPartyProfileUsers
- POSTMoves a third party chrome profile user to a destination OU
/v1/:name:moveMoves a third party chrome profile user to a destination OU. All profiles associated to that user will be moved to the destination OU.
API details
- Base URL
https://chromemanagement.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 11 scopes
An API key in the key query parameter - Operations
- 53 operations on 47 pathsGET 37POST 14PATCH 1DELETE 1
- Main resources
- customers.reports 19customers.enterprise.securityInsights 7customers.certificateProvisioningProcesses 4customers.apps 3customers.connectorConfigs 3customers.enrollmentTokens 3operations 3customers.chromeBrowsers 2customers.profiles.commands 2customers.telemetry.notificationConfigs 2
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Chrome Management API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Chrome Management API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 11 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Lists operations that match the specified filter in the request” (GET /v1/:name?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=true), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Chrome Management API?
The Chrome Management API is a suite of services that allows Chrome administrators to view, manage and gain insights on their Chrome OS and Chrome Browser… It is listed under Developer tools and has 53 endpoints.
Who publishes the Chrome Management API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Chrome Management API?
Requests go to https://chromemanagement.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Chrome Management API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 11 scopes; an API key in the key query parameter.
How many endpoints does the Chrome Management API have?
53 operations on 47 paths (37 GET, 14 POST, 1 PATCH, 1 DELETE). The largest groups are customers.reports, customers.enterprise.securityInsights, customers.certificateProvisioningProcesses, customers.apps.
Is forking the Chrome Management API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.