Method: licenses.list

Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such asdebian-cloud orwindows-cloud.

Caution This resource is intended for use only by third-party partners who are creatingCloud Marketplace images.

HTTP request

GET https://compute.googleapis.com/compute/v1/projects/{project}/global/licenses

The URL usesgRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to theservice error catalog

Path parameters

Parameters

Parameters
`project`	`string` Project ID for this request.

project

string

Project ID for this request.

Query parameters

Parameters
`maxResults`	`integer (uint32 format)` The maximum number of results per page that should be returned. If the number of available results is larger than`maxResults`, Compute Engine returns a`nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are`0` to`500`, inclusive. (Default:`500`)
`pageToken`	`string` Specifies a page token to use. Set`pageToken` to the`nextPageToken` returned by a previous list request to get the next page of results.
`filter`	`string` A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposalAIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either`=`,`!=`,`>`,`<`,`<=`,`>=` or`:`. For example, if you are filtering Compute Engine instances, you can exclude instances named`example-instance` by specifying`name != example-instance`. The`:` comparison can be used to test whether a key has been defined. For example, to find all objects with`owner` label use: `labels.owner:` You can also filter nested fields. For example, you could specify`scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based onresource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: `(scheduling.automaticRestart = true)(cpuPlatform = "Intel Skylake")` By default, each expression is an`AND` expression. However, you can include`AND` and`OR` expressions explicitly. For example: `(cpuPlatform = "Intel Skylake") OR(cpuPlatform = "Intel Broadwell") AND(scheduling.automaticRestart = true)` If you want to use a regular expression, use the`eq` (equal) or`ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literalfieldname eq 'single quoted literal'fieldname eq "double quoted literal"(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using GoogleRE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use`name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
`orderBy`	`string` Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using`orderBy="creationTimestamp desc"`. This sorts results based on the`creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by`name` or`creationTimestamp desc` is supported.
`returnPartialSuccess`	`boolean` Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{"id":string,"items":[{"kind":string,"name":string,"chargesUseFee":boolean,"id":string,"licenseCode":string,"creationTimestamp":string,"description":string,"transferable":boolean,"selfLink":string,"selfLinkWithId":string,"resourceRequirements":{"minGuestCpuCount":integer,"minMemoryMb":integer},"appendableToDisk":boolean,"removableFromDisk":boolean,"allowedReplacementLicenses":[string],"osLicense":boolean,"incompatibleLicenses":[string],"requiredCoattachedLicenses":[string],"soleTenantOnly":boolean,"multiTenantOnly":boolean,"minimumRetention":{"seconds":string,"nanos":integer},"updateTimestamp":string}],"nextPageToken":string,"selfLink":string,"warning":{"code":enum,"message":string,"data":[{"key":string,"value":string}]}}

JSON representation

{"id":string,"items":[{"kind":string,"name":string,"chargesUseFee":boolean,"id":string,"licenseCode":string,"creationTimestamp":string,"description":string,"transferable":boolean,"selfLink":string,"selfLinkWithId":string,"resourceRequirements":{"minGuestCpuCount":integer,"minMemoryMb":integer},"appendableToDisk":boolean,"removableFromDisk":boolean,"allowedReplacementLicenses":[string],"osLicense":boolean,"incompatibleLicenses":[string],"requiredCoattachedLicenses":[string],"soleTenantOnly":boolean,"multiTenantOnly":boolean,"minimumRetention":{"seconds":string,"nanos":integer},"updateTimestamp":string}],"nextPageToken":string,"selfLink":string,"warning":{"code":enum,"message":string,"data":[{"key":string,"value":string}]}}

Fields
`id`	`string` [Output Only] Unique identifier for the resource; defined by the server.
`items[]`	`object` A list of License resources.
`items[].kind`	`string` [Output Only] Type of resource. Always`compute#license` for licenses.
`items[].name`	`string` Name of the resource. The name must be 1-63 characters long and comply withRFC1035.
`items[].chargesUseFee`	`boolean` [Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.
`items[].id`	`string (uint64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`items[].licenseCode`	`string (uint64 format)` [Output Only] The unique code used to attach this license to images, snapshots, and disks.
`items[].creationTimestamp`	`string` [Output Only] Creation timestamp inRFC3339 text format.
`items[].description`	`string` An optional textual description of the resource; provided by the client when the resource is created.
`items[].transferable`	`boolean` If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk.
`items[].selfLink`	`string` [Output Only] Server-defined URL for the resource.
`items[].selfLinkWithId`	`string` [Output Only] Server-defined URL for this resource with the resource id.
`items[].resourceRequirements`	`object` [Input Only] Deprecated.
`items[].resourceRequirements.minGuestCpuCount`	`integer` [Input Only] Deprecated. This field no longer reflects the minimum number of guest cpus required to use the Instance.
`items[].resourceRequirements.minMemoryMb`	`integer` [Input Only] Deprecated. This field no longer reflects the minimum memory required to use the Instance.
`items[].appendableToDisk`	`boolean` If true, this license can be appended to an existing disk's set of licenses.
`items[].removableFromDisk`	`boolean` If true, this license can be removed from a disk's set of licenses, with no replacement license needed.
`items[].allowedReplacementLicenses[]`	`string` Specifies licenseCodes of licenses that can replace this license. Note: such replacements are allowed even if removableFromDisk is false.
`items[].osLicense`	`boolean` If true, indicates this is an OS license. Only one OS license can be attached to a disk or image at a time.
`items[].incompatibleLicenses[]`	`string` Specifies licenseCodes of licenses that are incompatible with this license. If a license is incompatible with this license, it cannot be attached to the same disk or image.
`items[].requiredCoattachedLicenses[]`	`string` Specifies the set of permissible coattached licenseCodes of licenses that satisfy the coattachment requirement of this license. At least one license from the set must be attached to the same disk or image as this license.
`items[].soleTenantOnly`	`boolean` If true, this license can only be used on VMs on sole tenant nodes.
`items[].multiTenantOnly`	`boolean` If true, this license can only be used on VMs on multi tenant nodes.
`items[].minimumRetention`	`object` If set, this license will be unable to be removed or replaced once attached to a disk until the minimumRetention period has passed.
`items[].minimumRetention.seconds`	`string (int64 format)` Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
`items[].minimumRetention.nanos`	`integer` Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0`seconds` field and a positive`nanos` field. Must be from 0 to 999,999,999 inclusive.
`items[].updateTimestamp`	`string` [Output Only] Last update timestamp inRFC3339 text format.
`nextPageToken`	`string` [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than`maxResults`, use the`nextPageToken` as a value for the query parameter`pageToken` in the next list request. Subsequent list requests will have their own`nextPageToken` to continue paging through the results.
`selfLink`	`string` [Output Only] Server-defined URL for this resource.
`warning`	`object` [Output Only] Informational warning message.
`warning.code`	`enum` [Output Only] A warning code, if applicable. For example, Compute Engine returns`NO_RESULTS_ON_PAGE` if there are no results in the response.
`warning.message`	`string` [Output Only] A human-readable description of the warning code.
`warning.data[]`	`object` [Output Only] Metadata about this warning in`key: value` format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`warning.data[].key`	`string` [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be`scope` and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
`warning.data[].value`	`string` [Output Only] A warning data value corresponding to the key.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform

For more information, see theAuthentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the followingIAM permissions:

compute.licenses.list

To find predefined roles that contain those permissions, seeCompute Engine IAM Roles.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-09-18 UTC.

Movatterモバイル変換

Method: licenses.list Stay organized with collections Save and categorize content based on your preferences.