Use this page to upgrade your apps to use the v1
version of the
Admin API. The v1beta4
and v1beta5
versions of the API are
no longer supported and scheduled for shut down on January 14, 2019.
Upgrading your apps to the latest version
To upgrade to the latest Admin API version you must make some changes to your app's code.
Version v1
of the API has a few breaking changes due to either deprecated
or renamed resources. The changes in version v1
affect the fields and
methods across all of the resources in the API, including:
Use the following lists to understand which fields and methods have
been deprecated or renamed in the v1
version of the API.
For client libraries, the following lists do not specifically outline changes for any of the libraries. However, you should use these lists to determine where changes to your app are required.
Applications
For Applications
resources, you must make the following changes:
For the REST API:
You must now use the
updateMask
parameter with theapps.patch
method, for example:mask
→updateMask
The
ensureResourcesExist
parameter has been removed from theapps.get
method. Inv1
, you can instead use theapps.repair
method.
For the RPC API:
You must now use the
location_id
field with thegoogle.appengine.v1.Application
resource, for example:location
→location_id
You must now use the
update_mask
field with thegoogle.appengine.v1.UpdateApplicationRequest
resource, for example:mask
→update_mask
The
ensure_resources_exist
field has been removed from thegoogle.appengine.v1.GetApplicationRequest
resource. You can instead use theRepairApplication
method.
Instances
For Instances
resources, you must make the following changes:
For the REST API:
You must now use the
startTime
andvmDebugEnabled
field with theapps.services.versions.instances
resource, for example:startTimestamp
→startTime
vmUnlocked
→vmDebugEnabled
You must now use the
parent
field with theapps.services.versions.instances
resource, for example:name
→parent
For
v1beta4
only: All references tomodules
are nowservices
. Inv1
, you must now use theservices
resource, for example:apps.services.versions.instances
apps.modules.versions.instances
→apps.services.versions.instances
See the Services section below for more information.
For the RPC API:
You must now use
start_time
andvm_debug_enabled
fields with thegoogle.appengine.v1.Instance
resource, for example:start_timestamp
→start_time
vm_unlocked
→vm_debug_enabled
You must now use the
parent
field with thegoogle.appengine.v1.ListInstancesRequest
resource, for example:name
→parent
For
v1beta4
only: All references tomodule
have been replaced with theservice
resource.See the Services section below for more information.
Services
For Services
resources, you must make the following changes:
For the REST API:
You must now use the
parent
field with theapps.services
resource, for example:name
→parent
You must now use the
updateMask
parameter with theapps.services.patch
method, for example:mask
→updateMask
For
v1beta4
only: All references tomodules
are nowservices
. Inv1
, you must now use theservices
resource, for example:apps.modules.delete
→apps.services.delete
apps.modules.get
→apps.services.get
apps.modules.list
→apps.services.list
apps.modules.patch
→apps.services.patch
For the RPC API:
You must now use the
parent
field with thegoogle.appengine.v1.ListServicesRequest
resource, for example:name
→parent
You must now use the
updateMask
field with thegoogle.appengine.v1.UpdateServicesRequest
resource, for example:mask
→update_mask
For
v1beta4
only: All references tomodules
are nowservices
. Inv1
, you must now use theServices
interface, for example:DeleteModule
→DeleteService
GetModule
→GetService
ListModules
→ListServices
UpdateModule
→UpdateServices
Versions
For Versions
resources, you must make the following changes:
For the REST API:
You must now use the
parent
field with theapps.services.versions
resource, for example:name
→parent
You must now use the
updateMask
parameter with theapps.services.versions.patch
method, for example:mask
→updateMask
For
v1beta4
only: All references tomodules
are nowservices
. Inv1
, you must now use theservices
resource, for example:apps.modules.versions
→apps.services.versions
For the RPC API:
You must now use the
created_by
andcreated_time
fields with thegoogle.appengine.v1.Version
interface, for example:deployer
→created_by
created_by
→create_time
You must now use the
parent
field with thegoogle.appengine.v1.CreateVersionRequest
andgoogle.appengine.v1.ListVersionsRequest
resources, for example:name
→parent
You must now use the
updateMask
field with thegoogle.appengine.v1.UpdateVersionRequest
resource, for example:mask
→update_mask
Deployment
The following fields have been removed:
For the REST API:
The
sourceReferences
field was deprecated and removed from theapps.services.versions
resource.For the RPC API:
The
source_references
field was deprecated and removed from thegoogle.appengine.v1.Deployment
resource.
DiskUtilization
The following fields have changed:
For the REST API:
You must now use the
targetWriteBytesPerSecond
,targetWriteOpsPerSecond
,targetReadBytesPerSecond
, andtargetReadOpsPerSecond
fields with theapps.services.versions
resources, for example:targetWriteBytesPerSec
→targetWriteBytesPerSecond
targetWriteOpsPerSec
→targetWriteOpsPerSecond
targetReadBytesPerSec
→targetReadBytesPerSecond
targetReadOpsPerSec
→targetReadOpsPerSecond
For the RPC API:
You must now use the
target_write_bytes_per_second
,target_write_ops_per_second
,target_read_bytes_per_second
, andtarget_read_ops_per_second
fields with thegoogle.appengine.v1.DiskUtilization
resource, for example:target_write_bytes_per_sec
→target_write_bytes_per_second
target_write_ops_per_sec
→target_write_ops_per_second
target_read_bytes_per_sec
→target_read_bytes_per_second
target_read_ops_per_sec
→target_read_ops_per_second
NetworkUtilization
The following fields have changed:
For the REST API:
You must now use the
targetSentBytesPerSecond
,targetSentPacketsPerSecond
,targetReceivedBytesPerSecond
, andtargetReceivedPacketsPerSecond
fields with theapps.services.versions
resource, for example:targetSentBytesPerSec
→targetSentBytesPerSecond
targetSentPacketsPerSec
→targetSentPacketsPerSecond
targetReceivedBytesPerSec
→targetReceivedBytesPerSecond
targetReceivedPacketsPerSec
→targetReceivedPacketsPerSecond
For the RPC API:
You must now use the
target_sent_bytes_per_second
,target_sent_packets_per_second
,target_received_bytes_per_second
, andtarget_received_packets_per_second
fields with thegoogle.appengine.v1.NetworkUtilization
resource, for example:target_sent_bytes_per_sec
→target_sent_bytes_per_second
target_sent_packets_per_sec
→target_sent_packets_per_second
target_received_bytes_per_sec
→target_received_bytes_per_second
target_received_packets_per_sec
→target_received_packets_per_second
OperationMetadataV1
The following fields have changed:
You must now use the
method
field with thegoogle.appengine.v1.OperationMetadataV1
resource, for example:operation_type
→method
You must now use the
OperationMetadataV1
field with thegoogle.appengine.v1.OperationMetadataV1
resource:For
v1beta4
, replaceOperationMetadata
, for example:OperationMetadata
→OperationMetadataV1
For
v1beta5
, replaceOperationMetadataV1Beta5
, for example:OperationMetadataV1Beta5
→OperationMetadataV1
RequestUtilization
The following fields have changed:
For the REST API:
You must now use the
targetRequestCountPerSecond
field with theapps.services.versions
resource, for example:targetRequestCountPerSec
→targetRequestCountPerSecond
For the RPC API:
You must now use the
target_request_count_per_second
field with thegoogle.appengine.v1.RequestUtilization
resource, for example:target_request_count_per_sec
→target_request_count_per_second
UrlDispatchRule
You must now use the service
field with the
apps
REST API resource and the
google.appengine.v1.UrlDispatchRule
RPC resource, for example:
UrlDispatchRule.module
→
UrlDispatchRule.service