System parameters | Cloud APIs

These parameters are available across all Google REST APIs and gRPC APIs. A system parameter can be specified either using an HTTP query parameter or an ... Overview close Accelerateyourdigitaltransformation Whetheryourbusinessisearlyinitsjourneyorwellonitswaytodigitaltransformation,GoogleCloudcanhelpsolveyourtoughestchallenges. Learnmore Keybenefits WhyGoogleCloud Topreasonsbusinesseschooseus. Multicloud Runyourappswhereveryouneedthem. Trustandsecurity Keepyourdatasecureandcompliant. Globalinfrastructure BuildonthesameinfrastructureasGoogle. DataCloud Makesmarterdecisionswithunifieddata. Opencloud Scalewithopen,flexibletechnology. Sustainability Runonthecleanestcloudintheindustry. Productivityandcollaboration ConnectyourteamswithAI-poweredapps. Solutions close IndustrySolutions Reducecost,increaseoperationalagility,andcapturenewmarketopportunities. Retail Analyticsandcollaborationtoolsfortheretailvaluechain. ConsumerPackagedGoods SolutionsforCPGdigitaltransformationandbrandgrowth. FinancialServices Computing,datamanagement,andanalyticstoolsforfinancialservices. HealthcareandLifeSciences Advanceresearchatscaleandempowerhealthcareinnovation. MediaandEntertainment Solutionsforcontentproductionanddistributionoperations. Telecommunications Hybridandmulti-cloudservicestodeployandmonetize5G. Gaming AI-drivensolutionstobuildandscalegamesfaster. Manufacturing MigrationandAItoolstooptimizethemanufacturingvaluechain. SupplyChainandLogistics Digitalsupplychainsolutionsbuiltinthecloud. Government Datastorage,AI,andanalyticssolutionsforgovernmentagencies. Education Teachingtoolstoprovidemoreengaginglearningexperiences. Notseeingwhatyou'relookingfor? Seeallindustrysolutions Notseeingwhatyou'relookingfor? Seeallsolutions ApplicationModernization Developandrunapplicationsanywhere,usingcloud-nativetechnologieslikecontainers,serverless,andservicemesh. HybridandMulti-cloudApplicationPlatform Platformformodernizinglegacyappsandbuildingnewapps. APIManagement AccelerateapplicationdesignanddevelopmentwithanAPI-firstapproach. ServerlessSolutions Fullymanagedenvironmentfordeveloping,deployingandscalingapps. DevOps ProcessesandresourcesforimplementingDevOpsinyourorg. ContinuousDelivery(CD) End-to-endautomationfromsourcetoproduction. ContinuousIntegration(CI) Fastfeedbackoncodechangesatscale. MainframeModernization Automatedtoolsandprescriptiveguidanceformovingtothecloud. CAMP ProgramthatusesDORAtoimproveyoursoftwaredeliverycapabilities. Hosting Servicesandinfrastructureforbuildingwebappsandwebsites. SiteReliabilityEngineering(SRE) ToolsandresourcesforadoptingSREinyourorg. ArtificialIntelligence AddintelligenceandefficiencytoyourbusinesswithAIandmachinelearning. ContactCenterAI AImodelforspeakingwithcustomersandassistinghumanagents. DocumentAI Documentprocessinganddatacaptureautomatedatscale. Intelligentproducts End-to-endsolutionforcreatingproductswithpersonalizedownershipexperiences. ProductDiscovery Google-qualitysearchandproductrecommendationsforretailers. APIsandApplications Speedupthepaceofinnovationwithoutcoding,usingAPIs,apps,andautomation. NewBusinessChannelsUsingAPIs Attractandempoweranecosystemofdevelopersandpartners. UnlockingLegacyApplicationsUsingAPIs Cloudservicesforextendingandmodernizinglegacyapps. OpenBankingAPIx SimplifyandacceleratesecuredeliveryofopenbankingcompliantAPIs. Databases Migrateandmanageenterprisedatawithsecurity,reliability,highavailability,andfullymanageddataservices. DatabaseMigration Guidesandtoolstosimplifyyourdatabasemigrationlifecycle. DatabaseModernization Upgradestomodernizeyouroperationaldatabaseinfrastructure. GoogleCloudDatabases Databaseservicestomigrate,manage,andmodernizedata. MigrateOracleworkloadstoGoogleCloud Rehost,replatform,rewriteyourOracleworkloads. OpenSourceDatabases Fullymanagedopensourcedatabaseswithenterprise-gradesupport. SQLServeronGoogleCloud OptionsforrunningSQLServervirtualmachinesonGoogleCloud. DataCloud Unifydataacrossyourorganizationwithanopenandsimplifiedapproachtodata-driventransformationthatisunmatchedforspeed,scale,andsecuritywithAIbuilt-in. DatabasesSolutions Migrateandmanageenterprisedatawithsecurity,reliability,highavailability,andfullymanageddataservices. SmartAnalyticsSolutions Generateinstantinsightsfromdataatanyscalewithaserverless,fullymanagedanalyticsplatformthatsignificantlysimplifiesanalytics. AISolutions AddintelligenceandefficiencytoyourbusinesswithAIandmachinelearning. DataCloudforISVs Innovate,optimizeandamplifyyourSaaSapplicationsusingGoogle'sdataandmachinelearningsolutionssuchasBigQuery,Looker,SpannerandVertexAI. DataCloudAlliance Aninitiativetoensurethatglobalbusinesseshavemoreseamlessaccessandinsightsintothedatarequiredfordigitaltransformation. DigitalTransformation Acceleratebusinessrecoveryandensureabetterfuturewithsolutionsthatenablehybridandmulti-cloud,generateintelligentinsights,andkeepyourworkersconnected. DigitalInnovation Reimagineyouroperationsandunlocknewopportunities. OperationalEfficiency Prioritizeinvestmentsandoptimizecosts. COVID-19Solutions Getworkdonemoresafelyandsecurely. COVID-19SolutionsfortheHealthcareIndustry HowGoogleishelpinghealthcaremeetextraordinarychallenges. InfrastructureModernization MigratequicklywithsolutionsforSAP,VMware,Windows,Oracle,andotherworkloads. ApplicationMigration Discoveryandanalysistoolsformovingtothecloud. SAPonGoogleCloud CertificationsforrunningSAPapplicationsandSAPHANA. HighPerformanceComputing Compute,storage,andnetworkingoptionstosupportanyworkload. WindowsonGoogleCloud ToolsandpartnersforrunningWindowsworkloads. DataCenterMigration MigrationsolutionsforVMs,apps,databases,andmore. ActiveAssist Automaticcloudresourceoptimizationandincreasedsecurity. VirtualDesktops Remoteworksolutionsfordesktopsandapplications(VDI&DaaS). RapidAssessment&MigrationProgram(RAMP) End-to-endmigrationprogramtosimplifyyourpathtothecloud. BackupandDisasterRecovery Ensureyourbusinesscontinuityneedsaremet. ProductivityandCollaboration Changethewayteamsworkwithsolutionsdesignedforhumansandbuiltforimpact. GoogleWorkspace Collaborationandproductivitytoolsforenterprises. GoogleWorkspaceEssentials Securevideomeetingsandmoderncollaborationforteams. CloudIdentity UnifiedplatformforITadminstomanageuserdevicesandapps. ChromeEnterprise ChromeOS,ChromeBrowser,andChromedevicesbuiltforbusiness. CloudSearch Enterprisesearchforemployeestoquicklyfindcompanyinformation. Security Detect,investigate,andrespondtoonlinethreatstohelpprotectyourbusiness. SecurityAnalyticsandOperations Solutionforanalyzingpetabytesofsecuritytelemetry. WebAppandAPIProtection ThreatandfraudprotectionforyourwebapplicationsandAPIs. SecurityandResilienceFramework Solutionsforeachphaseofthesecurityandresiliencelifecycle. Riskandcomplianceascode(RCaC) Solutiontomodernizeyourgovernance,risk,andcompliancefunctionwithautomation. SoftwareSupplyChainSecurity Solutionforimprovingend-to-endsoftwaresupplychainsecurity. SmartAnalytics Generateinstantinsightsfromdataatanyscalewithaserverless,fullymanagedanalyticsplatformthatsignificantlysimplifiesanalytics. DataWarehouseModernization Datawarehousetojumpstartyourmigrationandunlockinsights. DataLakeModernization Servicesforbuildingandmodernizingyourdatalake. SparkonGoogleCloud RunandwriteSparkwhereyouneedit,serverlessandintegrated. StreamAnalytics Insightsfromingesting,processing,andanalyzingeventstreams. BusinessIntelligence SolutionsformodernizingyourBIstackandcreatingrichdataexperiences. DataScience PutyourdatatoworkwithDataScienceonGoogleCloud. MarketingAnalytics Solutionsforcollecting,analyzing,andactivatingcustomerdata. GeospatialAnalyticsandAI Solutionsforbuildingamoreprosperousandsustainablebusiness. Datasets DatafromGoogle,public,andcommercialproviderstoenrichyouranalyticsandAIinitiatives. StartupsandSMB AcceleratestartupandSMBgrowthwithtailoredsolutionsandprograms. StartupSolutions GrowyourstartupandsolveyourtoughestchallengesusingGoogle’sproventechnology. StartupProgram Getfinancial,business,andtechnicalsupporttotakeyourstartuptothenextlevel. SmallandMediumBusiness Exploresolutionsforwebhosting,appdevelopment,AI,andanalytics. SoftwareasaService BuildbetterSaaSproducts,scaleefficiently,andgrowyourbusiness. Products close FeaturedProducts ComputeEngine VirtualmachinesrunninginGoogle’sdatacenter. CloudStorage Objectstoragethat’ssecure,durable,andscalable. CloudSDK Command-linetoolsandlibrariesforGoogleCloud. CloudSQL RelationaldatabaseserviceforMySQL,PostgreSQLandSQLServer. GoogleKubernetesEngine Managedenvironmentforrunningcontainerizedapps. BigQuery Datawarehouseforbusinessagilityandinsights. CloudCDN Contentdeliverynetworkfordeliveringwebandvideo. Dataflow Streaminganalyticsforstreamandbatchprocessing. Operations Monitoring,logging,andapplicationperformancesuite. CloudRun Fullymanagedenvironmentforrunningcontainerizedapps. Anthos Platformformodernizingexistingappsandbuildingnewones. Notseeingwhatyou'relookingfor? Seeallproducts(100+) AIandMachineLearning VertexAI Unifiedplatformfortraining,running,andmanagingMLmodels. VertexAIWorkbench SingleinterfacefortheentireDataScienceworkflow. AIInfrastructure OptionsfortrainingdeeplearningandMLmodelscost-effectively. AutoML Custommachinelearningmodeldevelopment,withminimaleffort. NaturalLanguageAI Sentimentanalysisandclassificationofunstructuredtext. Speech-to-Text Speechrecognitionandtranscriptionacross125languages. Text-to-Speech Speechsynthesisin220+voicesand40+languages. TranslationAI Languagedetection,translation,andglossarysupport. VideoAI Videoclassificationandrecognitionusingmachinelearning. VisionAI Customandpre-trainedmodelstodetectemotion,text,andmore. Dialogflow LifelikeconversationalAIwithstate-of-the-artvirtualagents. Notseeingwhatyou'relookingfor? SeeallAIandmachinelearningproducts APIManagement ApigeeAPIManagement ManagethefulllifecycleofAPIsanywherewithvisibilityandcontrol. ApigeeIntegration API-firstintegrationtoconnectexistingdataandapplications. CloudHealthcareAPI SolutiontobridgeexistingcaresystemsandappsonGoogleCloud. AppSheet No-codedevelopmentplatformtobuildandextendapplications. APIGateway Develop,deploy,secure,andmanageAPIswithafullymanagedgateway. Compute ComputeEngine VirtualmachinesrunninginGoogle’sdatacenter. AppEngine Serverlessapplicationplatformforappsandbackends. CloudGPUs GPUsforML,scientificcomputing,and3Dvisualization. MigrateforComputeEngine ServerandvirtualmachinemigrationtoComputeEngine. SpotVMs Computeinstancesforbatchjobsandfault-tolerantworkloads. ShieldedVMs ReinforcedvirtualmachinesonGoogleCloud. Sole-TenantNodes Dedicatedhardwareforcompliance,licensing,andmanagement. BareMetal InfrastructuretorunspecializedworkloadsonGoogleCloud. Recommender UsagerecommendationsforGoogleCloudproductsandservices. VMwareEngine Fullymanaged,nativeVMwareCloudFoundationsoftwarestack. CloudRun Fullymanagedenvironmentforrunningcontainerizedapps. Notseeingwhatyou'relookingfor? Seeallcomputeproducts Containers GoogleKubernetesEngine Managedenvironmentforrunningcontainerizedapps. ContainerRegistry Registryforstoring,managing,andsecuringDockerimages. ContainerSecurity Containerenvironmentsecurityforeachstageofthelifecycle. CloudBuild SolutionforrunningbuildstepsinaDockercontainer. DeepLearningContainers Containerswithdatascienceframeworks,libraries,andtools. KubernetesApplications Containerizedappswithprebuiltdeploymentandunifiedbilling. ArtifactRegistry Packagemanagerforbuildartifactsanddependencies. Knative ComponentstocreateKubernetes-nativecloud-basedsoftware. CloudRun Fullymanagedenvironmentforrunningcontainerizedapps. CloudCode IDEsupporttowrite,run,anddebugKubernetesapplications. DataAnalytics BigQuery Datawarehouseforbusinessagilityandinsights. Looker PlatformforBI,dataapplications,andembeddedanalytics. Dataflow Streaminganalyticsforstreamandbatchprocessing. Pub/Sub Messagingserviceforeventingestionanddelivery. Dataproc ServiceforrunningApacheSparkandApacheHadoopclusters. CloudDataFusion Dataintegrationforbuildingandmanagingdatapipelines. CloudComposer WorkfloworchestrationservicebuiltonApacheAirflow. Dataprep Servicetopreparedataforanalysisandmachinelearning. Dataplex Intelligentdatafabricforunifyingdatamanagementacrosssilos. DataCatalog Metadataservicefordiscovering,understanding,andmanagingdata. AnalyticsHub Serviceforsecurelyandefficientlyexchangingdataanalyticsassets. Notseeingwhatyou'relookingfor? Seealldataanalyticsproducts Databases AlloyDBforPostgreSQL Fullymanaged,PostgreSQL-compatibledatabasefordemandingenterpriseworkloads. CloudBigtable Cloud-nativewide-columndatabaseforlargescale,low-latencyworkloads. Firestore Cloud-nativedocumentdatabaseforbuildingrichmobile,web,andIoTapps. Memorystore In-memorydatabaseformanagedRedisandMemcached. CloudSpanner Cloud-nativerelationaldatabasewithunlimitedscaleand99.999%availability. CloudSQL FullymanageddatabaseforMySQL,PostgreSQL,andSQLServer. DatabaseMigrationService Serverless,minimaldowntimemigrationstoCloudSQL. BareMetalSolutionforOracle InfrastructuretorunspecializedOracleworkloadsonGoogleCloud. FirebaseRealtimeDatabase NoSQLdatabaseforstoringandsyncingdatainrealtime. Datastream Serverlesschangedatacaptureandreplicationservice. DeveloperTools ArtifactRegistry Universalpackagemanagerforbuildartifactsanddependencies. CloudBuild Continuousintegrationandcontinuousdeliveryplatform. CloudCode IDEsupporttowrite,run,anddebugKubernetesapplications. CloudDeploymentManager ServiceforcreatingandmanagingGoogleCloudresources. gcloudCLI CommandlinetoolsandlibrariesforGoogleCloud. CloudScheduler Cronjobschedulerfortaskautomationandmanagement. CloudSourceRepositories PrivateGitrepositorytostore,manage,andtrackcode. CloudTasks Taskmanagementserviceforasynchronoustaskexecution. GoogleCloudDeploy FullymanagedcontinuousdeliverytoGoogleKubernetesEngine. Tekton Kubernetes-nativeresourcesfordeclaringCI/CDpipelines. ToolsforPowerShell FullcloudcontrolfromWindowsPowerShell. Notseeingwhatyou'relookingfor? Seealldevelopertools HealthcareandLifeSciences ApigeeHealthcareAPIx FHIRAPI-baseddigitalserviceproduction. CloudHealthcareAPI SolutionforbridgingexistingcaresystemsandappsonGoogleCloud. CloudLifeSciences Toolsformanaging,processing,andtransformingbiomedicaldata. HealthcareNaturalLanguageAI Real-timeinsightsfromunstructuredmedicaltext. HybridandMulticloud Anthos Platformformodernizingexistingappsandbuildingnewones. Looker PlatformforBI,dataapplications,andembeddedanalytics. CloudRunforAnthos IntegrationthatprovidesaserverlessdevelopmentplatformonGKE. GoogleCloudMarketplaceforAnthos Containerizedappswithprebuiltdeploymentandunifiedbilling. MigrateforAnthos TooltomoveworkloadsandexistingapplicationstoGKE. Operations Monitoring,logging,andapplicationperformancesuite. CloudBuild ServiceforexecutingbuildsonGoogleCloudinfrastructure. TrafficDirector Trafficcontrolpaneandmanagementforopenservicemesh. ApigeeAPIManagement APImanagement,development,andsecurityplatform. GoogleDistributedCloud Fullymanagedsolutionsfortheedgeanddatacenters. InternetofThings CloudIoTCore IoTdevicemanagement,integration,andconnectionservice. EdgeTPU ASICdesignedtorunMLinferenceandAIattheedge. ManagementTools AnthosConfigManagement Automatepolicyandsecurityforyourdeployments. CarbonFootprint DashboardtoviewandexportGoogleCloudcarbonemissionsreports. CloudAPIs ProgrammaticinterfacesforGoogleCloudservices. Cloudconsole Web-basedinterfaceformanagingandmonitoringcloudapps. CloudMobileApp ApptomanageGoogleCloudservicesfromyourmobiledevice. CloudShell Interactiveshellenvironmentwithabuilt-incommandline. ConfigConnector Kubernetesadd-onformanagingGoogleCloudresources. CostManagement Toolsformonitoring,controlling,andoptimizingyourcosts. IntelligentManagement Toolsforeasilymanagingperformance,security,andcost. PrivateCatalog Servicecatalogforadminsmanaginginternalenterprisesolutions. TerraformonGoogleCloud OpensourcetooltoprovisionGoogleCloudresourceswithdeclarativeconfigurationfiles. MediaandGaming GameServers GameservermanagementservicerunningonGoogleKubernetesEngine. OpenCue Opensourcerendermanagerforvisualeffectsandanimation. TranscoderAPI Convertvideofilesandpackagethemforoptimizeddelivery. Migration ApplicationMigration Appmigrationtothecloudforlow-costrefreshcycles. BigQueryDataTransferService DataimportserviceforschedulingandmovingdataintoBigQuery. CloudFoundationToolkit ReferencetemplatesforDeploymentManagerandTerraform. DatabaseMigrationService Serverless,minimaldowntimemigrationstoCloudSQL. MigrateforAnthos ComponentsformigratingVMsintosystemcontainersonGKE. MigrateforComputeEngine ComponentsformigratingVMsandphysicalserverstoComputeEngine. RapidAssessment&MigrationProgram(RAMP) End-to-endmigrationprogramtosimplifyyourpathtothecloud. TransferAppliance StorageserverformovinglargevolumesofdatatoGoogleCloud. StorageTransferService Datatransfersfromonlineandon-premisessourcestoCloudStorage. VMwareEngine MigrateandrunyourVMwareworkloadsnativelyonGoogleCloud. Networking CloudArmor SecuritypoliciesanddefenseagainstwebandDDoSattacks. CloudCDN Contentdeliverynetworkforservingwebandvideocontent. CloudDNS Domainnamesystemforreliableandlow-latencynamelookups. CloudLoadBalancing Servicefordistributingtrafficacrossapplicationsandregions. CloudNAT NATserviceforgivingprivateinstancesinternetaccess. HybridConnectivity ConnectivityoptionsforVPN,peering,andenterpriseneeds. NetworkConnectivityCenter Connectivitymanagementtohelpsimplifyandscalenetworks. NetworkIntelligenceCenter Networkmonitoring,verification,andoptimizationplatform. NetworkServiceTiers Cloudnetworkoptionsbasedonperformance,availability,andcost. TrafficDirector Trafficcontrolpaneandmanagementforopenservicemesh. Notseeingwhatyou'relookingfor? Seeallnetworkingproducts Operations CloudLogging GoogleCloudaudit,platform,andapplicationlogsmanagement. CloudMonitoring Infrastructureandapplicationhealthwithrichmetrics. ErrorReporting Applicationerroridentificationandanalysis. KubernetesEngineMonitoring GKEappdevelopmentandtroubleshooting. CloudTrace Tracingsystemcollectinglatencydatafromapplications. CloudProfiler CPUandheapprofilerforanalyzingapplicationperformance. CloudDebugger Real-timeapplicationstateinspectionandin-productiondebugging. IntelligentOperations Toolsforeasilyoptimizingperformance,security,andcost. SecurityandIdentity CloudIAM PermissionsmanagementsystemforGoogleCloudresources. AssuredWorkloads Complianceandsecuritycontrolsforsensitiveworkloads. CloudKeyManagement ManageencryptionkeysonGoogleCloud. ConfidentialComputing EncryptdatainusewithConfidentialVMs. SecurityCommandCenter PlatformfordefendingagainstthreatstoyourGoogleCloudassets. CloudDataLossPrevention Sensitivedatainspection,classification,andredactionplatform. ManagedServiceforMicrosoftActiveDirectory HardenedservicerunningMicrosoft®ActiveDirectory(AD). AccessTransparency Cloudprovidervisibilitythroughnearreal-timelogs. TitanSecurityKey Two-factorauthenticationdeviceforuseraccountprotection. SecretManager StoreAPIkeys,passwords,certificates,andothersensitivedata. BeyondCorpEnterprise Zerotrustsolutionforsecureapplicationandresourceaccess. Notseeingwhatyou'relookingfor? Seeallsecurityandidentityproducts ServerlessComputing CloudRun Fullymanagedenvironmentforrunningcontainerizedapps. CloudFunctions Platformforcreatingfunctionsthatrespondtocloudevents. AppEngine Serverlessapplicationplatformforappsandbackends. Workflows WorkfloworchestrationforserverlessproductsandAPIservices. Storage AllStorageProducts Cloud-basedstorageservicesforyourbusiness. CloudStorage Objectstoragethat’ssecure,durable,andscalable. Filestore Filestoragethatishighlyscalableandsecure. PersistentDisk BlockstorageforvirtualmachineinstancesrunningonGoogleCloud. CloudStorageforFirebase Objectstorageforstoringandservinguser-generatedcontent. LocalSSD Blockstoragethatislocallyattachedforhigh-performanceneeds. StorageTransferService Datatransfersfromonlineandon-premisessourcestoCloudStorage. GoogleWorkspaceEssentials Securevideomeetingsandmoderncollaborationforteams. Pricing close Savemoneywithourtransparentapproachtopricing GoogleCloud'spay-as-you-gopricingoffersautomaticsavingsbasedonmonthlyusageanddiscountedratesforprepaidresources.Contactustodaytogetaquote. Requestaquote PricingOverview GoogleCloudpricing Payonlyforwhatyouusewithnolock-in. Pricingcalculator Calculateyourcloudsavings. GoogleCloudFreeProgram $300infreecreditsand20+freeproducts. Product-specificPricing ComputeEngine CloudSQL GoogleKubernetesEngine CloudStorage BigQuery Seefullpricelistwith100+products Resources close Self-serviceResources GoogleCloudFreeProgram $300infreecreditsand20+freeproducts. Onboardingessentials Getquickstartsandreferencearchitectures. DeveloperCenter Stayintheknowandbecomeaninnovator. GoogleCloudcertification Prepareandregisterforcertifications. Events BrowseupcomingGoogleCloudevents. Blog Readourlatestproductnewsandstories. Customerstories Explorecasestudiesandvideos. Analystreports Readwhatindustryanalystssayaboutus. Experthelpandtraining Consulting Partnerwithourexpertsoncloudprojects. TechnicalAccountManagement GetongoingguidancefromGoogle. Training Enrollinon-demandorclassroomtraining. GoogleCloudCommunity Askquestions,findanswers,andconnect. Partnersandthird-partytools GoogleCloudpartners Explorebenefitsofworkingwithapartner. Becomeapartner JointhePartnerAdvantageprogram. GoogleCloudMarketplace Deployready-to-gosolutionsinafewclicks. Docs Support Docs Support English Deutsch Español–AméricaLatina Français Italiano Português–Brasil 中文–简体 日本語 한국어 Signin CloudAPIs ContactUs Getstartedforfree Overview More Solutions More Products More Pricing More Resources More Docs Support Console ContactUs Getstartedforfree CloudAPIs Productoverview GoogleCloudAPIs GoogleEnterpriseAPIs Clientlibrariesexplained UsingCloudAPIs Gettingstarted CappingAPIusage MonitoringAPIusage TroubleshootingAPIusage HTTPguidelines Systemparameters Usingclientlibraries CloudClientLibraries Clientlibrariesbestpractices APIdesignguide Introduction Resource-orientedDesign Resourcenames Standardmethods Custommethods Standardfields Errors Namingconventions Designpatterns InlineAPIdocumentation Usingproto3 Versioning Compatibility Directorystructure Filestructure Glossary Changelog Accelerateyourdigitaltransformation Learnmore Keybenefits WhyGoogleCloud Multicloud Trustandsecurity Globalinfrastructure DataCloud Opencloud Sustainability Productivityandcollaboration IndustrySolutions Retail ConsumerPackagedGoods FinancialServices HealthcareandLifeSciences MediaandEntertainment Telecommunications Gaming Manufacturing SupplyChainandLogistics Government Education Seeallindustrysolutions Seeallsolutions ApplicationModernization HybridandMulti-cloudApplicationPlatform APIManagement ServerlessSolutions DevOps ContinuousDelivery(CD) ContinuousIntegration(CI) MainframeModernization CAMP Hosting SiteReliabilityEngineering(SRE) ArtificialIntelligence ContactCenterAI DocumentAI Intelligentproducts ProductDiscovery APIsandApplications NewBusinessChannelsUsingAPIs UnlockingLegacyApplicationsUsingAPIs OpenBankingAPIx Databases DatabaseMigration DatabaseModernization GoogleCloudDatabases MigrateOracleworkloadstoGoogleCloud OpenSourceDatabases SQLServeronGoogleCloud DataCloud DatabasesSolutions SmartAnalyticsSolutions AISolutions DataCloudforISVs DataCloudAlliance DigitalTransformation DigitalInnovation OperationalEfficiency COVID-19Solutions COVID-19SolutionsfortheHealthcareIndustry InfrastructureModernization ApplicationMigration SAPonGoogleCloud HighPerformanceComputing WindowsonGoogleCloud DataCenterMigration ActiveAssist VirtualDesktops RapidAssessment&MigrationProgram(RAMP) BackupandDisasterRecovery ProductivityandCollaboration GoogleWorkspace GoogleWorkspaceEssentials CloudIdentity ChromeEnterprise CloudSearch Security SecurityAnalyticsandOperations WebAppandAPIProtection SecurityandResilienceFramework Riskandcomplianceascode(RCaC) SoftwareSupplyChainSecurity SmartAnalytics DataWarehouseModernization DataLakeModernization SparkonGoogleCloud StreamAnalytics BusinessIntelligence DataScience MarketingAnalytics GeospatialAnalyticsandAI Datasets StartupsandSMB StartupSolutions StartupProgram SmallandMediumBusiness SoftwareasaService FeaturedProducts ComputeEngine CloudStorage CloudSDK CloudSQL GoogleKubernetesEngine BigQuery CloudCDN Dataflow Operations CloudRun Anthos Seeallproducts(100+) AIandMachineLearning VertexAI VertexAIWorkbench AIInfrastructure AutoML NaturalLanguageAI Speech-to-Text Text-to-Speech TranslationAI VideoAI VisionAI Dialogflow SeeallAIandmachinelearningproducts APIManagement ApigeeAPIManagement ApigeeIntegration CloudHealthcareAPI AppSheet APIGateway Compute ComputeEngine AppEngine CloudGPUs MigrateforComputeEngine SpotVMs ShieldedVMs Sole-TenantNodes BareMetal Recommender VMwareEngine CloudRun Seeallcomputeproducts Containers GoogleKubernetesEngine ContainerRegistry ContainerSecurity CloudBuild DeepLearningContainers KubernetesApplications ArtifactRegistry Knative CloudRun CloudCode DataAnalytics BigQuery Looker Dataflow Pub/Sub Dataproc CloudDataFusion CloudComposer Dataprep Dataplex DataCatalog AnalyticsHub Seealldataanalyticsproducts Databases AlloyDBforPostgreSQL CloudBigtable Firestore Memorystore CloudSpanner CloudSQL DatabaseMigrationService BareMetalSolutionforOracle FirebaseRealtimeDatabase Datastream DeveloperTools ArtifactRegistry CloudBuild CloudCode CloudDeploymentManager gcloudCLI CloudScheduler CloudSourceRepositories CloudTasks GoogleCloudDeploy Tekton ToolsforPowerShell Seealldevelopertools HealthcareandLifeSciences ApigeeHealthcareAPIx CloudHealthcareAPI CloudLifeSciences HealthcareNaturalLanguageAI HybridandMulticloud Anthos Looker CloudRunforAnthos GoogleCloudMarketplaceforAnthos MigrateforAnthos Operations CloudBuild TrafficDirector ApigeeAPIManagement GoogleDistributedCloud InternetofThings CloudIoTCore EdgeTPU ManagementTools AnthosConfigManagement CarbonFootprint CloudAPIs Cloudconsole CloudMobileApp CloudShell ConfigConnector CostManagement IntelligentManagement PrivateCatalog TerraformonGoogleCloud MediaandGaming GameServers OpenCue TranscoderAPI Migration ApplicationMigration BigQueryDataTransferService CloudFoundationToolkit DatabaseMigrationService MigrateforAnthos MigrateforComputeEngine RapidAssessment&MigrationProgram(RAMP) TransferAppliance StorageTransferService VMwareEngine Networking CloudArmor CloudCDN CloudDNS CloudLoadBalancing CloudNAT HybridConnectivity NetworkConnectivityCenter NetworkIntelligenceCenter NetworkServiceTiers TrafficDirector Seeallnetworkingproducts Operations CloudLogging CloudMonitoring ErrorReporting KubernetesEngineMonitoring CloudTrace CloudProfiler CloudDebugger IntelligentOperations SecurityandIdentity CloudIAM AssuredWorkloads CloudKeyManagement ConfidentialComputing SecurityCommandCenter CloudDataLossPrevention ManagedServiceforMicrosoftActiveDirectory AccessTransparency TitanSecurityKey SecretManager BeyondCorpEnterprise Seeallsecurityandidentityproducts ServerlessComputing CloudRun CloudFunctions AppEngine Workflows Storage AllStorageProducts CloudStorage Filestore PersistentDisk CloudStorageforFirebase LocalSSD StorageTransferService GoogleWorkspaceEssentials Savemoneywithourtransparentapproachtopricing Requestaquote PricingOverview GoogleCloudpricing Pricingcalculator GoogleCloudFreeProgram Product-specificPricing ComputeEngine CloudSQL GoogleKubernetesEngine CloudStorage BigQuery Seefullpricelistwith100+products Self-serviceResources GoogleCloudFreeProgram Onboardingessentials DeveloperCenter GoogleCloudcertification Events Blog Customerstories Analystreports Experthelpandtraining Consulting TechnicalAccountManagement Training GoogleCloudCommunity Partnersandthird-partytools GoogleCloudpartners Becomeapartner GoogleCloudMarketplace Home Docs CloudAPIs Sendfeedback Systemparameters Google'sAPIplatformprovidesasetofcommonfunctionalitytoallGoogleAPIs builtusingtheplatform.Inordertouseandcontrolsuchfunctionality, theplatformpre-definesaspecialsetofrequestparameterscalled systemparameters.TheseparametersareavailableacrossallGoogleRESTAPIs andgRPCAPIs.AsystemparametercanbespecifiedeitherusinganHTTPquery parameteroranHTTPheader.ForGooglegRPCAPIs,onlyHTTPheadersare supported. Mostuserswillnotneedtousetheseparametersdirectly.However,theyare oftenusedbyGoogle-provided clientlibraries.Ifyouneedtowrite customcodetoaccessGoogleAPIsdirectly,thesystemparameterscanbe usefulincasessuchascontrollingJSONpretty-printingorspecifyingAPIKeys. HTTPMapping ForHTTPrequests,systemparametersaresentasURLqueryparametersor HTTPrequestheaders.Forexample,ifyouhaveasystemparameter$foo,it's sentas?$foo=xxxintheURL,or?%24foo=xxxifURL-encoded.Seethe tablebelowfordetails. Note:The$nameprefixisaddedtoavoidconflictingwithnormalrequest parameters. gRPCMapping ForgRPCrequests,systemparametersaresentasHTTP requestheaderswithkeysinlowercase.Seethetablebelowfordetails. Definitions Thefollowingtablelistsallsystemparametersandtheirdefinitions. URLQueryParameter HTTP/gRPCHeader Description Authorization Authenticationcredentials.SeeAuthenticationoverviewfordetails. $alt,alt Alternativeresponseformat.Supportedvaluesarejson(default),media,proto. $.xgafv JSONerrorformat.Supportedvaluesare1,2(default).Theerrorformat1shouldonlybeusedbyGoogleAPIClientLibraries. $callback,callback JSONPcallbackparameter. $ct Content-Type HTTPContent-Typerequestheaderoverride. $fields,fields X-Goog-FieldMask FieldMaskusedforresponsefiltering.Ifempty,allfieldsshouldbereturnedunlessdocumentedotherwise. X-HTTP-Method-Override TheintendedHTTPmethodfortherequest.Somenetworkproxiesdon'tacceptallHTTPmethods. $key,key X-Goog-Api-Key GoogleAPIkey.Seehttps://cloud.google.com/docs/authentication/api-keysfordetails. passwd,password ReservedtopreventputtingpasswordsinURLs. $prettyPrint,prettyPrint Pretty-printJSONresponse.Supportedvaluesaretrue(default),false. quotaUser X-Goog-Quota-User Apseudouseridentifierforchargingper-userquotas.Ifnotspecified,theauthenticatedprincipalisused.Ifthereisnoauthenticatedprincipal,theclientIPaddresswillbeused.Whenspecified,avalidAPIkeywithservicerestrictionsmustbeusedtoidentifythequotaproject.Otherwise,thisparameterisignored. $outputDefaults ForcetooutputprotodefaultvaluesforJSONresponses. $unique Uniquequeryparametertodisablerequestcaching. X-Goog-Api-Client APIclientidentification.Thevalueisaspace-separatedlistofNAME"/"SEMVERstrings,wheretheNAMEshouldonlycontainlowercaseletters,digits,and"-",andtheSEMVERshouldbeasemanticversionstring.Forexample:X-Goog-Api-Client:python/3.5.0grpc-google-pubsub-v1/0.1.0-beta2linux/2.7.0. X-Goog-Request-Reason Containsareasonformakingtherequest,whichisintendedtoberecordedinauditlogging.Anexamplereasonwouldbeasupport-caseticketnumber. $userProject X-Goog-User-Project Acaller-specifiedprojectforquotaandbillingpurposes.Thecallermusthaveserviceusage.services.usepermissionontheproject. X-Server-Timeout Timeout(inseconds,floatvalue)fortheservertofinishprocessingtherequest.ThissystemparamonlyappliestoRESTAPIsforwhichclient-sidetimeoutisnotapplicable. x-goog-request-params PassingadditionalparametersforgRPCrequestsinURLqueryformat.Forexample:x-goog-request-params:service=pubsub.googleapis.com&release=2021-11-01r0. Changelog 2021-11Publisheddocumentationforx-goog-request-params. 2021-02PublisheddocumentationforquotaUser. 2020-07DeprecatedOAuth2.0queryparameters. 2019-10IntroducedX-Server-Timeoutsystemparameter. 2017-10IntroducedX-Goog-User-Projectsystemparameter. Sendfeedback Exceptasotherwisenoted,thecontentofthispageislicensedundertheCreativeCommonsAttribution4.0License,andcodesamplesarelicensedundertheApache2.0License.Fordetails,seetheGoogleDevelopersSitePolicies.JavaisaregisteredtrademarkofOracleand/oritsaffiliates. Lastupdated2022-08-25UTC. [{ "type":"thumb-down", "id":"hardToUnderstand", "label":"Hardtounderstand" },{ "type":"thumb-down", "id":"incorrectInformationOrSampleCode", "label":"Incorrectinformationorsamplecode" },{ "type":"thumb-down", "id":"missingTheInformationSamplesINeed", "label":"Missingtheinformation/samplesIneed" },{ "type":"thumb-down", "id":"otherDown", "label":"Other" }] [{ "type":"thumb-up", "id":"easyToUnderstand", "label":"Easytounderstand" },{ "type":"thumb-up", "id":"solvedMyProblem", "label":"Solvedmyproblem" },{ "type":"thumb-up", "id":"otherUp", "label":"Other" }] Needtotellusmore? WhyGoogle ChoosingGoogleCloud Trustandsecurity Opencloud Multicloud Globalinfrastructure Customersandcasestudies Analystreports Whitepapers Blog Productsandpricing GoogleCloudpricing GoogleWorkspacepricing Seeallproducts Solutions Infrastructuremodernization Databases Applicationmodernization Smartanalytics ArtificialIntelligence Security Productivity&worktransformation Industrysolutions DevOpssolutions Smallbusinesssolutions Seeallsolutions Resources GoogleClouddocumentation GoogleCloudquickstarts GoogleCloudMarketplace Learnaboutcloudcomputing Support Codesamples CloudArchitectureCenter Training Certifications GoogleDevelopers GoogleCloudforStartups Systemstatus ReleaseNotes Engage Contactsales FindaPartner BecomeaPartner Events Podcasts DeveloperCenter PressCorner GoogleCloudonYouTube GoogleCloudTechonYouTube FollowonTwitter JoinUserResearch We'rehiring.JoinGoogleCloud! GoogleCloudCommunity CookieSettings AboutGoogle Privacy Siteterms GoogleCloudterms Carbonneutralsince2007 SignupfortheGoogleCloudnewsletter Subscribe English Deutsch Español–AméricaLatina Français Italiano Português–Brasil 中文–简体 日本語 한국어