---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# gcp_networkservices_http_route{% #gcp_networkservices_http_route %}

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `create_time`{% #create_time %}

**Type**: `TIMESTAMP`**Provider name**: `createTime`**Description**: Output only. The timestamp when the resource was created.

## `description`{% #description %}

**Type**: `STRING`**Provider name**: `description`**Description**: Optional. A free-text description of the resource. Max length 1024 characters.

## `gateways`{% #gateways %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `gateways`**Description**: Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/`

## `hostnames`{% #hostnames %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `hostnames`**Description**: Required. Hostnames define a set of hosts that should match against the HTTP host header to select a HttpRoute to process the request. Hostname is the fully qualified domain name of a network host, as defined by RFC 1123 with the exception that: - IPs are not allowed. - A hostname may be prefixed with a wildcard label (`*.`). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. `foo.example.com`) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. `*.example.com`). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateways must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames `*.foo.bar.com` and `*.bar.com` to be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with `*.bar.com` or both with `bar.com`.

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `meshes`{% #meshes %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `meshes`**Description**: Optional. Meshes defines a list of meshes this HttpRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: `projects/*/locations/global/meshes/` The attached Mesh should be of a type SIDECAR

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: Identifier. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`.

## `organization_id`{% #organization_id %}

**Type**: `STRING`

## `parent`{% #parent %}

**Type**: `STRING`

## `project_id`{% #project_id %}

**Type**: `STRING`

## `project_number`{% #project_number %}

**Type**: `STRING`

## `region_id`{% #region_id %}

**Type**: `STRING`

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `rules`{% #rules %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `rules`**Description**: Required. Rules that define how traffic is routed and handled. Rules will be matched sequentially based on the RouteMatch specified for the rule.

- `action`**Type**: `STRUCT`**Provider name**: `action`**Description**: The detailed rule defining how to route matched traffic.
  - `cors_policy`**Type**: `STRUCT`**Provider name**: `corsPolicy`**Description**: The specification for allowing client side cross-origin requests.
    - `allow_credentials`**Type**: `BOOLEAN`**Provider name**: `allowCredentials`**Description**: In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header. Default value is false.
    - `allow_headers`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `allowHeaders`**Description**: Specifies the content for Access-Control-Allow-Headers header.
    - `allow_methods`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `allowMethods`**Description**: Specifies the content for Access-Control-Allow-Methods header.
    - `allow_origin_regexes`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `allowOriginRegexes`**Description**: Specifies the regular expression patterns that match allowed origins. For regular expression grammar, please see [https://github.com/google/re2/wiki/Syntax](https://github.com/google/re2/wiki/Syntax).
    - `allow_origins`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `allowOrigins`**Description**: Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allow_origins or an item in allow_origin_regexes.
    - `disabled`**Type**: `BOOLEAN`**Provider name**: `disabled`**Description**: If true, the CORS policy is disabled. The default value is false, which indicates that the CORS policy is in effect.
    - `expose_headers`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `exposeHeaders`**Description**: Specifies the content for Access-Control-Expose-Headers header.
    - `max_age`**Type**: `STRING`**Provider name**: `maxAge`**Description**: Specifies how long result of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.
  - `destinations`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `destinations`**Description**: The destination to which traffic should be forwarded.
    - `request_header_modifier`**Type**: `STRUCT`**Provider name**: `requestHeaderModifier`**Description**: Optional. The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
      - `remove`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `remove`**Description**: Remove headers (matching by header names) specified in the list.
    - `response_header_modifier`**Type**: `STRUCT`**Provider name**: `responseHeaderModifier`**Description**: Optional. The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
      - `remove`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `remove`**Description**: Remove headers (matching by header names) specified in the list.
    - `service_name`**Type**: `STRING`**Provider name**: `serviceName`**Description**: The URL of a BackendService to route traffic to.
    - `weight`**Type**: `INT32`**Provider name**: `weight`**Description**: Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. This is computed as: - weight/Sum(weights in this destination list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. If only one serviceName is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weights are specified for any one service name, they need to be specified for all of them. If weights are unspecified for all services, then, traffic is distributed in equal proportions to all of them.
  - `direct_response`**Type**: `STRUCT`**Provider name**: `directResponse`**Description**: Optional. Static HTTP Response object to be returned regardless of the request.
    - `gcp_status`**Type**: `INT32`**Provider name**: `status`**Description**: Required. Status to return as part of HTTP Response. Must be a positive integer.
    - `string_body`**Type**: `STRING`**Provider name**: `stringBody`**Description**: Optional. Response body as a string. Maximum body length is 1024 characters.
  - `fault_injection_policy`**Type**: `STRUCT`**Provider name**: `faultInjectionPolicy`**Description**: The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy
    - `abort`**Type**: `STRUCT`**Provider name**: `abort`**Description**: The specification for aborting to client requests.
      - `http_status`**Type**: `INT32`**Provider name**: `httpStatus`**Description**: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
      - `percentage`**Type**: `INT32`**Provider name**: `percentage`**Description**: The percentage of traffic which will be aborted. The value must be between [0, 100]
    - `delay`**Type**: `STRUCT`**Provider name**: `delay`**Description**: The specification for injecting delay to client requests.
      - `fixed_delay`**Type**: `STRING`**Provider name**: `fixedDelay`**Description**: Specify a fixed delay before forwarding the request.
      - `percentage`**Type**: `INT32`**Provider name**: `percentage`**Description**: The percentage of traffic on which delay will be injected. The value must be between [0, 100]
  - `idle_timeout`**Type**: `STRING`**Provider name**: `idleTimeout`**Description**: Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled.
  - `redirect`**Type**: `STRUCT`**Provider name**: `redirect`**Description**: If set, the request is directed as configured by this field.
    - `host_redirect`**Type**: `STRING`**Provider name**: `hostRedirect`**Description**: The host that will be used in the redirect response instead of the one that was supplied in the request.
    - `https_redirect`**Type**: `BOOLEAN`**Provider name**: `httpsRedirect`**Description**: If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. The default is set to false.
    - `path_redirect`**Type**: `STRING`**Provider name**: `pathRedirect`**Description**: The path that will be used in the redirect response instead of the one that was supplied in the request. path_redirect can not be supplied together with prefix_redirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.
    - `port_redirect`**Type**: `INT32`**Provider name**: `portRedirect`**Description**: The port that will be used in the redirected request instead of the one that was supplied in the request.
    - `prefix_rewrite`**Type**: `STRING`**Provider name**: `prefixRewrite`**Description**: Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows URLs be dynamically created based on the request.
    - `response_code`**Type**: `STRING`**Provider name**: `responseCode`**Description**: The HTTP Status code to use for the redirect.**Possible values**:
      - `RESPONSE_CODE_UNSPECIFIED` - Default value
      - `MOVED_PERMANENTLY_DEFAULT` - Corresponds to 301.
      - `FOUND` - Corresponds to 302.
      - `SEE_OTHER` - Corresponds to 303.
      - `TEMPORARY_REDIRECT` - Corresponds to 307. In this case, the request method will be retained.
      - `PERMANENT_REDIRECT` - Corresponds to 308. In this case, the request method will be retained.
    - `strip_query`**Type**: `BOOLEAN`**Provider name**: `stripQuery`**Description**: if set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false.
  - `request_header_modifier`**Type**: `STRUCT`**Provider name**: `requestHeaderModifier`**Description**: The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
    - `remove`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `remove`**Description**: Remove headers (matching by header names) specified in the list.
  - `request_mirror_policy`**Type**: `STRUCT`**Provider name**: `requestMirrorPolicy`**Description**: Specifies the policy on how requests intended for the routes destination are shadowed to a separate mirrored destination. Proxy will not wait for the shadow destination to respond before returning the response. Prior to sending traffic to the shadow service, the host/authority header is suffixed with -shadow.
    - `destination`**Type**: `STRUCT`**Provider name**: `destination`**Description**: The destination the requests will be mirrored to. The weight of the destination will be ignored.
      - `request_header_modifier`**Type**: `STRUCT`**Provider name**: `requestHeaderModifier`**Description**: Optional. The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
        - `remove`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `remove`**Description**: Remove headers (matching by header names) specified in the list.
      - `response_header_modifier`**Type**: `STRUCT`**Provider name**: `responseHeaderModifier`**Description**: Optional. The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
        - `remove`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `remove`**Description**: Remove headers (matching by header names) specified in the list.
      - `service_name`**Type**: `STRING`**Provider name**: `serviceName`**Description**: The URL of a BackendService to route traffic to.
      - `weight`**Type**: `INT32`**Provider name**: `weight`**Description**: Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. This is computed as: - weight/Sum(weights in this destination list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. If only one serviceName is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weights are specified for any one service name, they need to be specified for all of them. If weights are unspecified for all services, then, traffic is distributed in equal proportions to all of them.
    - `mirror_percent`**Type**: `FLOAT`**Provider name**: `mirrorPercent`**Description**: Optional. The percentage of requests to get mirrored to the desired destination.
  - `response_header_modifier`**Type**: `STRUCT`**Provider name**: `responseHeaderModifier`**Description**: The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
    - `remove`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `remove`**Description**: Remove headers (matching by header names) specified in the list.
  - `retry_policy`**Type**: `STRUCT`**Provider name**: `retryPolicy`**Description**: Specifies the retry policy associated with this route.
    - `num_retries`**Type**: `INT32`**Provider name**: `numRetries`**Description**: Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1.
    - `per_try_timeout`**Type**: `STRING`**Provider name**: `perTryTimeout`**Description**: Specifies a non-zero timeout per retry attempt.
    - `retry_conditions`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `retryConditions`**Description**: Specifies one or more conditions when this retry policy applies. Valid values are: 5xx: Proxy will attempt a retry if the destination service responds with any 5xx response code, of if the destination service does not respond at all, example: disconnect, reset, read timeout, connection failure and refused streams. gateway-error: Similar to 5xx, but only applies to response codes 502, 503, 504. reset: Proxy will attempt a retry if the destination service does not respond at all (disconnect/reset/read timeout) connect-failure: Proxy will retry on failures connecting to destination for example due to connection timeouts. retriable-4xx: Proxy will retry fro retriable 4xx response codes. Currently the only retriable error supported is 409. refused-stream: Proxy will retry if the destination resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.
  - `stateful_session_affinity`**Type**: `STRUCT`**Provider name**: `statefulSessionAffinity`**Description**: Optional. Specifies cookie-based stateful session affinity.
    - `cookie_ttl`**Type**: `STRING`**Provider name**: `cookieTtl`**Description**: Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive. Set this to 0s to use a session cookie and disable cookie expiration.
  - `timeout`**Type**: `STRING`**Provider name**: `timeout`**Description**: Specifies the timeout for selected route. Timeout is computed from the time the request has been fully processed (i.e. end of stream) up until the response has been completely processed. Timeout includes all retries.
  - `url_rewrite`**Type**: `STRUCT`**Provider name**: `urlRewrite`**Description**: The specification for rewrite URL before forwarding requests to the destination.
    - `host_rewrite`**Type**: `STRING`**Provider name**: `hostRewrite`**Description**: Prior to forwarding the request to the selected destination, the requests host header is replaced by this value.
    - `path_prefix_rewrite`**Type**: `STRING`**Provider name**: `pathPrefixRewrite`**Description**: Prior to forwarding the request to the selected destination, the matching portion of the requests path is replaced by this value.
- `matches`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `matches`**Description**: A list of matches define conditions used for matching the rule against incoming HTTP requests. Each match is independent, i.e. this rule will be matched if ANY one of the matches is satisfied. If no matches field is specified, this rule will unconditionally match traffic. If a default rule is desired to be configured, add a rule with no matches specified to the end of the rules list.
  - `full_path_match`**Type**: `STRING`**Provider name**: `fullPathMatch`**Description**: The HTTP request path value should exactly match this value. Only one of full_path_match, prefix_match, or regex_match should be used.
  - `headers`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `headers`**Description**: Specifies a list of HTTP request headers to match against. ALL of the supplied headers must be matched.
    - `exact_match`**Type**: `STRING`**Provider name**: `exactMatch`**Description**: The value of the header should match exactly the content of exact_match.
    - `header`**Type**: `STRING`**Provider name**: `header`**Description**: The name of the HTTP header to match against.
    - `invert_match`**Type**: `BOOLEAN`**Provider name**: `invertMatch`**Description**: If specified, the match result will be inverted before checking. Default value is set to false.
    - `prefix_match`**Type**: `STRING`**Provider name**: `prefixMatch`**Description**: The value of the header must start with the contents of prefix_match.
    - `present_match`**Type**: `BOOLEAN`**Provider name**: `presentMatch`**Description**: A header with header_name must exist. The match takes place whether or not the header has a value.
    - `range_match`**Type**: `STRUCT`**Provider name**: `rangeMatch`**Description**: If specified, the rule will match if the request header value is within the range.
      - `end`**Type**: `INT32`**Provider name**: `end`**Description**: End of the range (exclusive)
      - `start`**Type**: `INT32`**Provider name**: `start`**Description**: Start of the range (inclusive)
    - `regex_match`**Type**: `STRING`**Provider name**: `regexMatch`**Description**: The value of the header must match the regular expression specified in regex_match. For regular expression grammar, please see: [https://github.com/google/re2/wiki/Syntax](https://github.com/google/re2/wiki/Syntax)
    - `suffix_match`**Type**: `STRING`**Provider name**: `suffixMatch`**Description**: The value of the header must end with the contents of suffix_match.
  - `ignore_case`**Type**: `BOOLEAN`**Provider name**: `ignoreCase`**Description**: Specifies if prefix_match and full_path_match matches are case sensitive. The default value is false.
  - `prefix_match`**Type**: `STRING`**Provider name**: `prefixMatch`**Description**: The HTTP request path value must begin with specified prefix_match. prefix_match must begin with a /. Only one of full_path_match, prefix_match, or regex_match should be used.
  - `query_parameters`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `queryParameters`**Description**: Specifies a list of query parameters to match against. ALL of the query parameters must be matched.
    - `exact_match`**Type**: `STRING`**Provider name**: `exactMatch`**Description**: The value of the query parameter must exactly match the contents of exact_match. Only one of exact_match, regex_match, or present_match must be set.
    - `present_match`**Type**: `BOOLEAN`**Provider name**: `presentMatch`**Description**: Specifies that the QueryParameterMatcher matches if request contains query parameter, irrespective of whether the parameter has a value or not. Only one of exact_match, regex_match, or present_match must be set.
    - `query_parameter`**Type**: `STRING`**Provider name**: `queryParameter`**Description**: The name of the query parameter to match.
    - `regex_match`**Type**: `STRING`**Provider name**: `regexMatch`**Description**: The value of the query parameter must match the regular expression specified by regex_match. For regular expression grammar, please see [https://github.com/google/re2/wiki/Syntax](https://github.com/google/re2/wiki/Syntax) Only one of exact_match, regex_match, or present_match must be set.
  - `regex_match`**Type**: `STRING`**Provider name**: `regexMatch`**Description**: The HTTP request path value must satisfy the regular expression specified by regex_match after removing any query parameters and anchor supplied with the original URL. For regular expression grammar, please see [https://github.com/google/re2/wiki/Syntax](https://github.com/google/re2/wiki/Syntax) Only one of full_path_match, prefix_match, or regex_match should be used.

## `self_link`{% #self_link %}

**Type**: `STRING`**Provider name**: `selfLink`**Description**: Output only. Server-defined URL of this resource

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `update_time`{% #update_time %}

**Type**: `TIMESTAMP`**Provider name**: `updateTime`**Description**: Output only. The timestamp when the resource was updated.

## `zone_id`{% #zone_id %}

**Type**: `STRING`