REST Resource: projects.locations.backends.domains

{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "type": enum (Type),
  "disabled": boolean,
  "serve": {
    object (ServingBehavior)
  },
  "customDomainStatus": {
    object (CustomDomainStatus)
  },
  "reconciling": boolean,
  "deleteTime": string,
  "purgeTime": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string
}

string

Identifier. The resource name of the domain, e.g. /projects/p/locations/l/backends/b/domains/foo.com

string

Optional. Mutable human-readable name for the domain. 63 character limit. e.g. prod domain.

string (Timestamp format)

Output only. Time at which the domain was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

string (Timestamp format)

Output only. Time at which the domain was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

enum (Type)

Output only. The type of the domain.

boolean

Optional. Whether the domain is disabled. Defaults to false.

object (ServingBehavior)

Optional. The serving behavior of the domain. If specified, the domain will serve content other than its backend's live content.

object (CustomDomainStatus)

Output only. Represents the state and configuration of a CUSTOM type domain. It is only present on Domains of that type.

boolean

Output only. A field that, if true, indicates that the build has an ongoing LRO.

string (Timestamp format)

Output only. Time at which the domain was deleted.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

string (Timestamp format)

Output only. Time at which a soft-deleted domain will be purged, rendering in permanently deleted.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

map (key: string, value: string)

Optional. Labels as key value pairs.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

map (key: string, value: string)

Optional. Annotations as key value pairs.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

string

Output only. System-assigned, unique identifier.

string

Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.

{

  // Union field serving_behavior can be only one of the following:
  "redirect": {
    object (Redirect)
  }
  // End of list of possible types for union field serving_behavior.
}

object (Redirect)

Optional. Redirect behavior for a domain, if provided.

{
  "uri": string,
  "status": string
}

string

Required. The URI of the redirect's intended destination. This URI will be prepended to the original request path. URI without a scheme are assumed to be HTTPS.

string (int64 format)

Optional. The status code to use in a redirect response. Must be a valid HTTP 3XX status code. Defaults to 302 if not present.

{
  "hostState": enum (HostState),
  "ownershipState": enum (OwnershipState),
  "certState": enum (CertState),
  "requiredDnsUpdates": [
    {
      object (DnsUpdates)
    }
  ],
  "issues": [
    {
      object (Status)
    }
  ]
}

enum (HostState)

Output only. Tracks whether a custom domain is detected as appropriately directing traffic to App Hosting.

enum (OwnershipState)

Output only. Tracks whether the backend is permitted to serve content on the domain, based off the domain's DNS records.

enum (CertState)

Output only. Tracks SSL certificate status for the domain.

object (DnsUpdates)

Output only. Lists the records that must added or removed to a custom domain's DNS in order to finish setup and start serving content. Field is present during onboarding. Also present after onboarding if one or more of the above states is not *_ACTIVE, indicating the domain's DNS records are in a bad state.

object (Status)

Output only. A list of issues with domain configuration. Allows users to self-correct problems with DNS records.

{
  "domainName": string,
  "discovered": [
    {
      object (DnsRecordSet)
    }
  ],
  "desired": [
    {
      object (DnsRecordSet)
    }
  ],
  "checkTime": string
}

string

Output only. The domain name the DNS updates pertain to.

object (DnsRecordSet)

Output only. The set of DNS records App Hosting discovered when inspecting a domain.

object (DnsRecordSet)

Output only. The set of DNS records App Hosting needs in order to be able to serve secure content on the domain.

string (Timestamp format)

Output only. The last time App Hosting checked your custom domain's DNS records.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

{
  "domainName": string,
  "checkError": {
    object (Status)
  },
  "records": [
    {
      object (DnsRecord)
    }
  ]
}

string

Output only. The domain name the record set pertains to.

object (Status)

Output only. An error App Hosting services encountered when querying your domain's DNS records. Note: App Hosting ignores NXDOMAIN errors, as those generally just mean that a domain name hasn't been set up yet.

object (DnsRecord)

Output only. Records on the domain.

{
  "domainName": string,
  "type": enum (Type),
  "rdata": string,
  "requiredAction": enum (Action),
  "relevantState": [
    enum (CustomDomainState)
  ]
}

string

Output only. The domain the record pertains to, e.g. foo.bar.com..

enum (Type)

Output only. The record's type, which determines what data the record contains.

string

Output only. The data of the record. The meaning of the value depends on record type: - A and AAAA: IP addresses for the domain. - CNAME: Another domain to check for records. - TXT: Arbitrary text strings associated with the domain. App Hosting uses TXT records to determine which Firebase projects have permission to act on the domain's behalf. - CAA: The record's flags, tag, and value, e.g. 0 issue "pki.goog".

enum (Action)

Output only. An enum that indicates the a required action for this record. Populated when the record is part of a required change in a DnsUpdates discovered or desired record set.

enum (CustomDomainState)

Output only. An enum that indicates which state(s) this DNS record applies to. Populated for all records with an ADD or REMOVE required action.