Endpoint
describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics.
Example:
type: google.api.Service
name: library-example.googleapis.com
endpoints:
# Declares network address `https://library-example.googleapis.com`
# for service `library-example.googleapis.com`. The `https` scheme
# is implicit for all service endpoints. Other schemes may be
# supported in the future.
- name: library-example.googleapis.com
allowCors: false
- name: content-staging-library-example.googleapis.com
# Allows HTTP OPTIONS calls to be passed to the API frontend, for it
# to decide whether the subsequent cross-origin request is allowed
# to proceed.
allowCors: true
JSON representation |
---|
{ "name": string, "aliases": [ string ], "target": string, "allowCors": boolean } |
Fields | |
---|---|
name |
The canonical name of this endpoint. |
aliases[] |
Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple Additional names that this endpoint will be hosted on. |
target |
The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". |
allowCors |
Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. |