Method: apps.domainMappings.create

Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.

HTTP request

POST https://appengine.googleapis.com/v1beta/{parent=apps/*}/domainMappings

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
parent

string

Name of the parent Application resource. Example: apps/myapp.

Authorization requires the following Google IAM permission on the specified resource parent:

  • appengine.applications.update

Query parameters

Parameters
overrideStrategy

enum(DomainOverrideStrategy)

Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.

Request body

The request body contains an instance of DomainMapping.

Response body

If successful, the response body contains a newly created instance of Operation.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DomainOverrideStrategy

Override strategy for mutating an existing mapping.

Enums
UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY Strategy unspecified. Defaults to STRICT.
STRICT Overrides not allowed. If a mapping already exists for the specified domain, the request will return an ALREADY_EXISTS (409).
OVERRIDE Overrides allowed. If a mapping already exists for the specified domain, the request will overwrite it. Note that this might stop another Google product from serving. For example, if the domain is mapped to another App Engine application, that app will no longer serve from that domain.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

App Engine Admin API