REST Resource: apps.domainMappings

Resource: DomainMapping

A domain serving an App Engine application.

JSON representation
{"name":string,"id":string,"sslSettings":{object (SslSettings)},"resourceRecords":[{object (ResourceRecord)}]}
Fields
name

string

Full path to theDomainMapping resource in the API. Example:apps/myapp/domainMapping/example.com.

Note: This field is used in responses only. Any value specified here in a request is ignored.

id

string

Relative name of the domain serving the application. Example:example.com.

sslSettings

object (SslSettings)

SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.

resourceRecords[]

object (ResourceRecord)

The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.

Note: This field is used in responses only. Any value specified here in a request is ignored.

SslSettings

SSL configuration for aDomainMapping resource.

JSON representation
{"certificateId":string,"sslManagementType":enum (SslManagementType),"pendingManagedCertificateId":string}
Fields
certificateId

string

ID of theAuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.

By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specifySslManagementType.MANUAL on aCREATE orUPDATE request. You must be authorized to administer theAuthorizedCertificate resource to manually map it to aDomainMapping resource. Example:12345.

sslManagementType

enum (SslManagementType)

SSL management type for this domain. IfAUTOMATIC, a managed certificate is automatically provisioned. IfMANUAL,certificateId must be manually specified in order to configure SSL for this domain.

pendingManagedCertificateId

string

ID of the managedAuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, thecertificateId field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear thecertificateId field with anUpdateDomainMappingRequest.

Note: This field is used in responses only. Any value specified here in a request is ignored.

SslManagementType

The SSL management type for this domain.

Enums
SSL_MANAGEMENT_TYPE_UNSPECIFIEDDefaults toAUTOMATIC.
AUTOMATICSSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.
MANUALSSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain.

ResourceRecord

A DNS resource record.

JSON representation
{"name":string,"rrdata":string,"type":enum (RecordType)}
Fields
name

string

Relative name of the object affected by this record. Only applicable forCNAME records. Example: 'www'.

rrdata

string

Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).

type

enum (RecordType)

Resource record type. Example:AAAA.

RecordType

A resource record type.

Enums
RECORD_TYPE_UNSPECIFIEDAn unknown resource record.
AAn A resource record. Data is an IPv4 address.
AAAAAn AAAA resource record. Data is an IPv6 address.
CNAMEA CNAME resource record. Data is a domain name to be aliased.

Methods

create

 Maps a domain to an application.

delete

 Deletes the specified domain mapping.

get

 Gets the specified domain mapping.

list

 Lists the domain mappings on an application.

patch

 Updates the specified domain mapping.

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-06-16 UTC.