Chrome Policy API
Stay organized with collections
Save and categorize content based on your preferences.
The Chrome Policy API is a suite of services that allows Chrome administrators to control the policies applied to their managed Chrome OS devices and Chrome browsers.
Service: chromepolicy.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
https://chromepolicy.googleapis.com
| Methods |
resolve |
POST /v1/{customer=customers/*}/policies:resolve
Gets the resolved policy values for a list of policies that match a search query. |
| Methods |
batchDelete |
POST /v1/{customer=customers/*}/policies/groups:batchDelete
Delete multiple policy values that are applied to a specific group. |
batchModify |
POST /v1/{customer=customers/*}/policies/groups:batchModify
Modify multiple policy values that are applied to a specific group. |
listGroupPriorityOrdering |
POST /v1/{customer=customers/*}/policies/groups:listGroupPriorityOrdering
Retrieve a group priority ordering for an app. |
updateGroupPriorityOrdering |
POST /v1/{customer=customers/*}/policies/groups:updateGroupPriorityOrdering
Update a group priority ordering for an app. |
| Methods |
defineCertificate |
POST /v1/{customer=customers/*}/policies/networks:defineCertificate
Creates a certificate at a specified OU for a customer. |
defineNetwork |
POST /v1/{customer=customers/*}/policies/networks:defineNetwork
Define a new network. |
removeCertificate |
POST /v1/{customer=customers/*}/policies/networks:removeCertificate
Remove an existing certificate by guid. |
removeNetwork |
POST /v1/{customer=customers/*}/policies/networks:removeNetwork
Remove an existing network by guid. |
| Methods |
batchInherit |
POST /v1/{customer=customers/*}/policies/orgunits:batchInherit
Modify multiple policy values that are applied to a specific org unit so that they now inherit the value from a parent (if applicable). |
batchModify |
POST /v1/{customer=customers/*}/policies/orgunits:batchModify
Modify multiple policy values that are applied to a specific org unit. |
| Methods |
get |
GET /v1/{name=customers/*/policySchemas/**}
Get a specific policy schema for a customer by its resource name. |
list |
GET /v1/{parent=customers/*}/policySchemas
Gets a list of policy schemas that match a specified filter value for a given customer. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eThe Chrome Policy API empowers Chrome administrators to manage policies for Chrome OS devices and Chrome browsers.\u003c/p\u003e\n"],["\u003cp\u003eIt offers a suite of REST resources to define, modify, and resolve policies across various scopes like groups, networks, and organizational units.\u003c/p\u003e\n"],["\u003cp\u003eAdministrators can leverage the API to control policies related to certificates, networks, and group priority ordering, amongst other functionalities.\u003c/p\u003e\n"],["\u003cp\u003eThe API provides methods for retrieving policy schema details and uploading enterprise files.\u003c/p\u003e\n"],["\u003cp\u003eGoogle-provided client libraries are recommended for interacting with the API, and a discovery document is available for integration purposes.\u003c/p\u003e\n"]]],[],null,["# Chrome Policy API\n\nThe Chrome Policy API is a suite of services that allows Chrome administrators to control the policies applied to their managed Chrome OS devices and Chrome browsers.\n\n- [REST Resource: v1.customers.policies](#v1.customers.policies)\n- [REST Resource: v1.customers.policies.groups](#v1.customers.policies.groups)\n- [REST Resource: v1.customers.policies.networks](#v1.customers.policies.networks)\n- [REST Resource: v1.customers.policies.orgunits](#v1.customers.policies.orgunits)\n- [REST Resource: v1.customers.policySchemas](#v1.customers.policySchemas)\n- [REST Resource: v1.media](#v1.media)\n\nService: chromepolicy.googleapis.com\n------------------------------------\n\nTo call this service, we recommend that you use the Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:\n\n- \u003chttps://chromepolicy.googleapis.com/$discovery/rest?version=v1\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_service_endpoint) is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:\n\n- `https://chromepolicy.googleapis.com`\n\nREST Resource: [v1.customers.policies](/chrome/policy/reference/rest/v1/customers.policies)\n-------------------------------------------------------------------------------------------\n\n| Methods ||\n|------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| [resolve](/chrome/policy/reference/rest/v1/customers.policies/resolve) | `POST /v1/{customer=customers/*}/policies:resolve` Gets the resolved policy values for a list of policies that match a search query. |\n\nREST Resource: [v1.customers.policies.groups](/chrome/policy/reference/rest/v1/customers.policies.groups)\n---------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|-----------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| [batchDelete](/chrome/policy/reference/rest/v1/customers.policies.groups/batchDelete) | `POST /v1/{customer=customers/*}/policies/groups:batchDelete` Delete multiple policy values that are applied to a specific group. |\n| [batchModify](/chrome/policy/reference/rest/v1/customers.policies.groups/batchModify) | `POST /v1/{customer=customers/*}/policies/groups:batchModify` Modify multiple policy values that are applied to a specific group. |\n| [listGroupPriorityOrdering](/chrome/policy/reference/rest/v1/customers.policies.groups/listGroupPriorityOrdering) | `POST /v1/{customer=customers/*}/policies/groups:listGroupPriorityOrdering` Retrieve a group priority ordering for an app. |\n| [updateGroupPriorityOrdering](/chrome/policy/reference/rest/v1/customers.policies.groups/updateGroupPriorityOrdering) | `POST /v1/{customer=customers/*}/policies/groups:updateGroupPriorityOrdering` Update a group priority ordering for an app. |\n\nREST Resource: [v1.customers.policies.networks](/chrome/policy/reference/rest/v1/customers.policies.networks)\n-------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|-----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|\n| [defineCertificate](/chrome/policy/reference/rest/v1/customers.policies.networks/defineCertificate) | `POST /v1/{customer=customers/*}/policies/networks:defineCertificate` Creates a certificate at a specified OU for a customer. |\n| [defineNetwork](/chrome/policy/reference/rest/v1/customers.policies.networks/defineNetwork) | `POST /v1/{customer=customers/*}/policies/networks:defineNetwork` Define a new network. |\n| [removeCertificate](/chrome/policy/reference/rest/v1/customers.policies.networks/removeCertificate) | `POST /v1/{customer=customers/*}/policies/networks:removeCertificate` Remove an existing certificate by guid. |\n| [removeNetwork](/chrome/policy/reference/rest/v1/customers.policies.networks/removeNetwork) | `POST /v1/{customer=customers/*}/policies/networks:removeNetwork` Remove an existing network by guid. |\n\nREST Resource: [v1.customers.policies.orgunits](/chrome/policy/reference/rest/v1/customers.policies.orgunits)\n-------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|-------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [batchInherit](/chrome/policy/reference/rest/v1/customers.policies.orgunits/batchInherit) | `POST /v1/{customer=customers/*}/policies/orgunits:batchInherit` Modify multiple policy values that are applied to a specific org unit so that they now inherit the value from a parent (if applicable). |\n| [batchModify](/chrome/policy/reference/rest/v1/customers.policies.orgunits/batchModify) | `POST /v1/{customer=customers/*}/policies/orgunits:batchModify` Modify multiple policy values that are applied to a specific org unit. |\n\nREST Resource: [v1.customers.policySchemas](/chrome/policy/reference/rest/v1/customers.policySchemas)\n-----------------------------------------------------------------------------------------------------\n\n| Methods ||\n|-----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| [get](/chrome/policy/reference/rest/v1/customers.policySchemas/get) | `GET /v1/{name=customers/*/policySchemas/**}` Get a specific policy schema for a customer by its resource name. |\n| [list](/chrome/policy/reference/rest/v1/customers.policySchemas/list) | `GET /v1/{parent=customers/*}/policySchemas` Gets a list of policy schemas that match a specified filter value for a given customer. |\n\nREST Resource: [v1.media](/chrome/policy/reference/rest/v1/media)\n-----------------------------------------------------------------\n\n| Methods ||\n|---------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [upload](/chrome/policy/reference/rest/v1/media/upload) | `POST /v1/{customer=customers/*}/policies/files:uploadPolicyFile` `POST /upload/v1/{customer=customers/*}/policies/files:uploadPolicyFile` Creates an enterprise file from the content provided by user. |"]]
