App Engine Admin API: Node.js Client

Appengine client for Node.js

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

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart
Samples
Versioning
Contributing
License

Quickstart

Before you begin

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

Installing the client library

npm install @google-cloud/appengine-admin

Using the client library

// Imports the Google Cloud client library

const {ServicesClient} = require('@google-cloud/appengine-admin');

// TODO(developer): replace with your prefered project ID.
// const projectId = 'my-project'

// Creates a client
const client = new ServicesClient();

async function listVersions() {
  const [versions] = await client.listServices({
    parent: `apps/${projectId}`,
  });
  console.info(versions);
}
listVersions();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Applications.create_application	source code
Applications.get_application	source code
Applications.repair_application	source code
Applications.update_application	source code
Authorized_certificates.create_authorized_certificate	source code
Authorized_certificates.delete_authorized_certificate	source code
Authorized_certificates.get_authorized_certificate	source code
Authorized_certificates.list_authorized_certificates	source code
Authorized_certificates.update_authorized_certificate	source code
Authorized_domains.list_authorized_domains	source code
Domain_mappings.create_domain_mapping	source code
Domain_mappings.delete_domain_mapping	source code
Domain_mappings.get_domain_mapping	source code
Domain_mappings.list_domain_mappings	source code
Domain_mappings.update_domain_mapping	source code
Firewall.batch_update_ingress_rules	source code
Firewall.create_ingress_rule	source code
Firewall.delete_ingress_rule	source code
Firewall.get_ingress_rule	source code
Firewall.list_ingress_rules	source code
Firewall.update_ingress_rule	source code
Instances.debug_instance	source code
Instances.delete_instance	source code
Instances.get_instance	source code
Instances.list_instances	source code
Services.delete_service	source code
Services.get_service	source code
Services.list_services	source code
Services.update_service	source code
Versions.create_version	source code
Versions.delete_version	source code
Versions.get_version	source code
Versions.list_versions	source code
Versions.update_version	source code
Quickstart	source code

The App Engine Admin API Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-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, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/appengine-admin@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE