App Engine Admin API: Node.js Client

release levelnpm version

Appengine client for Node.js

A comprehensive list of changes in each version may be found inthe CHANGELOG.

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the App Engine Admin API API.
  4. Set up authentication with a service account so you can access theAPI from your local workstation.

Installing the client library

npm install @google-cloud/appengine-admin

Using the client library

// Imports the Google Cloud client libraryconst {ServicesClient} = require('@google-cloud/appengine-admin');// TODO(developer): replace with your prefered project ID.// const projectId = 'my-project'// Creates a clientconst client = newServicesClient();async function listVersions() {  const [versions] = await client.listServices({    parent: `apps/${projectId}`,  });  console.info(versions);}listVersions();

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

SampleSource CodeTry it
Applications.create_applicationsource codeOpen in Cloud Shell
Applications.get_applicationsource codeOpen in Cloud Shell
Applications.repair_applicationsource codeOpen in Cloud Shell
Applications.update_applicationsource codeOpen in Cloud Shell
Authorized_certificates.create_authorized_certificatesource codeOpen in Cloud Shell
Authorized_certificates.delete_authorized_certificatesource codeOpen in Cloud Shell
Authorized_certificates.get_authorized_certificatesource codeOpen in Cloud Shell
Authorized_certificates.list_authorized_certificatessource codeOpen in Cloud Shell
Authorized_certificates.update_authorized_certificatesource codeOpen in Cloud Shell
Authorized_domains.list_authorized_domainssource codeOpen in Cloud Shell
Domain_mappings.create_domain_mappingsource codeOpen in Cloud Shell
Domain_mappings.delete_domain_mappingsource codeOpen in Cloud Shell
Domain_mappings.get_domain_mappingsource codeOpen in Cloud Shell
Domain_mappings.list_domain_mappingssource codeOpen in Cloud Shell
Domain_mappings.update_domain_mappingsource codeOpen in Cloud Shell
Firewall.batch_update_ingress_rulessource codeOpen in Cloud Shell
Firewall.create_ingress_rulesource codeOpen in Cloud Shell
Firewall.delete_ingress_rulesource codeOpen in Cloud Shell
Firewall.get_ingress_rulesource codeOpen in Cloud Shell
Firewall.list_ingress_rulessource codeOpen in Cloud Shell
Firewall.update_ingress_rulesource codeOpen in Cloud Shell
Instances.debug_instancesource codeOpen in Cloud Shell
Instances.delete_instancesource codeOpen in Cloud Shell
Instances.get_instancesource codeOpen in Cloud Shell
Instances.list_instancessource codeOpen in Cloud Shell
Services.delete_servicesource codeOpen in Cloud Shell
Services.get_servicesource codeOpen in Cloud Shell
Services.list_servicessource codeOpen in Cloud Shell
Services.update_servicesource codeOpen in Cloud Shell
Versions.create_versionsource codeOpen in Cloud Shell
Versions.delete_versionsource codeOpen in Cloud Shell
Versions.get_versionsource codeOpen in Cloud Shell
Versions.list_versionssource codeOpen in Cloud Shell
Versions.update_versionsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

TheApp Engine Admin API Node.js Client API Reference documentationalso contains samples.

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on abest-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/appengine-admin@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to bestable. The code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againststable librariesare addressed with the highest priority.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

License

Apache Version 2.0

SeeLICENSE

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-10-30 UTC.