Creates a domain mapping on the specified site.


You will need authorization for at least one of the following scopes to make a valid call:


If unset, the scope for this method defaults to You can set the scope for this method like this: firebasehosting1-beta1 --scope <scope> projects sites-domains-create ...

Required Scalar Argument

  • <parent> (string)
    • Required. The parent to create the domain association for, in the format: sites/site-name

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

  domain-name: string
    domain-name: string
    type: string
    cert-challenge-discovered-txt: [string]
      domain-name: string
      token: string
      path: string
      token: string
    cert-status: string
    discovered-ips: [string]
    dns-fetch-time: string
    dns-status: string
    expected-ips: [string]
  site: string
  status: string
  update-time: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . domain-name=ea
    • Required. The domain name of the association.
  • domain-redirect domain-name=stet
    • Required. The domain name to redirect to.
  • type=dolores

    • Required. The redirect status code.
  • ..provisioning cert-challenge-discovered-txt=eos

    • The TXT records (for the certificate challenge) that were found at the last DNS fetch.
    • Each invocation of this argument appends the given value to the array.
  • cert-challenge-dns domain-name=et
    • The domain name upon which the DNS challenge must be satisfied.
  • token=sea

    • The value that must be present as a TXT record on the domain name to satisfy the challenge.
  • ..cert-challenge-http path=et

    • The URL path on which to serve the specified token to satisfy the certificate challenge.
  • token=at

    • The token to serve at the specified URL path to satisfy the certificate challenge.
  • .. cert-status=dolore

    • The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.
  • discovered-ips=eirmod
    • The IPs found at the last DNS fetch.
    • Each invocation of this argument appends the given value to the array.
  • dns-fetch-time=lorem
    • The time at which the last DNS fetch occurred.
  • dns-status=accusam
    • The DNS record match status as of the last DNS fetch.
  • expected-ips=amet

    • The list of IPs to which the domain is expected to resolve.
    • Each invocation of this argument appends the given value to the array.
  • .. site=erat

    • Required. The site name of the association.
  • status=dolores
    • Output only. Additional status of the domain association.
  • update-time=erat
    • Output only. The time at which the domain was last updated.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.
  • -p access-token=string

    • OAuth access token.
  • -p alt=string

    • Data format for response.
  • -p callback=string

    • JSONP
  • -p fields=string

    • Selector specifying which fields to include in a partial response.
  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • -p oauth-token=string

    • OAuth 2.0 token for the current user.
  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.
  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").
  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").