> ## Documentation Index > Fetch the complete documentation index at: https://docs.controlplane.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a GVC by name > Response will contain the requested GVC if the caller is authorized to view it ## OpenAPI ````yaml get /org/{org}/gvc/{name} openapi: 3.0.3 info: title: Control Plane Core API description: Copyright © 2023 Control Plane Corporation. All rights reserved. version: 1.0.0 servers: - url: https://api.cpln.io description: '' security: - {} - serviceAccountKey: [] - jwt: [] externalDocs: url: https://docs.controlplane.com/ description: End-user documentation paths: /org/{org}/gvc/{name}: get: tags: - gvc summary: Get a GVC by name description: >- Response will contain the requested GVC if the caller is authorized to view it parameters: - in: path name: org required: true schema: type: string - in: path name: name required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/gvc' '403': description: Not found or not allowed to view content: application/json: schema: $ref: '#/components/schemas/error' components: schemas: gvc: type: object properties: id: type: string readOnly: true name: type: string maxLength: 64 kind: type: string readOnly: true version: type: integer readOnly: true description: type: string maxLength: 250 tags: type: object created: type: string format: date-time readOnly: true lastModified: type: string format: date-time readOnly: true links: type: array items: $ref: '#/components/schemas/link' readOnly: true alias: type: string readOnly: true spec: type: object properties: staticPlacement: type: object properties: locationLinks: type: array items: type: string locationQuery: type: object properties: kind: type: string context: type: object readOnly: true spec: type: object properties: match: type: string enum: - all - any - none default: all terms: type: array items: type: object properties: op: type: string enum: - '=' - '>' - '>=' - < - <= - '!=' - '~' - '=~' - exists - '!exists' - contains default: '=' property: type: string rel: type: string tag: type: string value: oneOf: - type: string - type: number - type: boolean - type: string format: date-time additionalProperties: false sort: type: object properties: by: type: string order: type: string enum: - asc - desc default: asc additionalProperties: false additionalProperties: false additionalProperties: false locationOptions: type: array items: type: object properties: locationLink: type: string routingTier: type: integer description: >- Routing tier for DNS geo routing. Lower value = higher priority. Locations with the same routingTier form a group; within a group, lowest latency wins. If all locations in the highest-priority group are unavailable, the next group is used. latencyOffsetMs: type: integer description: >- Artificial latency offset in milliseconds added to measured latency. Positive values push traffic away from this location, negative values attract traffic. Default: 0. latencyToleranceMs: type: integer description: >- Maximum acceptable latency in milliseconds. If measured latency exceeds this latencyToleranceMs, the location is treated as unavailable for DNS geo routing. additionalProperties: false description: >- Per-location routing options for DNS geo routing. Allows configuring priority-based failover and latency adjustments per location. additionalProperties: false pullSecretLinks: type: array items: type: string domain: type: string endpointNamingFormat: type: string enum: - default - legacy - org description: >- Customizes the subdomain format for the canonical workload endpoint. `default` leaves it as ${workloadName}-${gvcName}.cpln.app `org` follows the scheme ${workloadName}-${gvcName}.${org}.cpln.app aliasWorkloadLink: type: string description: >- Workload in this GVC whose canonical endpoint backs the GVC alias DNS record. When set, ${alias}.cpln.app is published as a CNAME to the workload's canonical endpoint, inheriting its HTTP health probes and per-location geo failover. When unset, the alias resolves directly to cluster ingress endpoints with no application-level health awareness. Has no effect while the referenced workload is globally suspended (defaultOptions.suspend or defaultOptions.autoscaling.maxScale == 0); per-location suspends are ignored. tracing: type: object properties: sampling: type: number lightstep: type: object properties: endpoint: type: string credentials: type: string additionalProperties: false customTags: type: object provider: type: object properties: otel: type: object properties: endpoint: type: string additionalProperties: false lightstep: type: object properties: endpoint: type: string credentials: type: string additionalProperties: false controlplane: type: object properties: {} additionalProperties: false additionalProperties: false additionalProperties: false sidecar: type: object properties: envoy: type: object properties: accessLog: type: array items: type: object properties: priority: type: number name: type: string enum: - envoy.http_grpc_access_log excludedWorkloads: type: array items: type: string typed_config: type: object properties: '@type': type: object common_config: type: object properties: log_name: type: string grpc_service: type: object properties: envoy_grpc: type: object properties: cluster_name: type: string authority: type: string default: adjust: null in: false iterables: null map: null separator: . type: value ancestor: 1 path: - cluster_name depth: 1 key: cluster_name root: cluster_name display: ref:cluster_name retry_policy: type: object properties: retry_back_off: type: object properties: base_interval: oneOf: - type: string - type: object properties: seconds: type: integer nanos: type: integer additionalProperties: false max_interval: oneOf: - type: string - type: object properties: seconds: type: integer nanos: type: integer additionalProperties: false additionalProperties: false num_retries: type: number additionalProperties: false additionalProperties: false google_grpc: type: object properties: target_uri: type: string channel_credentials: type: object properties: ssl_credentials: type: object properties: root_certs: type: object properties: filename: type: string inline_bytes: {} inline_string: type: string environment_variable: type: string additionalProperties: false private_key: type: object properties: filename: type: string inline_bytes: {} inline_string: type: string environment_variable: type: string additionalProperties: false cert_chain: type: object properties: filename: type: string inline_bytes: {} inline_string: type: string environment_variable: type: string additionalProperties: false additionalProperties: false google_default: type: object properties: {} additionalProperties: false additionalProperties: false call_credentials: type: array items: type: object properties: access_token: type: string google_compute_engine: type: object properties: {} additionalProperties: false google_refresh_token: type: string service_account_jwt_access: type: object properties: json_key: type: string token_lifetime_seconds: type: integer additionalProperties: false google_iam: type: object properties: authorization_token: type: string authority_selector: type: string additionalProperties: false from_plugin: type: object properties: name: type: string typed_config: type: object additionalProperties: false sts_service: type: object properties: token_exchange_service_uri: type: string resource: type: string audience: type: string scope: type: string requested_token_type: type: string subject_token_path: type: string subject_token_type: type: string actor_token_path: type: string actor_token_type: type: string additionalProperties: false additionalProperties: false stat_prefix: type: string credentials_factory_name: type: string config: type: object additionalProperties: false timeout: oneOf: - type: string - type: object properties: seconds: type: integer nanos: type: integer additionalProperties: false initial_metadata: type: array items: type: object properties: key: type: string value: type: string raw_value: {} additionalProperties: false additionalProperties: false transport_api_version: type: string enum: - AUTO - V2 - V3 buffer_flush_interval: oneOf: - type: string - type: object properties: seconds: type: integer nanos: type: integer additionalProperties: false buffer_size_bytes: type: integer filter_state_objects_to_log: type: array items: type: string grpc_stream_retry_policy: type: object properties: retry_back_off: type: object properties: base_interval: oneOf: - type: string - type: object properties: seconds: type: integer nanos: type: integer additionalProperties: false max_interval: oneOf: - type: string - type: object properties: seconds: type: integer nanos: type: integer additionalProperties: false additionalProperties: false num_retries: type: number additionalProperties: false additionalProperties: false additional_request_headers_to_log: type: array items: type: string additional_response_headers_to_log: type: array items: type: string additional_response_trailers_to_log: type: array items: type: string additionalProperties: false additionalProperties: false clusters: type: array items: type: object properties: name: type: string excludedWorkloads: type: array items: type: string transport_socket_matches: type: object alt_stat_name: type: object type: type: string enum: - STATIC - STRICT_DNS - LOGICAL_DNS - EDS - ORIGINAL_DST cluster_type: type: object eds_cluster_config: type: object connect_timeout: type: object per_connection_buffer_limit_bytes: type: object lb_policy: type: object load_assignment: type: object properties: cluster_name: type: string endpoints: type: object policy: type: object additionalProperties: false health_checks: type: object max_requests_per_connection: type: object circuit_breakers: type: object upstream_http_protocol_options: type: object common_http_protocol_options: type: object http_protocol_options: type: object http2_protocol_options: type: object typed_extension_protocol_options: type: object dns_refresh_rate: type: object dns_failure_refresh_rate: type: object respect_dns_ttl: type: object dns_lookup_family: type: object dns_resolvers: type: object use_tcp_for_dns_lookups: type: object dns_resolution_config: type: object typed_dns_resolver_config: type: object wait_for_warm_on_init: type: object outlier_detection: type: object cleanup_interval: type: object upstream_bind_config: type: object lb_subset_config: type: object ring_hash_lb_config: type: object maglev_lb_config: type: object least_request_lb_config: type: object common_lb_config: type: object transport_socket: type: object metadata: type: object protocol_selection: type: object upstream_connection_options: type: object close_connections_on_host_health_failure: type: object ignore_health_on_host_removal: type: object filters: type: object load_balancing_policy: type: object track_timeout_budgets: type: object upstream_config: type: object track_cluster_stats: type: object preconnect_policy: type: object connection_pool_per_downstream_connection: type: object additionalProperties: false excludedExternalAuth: type: array items: type: object properties: match: type: object properties: prefix: type: string path: type: string safe_regex: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false path_separated_prefix: type: string path_match_policy: type: object properties: name: type: string typed_config: type: object additionalProperties: false case_sensitive: type: boolean runtime_fraction: type: object properties: default_value: type: object properties: numerator: type: integer denominator: type: integer additionalProperties: false runtime_key: type: string additionalProperties: false headers: type: array items: type: object properties: name: type: string safe_regex_match: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false range_match: type: object properties: start: type: integer end: type: integer additionalProperties: false present_match: type: boolean string_match: type: object properties: exact: type: string prefix: type: string suffix: type: string safe_regex: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false contains: type: string ignore_case: type: boolean additionalProperties: false invert_match: type: boolean treat_missing_header_as_empty: type: boolean additionalProperties: false query_parameters: type: array items: type: object properties: name: type: string string_match: type: object properties: exact: type: string prefix: type: string suffix: type: string safe_regex: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false contains: type: string ignore_case: type: boolean additionalProperties: false present_match: type: boolean additionalProperties: false grpc: type: object properties: presented: type: boolean validated: type: boolean additionalProperties: false tls_context: type: object properties: presented: type: boolean validated: type: boolean additionalProperties: false dynamic_metadata: type: array items: type: object properties: filter: type: string path: type: array items: type: object properties: key: type: string additionalProperties: false value: type: object properties: null_match: type: object double_match: type: object properties: range: type: object properties: start: type: number end: type: number additionalProperties: false exact: type: number additionalProperties: false string_match: type: object properties: exact: type: string prefix: type: string suffix: type: string safe_regex: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false contains: type: string ignore_case: type: boolean additionalProperties: false bool_match: type: boolean present_match: type: boolean additionalProperties: false invert: type: boolean additionalProperties: false additionalProperties: false port: type: integer svcPort: type: integer additionalProperties: false excludedRateLimit: type: array items: type: object properties: match: type: object properties: prefix: type: string path: type: string safe_regex: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false path_separated_prefix: type: string path_match_policy: type: object properties: name: type: string typed_config: type: object additionalProperties: false case_sensitive: type: boolean runtime_fraction: type: object properties: default_value: type: object properties: numerator: type: integer denominator: type: integer additionalProperties: false runtime_key: type: string additionalProperties: false headers: type: array items: type: object properties: name: type: string safe_regex_match: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false range_match: type: object properties: start: type: integer end: type: integer additionalProperties: false present_match: type: boolean string_match: type: object properties: exact: type: string prefix: type: string suffix: type: string safe_regex: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false contains: type: string ignore_case: type: boolean additionalProperties: false invert_match: type: boolean treat_missing_header_as_empty: type: boolean additionalProperties: false query_parameters: type: array items: type: object properties: name: type: string string_match: type: object properties: exact: type: string prefix: type: string suffix: type: string safe_regex: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false contains: type: string ignore_case: type: boolean additionalProperties: false present_match: type: boolean additionalProperties: false grpc: type: object properties: presented: type: boolean validated: type: boolean additionalProperties: false tls_context: type: object properties: presented: type: boolean validated: type: boolean additionalProperties: false dynamic_metadata: type: array items: type: object properties: filter: type: string path: type: array items: type: object properties: key: type: string additionalProperties: false value: type: object properties: null_match: type: object double_match: type: object properties: range: type: object properties: start: type: number end: type: number additionalProperties: false exact: type: number additionalProperties: false string_match: type: object properties: exact: type: string prefix: type: string suffix: type: string safe_regex: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false contains: type: string ignore_case: type: boolean additionalProperties: false bool_match: type: boolean present_match: type: boolean additionalProperties: false invert: type: boolean additionalProperties: false additionalProperties: false port: type: integer svcPort: type: integer additionalProperties: false http: type: array items: oneOf: - type: object properties: priority: type: number excludedWorkloads: type: array items: type: string name: type: string enum: - envoy.filters.http.ext_authz typed_config: type: object properties: grpc_service: type: object properties: envoy_grpc: type: object properties: cluster_name: type: string authority: type: string default: adjust: null in: false iterables: null map: null separator: . type: value ancestor: 1 path: - cluster_name depth: 1 key: cluster_name root: cluster_name display: ref:cluster_name retry_policy: type: object properties: retry_back_off: type: object properties: base_interval: oneOf: - type: string - type: object properties: seconds: type: integer nanos: type: integer additionalProperties: false max_interval: oneOf: - type: string - type: object properties: seconds: type: integer nanos: type: integer additionalProperties: false additionalProperties: false num_retries: type: number additionalProperties: false additionalProperties: false google_grpc: type: object properties: target_uri: type: string channel_credentials: type: object properties: ssl_credentials: type: object properties: root_certs: type: object properties: filename: type: string inline_bytes: {} inline_string: type: string environment_variable: type: string additionalProperties: false private_key: type: object properties: filename: type: string inline_bytes: {} inline_string: type: string environment_variable: type: string additionalProperties: false cert_chain: type: object properties: filename: type: string inline_bytes: {} inline_string: type: string environment_variable: type: string additionalProperties: false additionalProperties: false google_default: type: object properties: {} additionalProperties: false additionalProperties: false call_credentials: type: array items: type: object properties: access_token: type: string google_compute_engine: type: object properties: {} additionalProperties: false google_refresh_token: type: string service_account_jwt_access: type: object properties: json_key: type: string token_lifetime_seconds: type: integer additionalProperties: false google_iam: type: object properties: authorization_token: type: string authority_selector: type: string additionalProperties: false from_plugin: type: object properties: name: type: string typed_config: type: object additionalProperties: false sts_service: type: object properties: token_exchange_service_uri: type: string resource: type: string audience: type: string scope: type: string requested_token_type: type: string subject_token_path: type: string subject_token_type: type: string actor_token_path: type: string actor_token_type: type: string additionalProperties: false additionalProperties: false stat_prefix: type: string credentials_factory_name: type: string config: type: object additionalProperties: false timeout: oneOf: - type: string - type: object properties: seconds: type: integer nanos: type: integer additionalProperties: false initial_metadata: type: array items: type: object properties: key: type: string value: type: string raw_value: {} additionalProperties: false additionalProperties: false http_service: type: object properties: server_uri: type: object properties: uri: type: string cluster: type: string timeout: oneOf: - type: string - type: object properties: seconds: type: integer nanos: type: integer additionalProperties: false additionalProperties: false path_prefix: type: string authorization_request: type: object properties: allowed_headers: type: object properties: patterns: type: array items: type: object properties: exact: type: string prefix: type: string suffix: type: string safe_regex: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false contains: type: string ignore_case: type: boolean additionalProperties: false additionalProperties: false headers_to_add: type: array items: type: object properties: key: type: string value: type: string raw_value: {} additionalProperties: false additionalProperties: false authorization_response: type: object properties: allowed_upstream_headers: type: object properties: patterns: type: array items: type: object properties: exact: type: string prefix: type: string suffix: type: string safe_regex: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false contains: type: string ignore_case: type: boolean additionalProperties: false additionalProperties: false allowed_upstream_headers_to_append: type: object properties: patterns: type: array items: type: object properties: exact: type: string prefix: type: string suffix: type: string safe_regex: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false contains: type: string ignore_case: type: boolean additionalProperties: false additionalProperties: false allowed_client_headers: type: object properties: patterns: type: array items: type: object properties: exact: type: string prefix: type: string suffix: type: string safe_regex: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false contains: type: string ignore_case: type: boolean additionalProperties: false additionalProperties: false allowed_client_headers_on_success: type: object properties: patterns: type: array items: type: object properties: exact: type: string prefix: type: string suffix: type: string safe_regex: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false contains: type: string ignore_case: type: boolean additionalProperties: false additionalProperties: false dynamic_metadata_from_headers: type: object properties: patterns: type: array items: type: object properties: exact: type: string prefix: type: string suffix: type: string safe_regex: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false contains: type: string ignore_case: type: boolean additionalProperties: false additionalProperties: false additionalProperties: false additionalProperties: false failure_mode_allow: type: boolean failure_mode_allow_header_add: type: boolean with_request_body: type: object properties: max_request_bytes: type: integer allow_partial_message: type: boolean pack_as_bytes: type: boolean additionalProperties: false clear_route_cache: type: boolean status_on_error: type: object properties: code: type: string enum: - Empty - Continue - OK - Created - Accepted - NonAuthoritativeInformation - NoContent - ResetContent - PartialContent - MultiStatus - AlradyReported - IMUsed - MultipleChoices - MovedPermanently - Found - SeeOther - NotModified - UseProxy - TemporaryRedirect - PermanentRedirect - BadRequest - Unauthroized - PaymentRequired - Forbidden - NotFound - MethodNotAllowed - NotAcceptable - ProxyAuthenticationRequired - RequestTimeout - Conflict - Gone - LengthRequired - PreconditionFailed - PayloadTooLarge - URITooLong - UnsupportedMediaType - RangeNotSatisfiable - ExpectationFailed - MisdirectedRequest - UnprocessableEntity - Locked - FailedDependency - UpgradeRequired - PreconditionRequired - TooManyRequests - RequestHeaderFieldsTooLarge - InternalServerError - NotImplemented - BadGateway - ServiceUnavailable - GatewayTimeout - HTTPVersionNotSupported - VariantAlsoNegotiates - InsufficientStorage - LoopDetected - NotExtended - NetworkAuthenticationRequired additionalProperties: false metadata_context_namespaces: type: array items: type: string typed_metadata_context_namespaces: type: array items: type: string route_metadata_context_namespaces: type: array items: type: string route_typed_metadata_context_namespaces: type: array items: type: string filter_enabled: type: object properties: numerator: type: integer denominator: type: integer additionalProperties: false deny_at_disable: type: object properties: default_value: type: boolean runtime_key: type: string additionalProperties: false include_peer_certificate: type: boolean stat_prefix: type: string bootstrap_metadata_labels_key: type: string allowed_headers: type: object properties: patterns: type: array items: type: object properties: exact: type: string prefix: type: string suffix: type: string safe_regex: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false contains: type: string ignore_case: type: boolean additionalProperties: false additionalProperties: false include_tls_session: type: boolean charge_cluster_response_stats: type: boolean transport_api_version: type: string enum: - AUTO - V2 - V3 '@type': type: string enum: - >- type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthz additionalProperties: false additionalProperties: false - type: object properties: priority: type: number excludedWorkloads: type: array items: type: string name: type: string enum: - envoy.filters.http.jwt_authn typed_config: type: object properties: providers: type: object rules: type: array items: type: object properties: match: type: object properties: prefix: type: string headers: type: array items: type: object properties: name: type: string safe_regex_match: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false range_match: type: object properties: start: type: integer end: type: integer additionalProperties: false present_match: type: boolean string_match: type: object properties: exact: type: string prefix: type: string suffix: type: string safe_regex: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false contains: type: string ignore_case: type: boolean additionalProperties: false invert_match: type: boolean treat_missing_header_as_empty: type: boolean additionalProperties: false additionalProperties: false requires: type: object properties: provider_name: type: string additionalProperties: false additionalProperties: false filter_state_rules: type: object properties: name: type: string requires: type: object additionalProperties: false bypass_cors_preflight: type: boolean requirement_map: type: object '@type': type: string enum: - >- type.googleapis.com/envoy.extensions.filters.http.jwt_authn.v3.JwtAuthentication additionalProperties: false additionalProperties: false - type: object properties: priority: type: number excludedWorkloads: type: array items: type: string name: type: string enum: - envoy.filters.http.grpc_web typed_config: type: object properties: '@type': type: string enum: - >- type.googleapis.com/envoy.extensions.filters.http.grpc_web.v3.GrpcWeb additionalProperties: false additionalProperties: false - type: object properties: priority: type: number excludedWorkloads: type: array items: type: string name: type: string enum: - envoy.filters.http.connect_grpc_bridge typed_config: type: object properties: '@type': type: string enum: - >- type.googleapis.com/envoy.extensions.filters.http.connect_grpc_bridge.v3.FilterConfig additionalProperties: false additionalProperties: false - type: object properties: priority: type: number excludedWorkloads: type: array items: type: string name: type: string enum: - envoy.filters.http.grpc_json_transcoder typed_config: type: object properties: proto_descriptor: type: string proto_descriptor_bin: {} services: type: array items: type: string print_options: type: object properties: add_whitespace: type: boolean always_print_primitive_fields: type: boolean always_print_enums_as_ints: type: boolean preserve_proto_field_names: type: boolean stream_newline_delimited: type: boolean additionalProperties: false match_incoming_request_route: type: boolean ignored_query_parameters: type: array items: type: string auto_mapping: type: boolean ignore_unknown_query_parameters: type: boolean convert_grpc_status: type: boolean url_unescape_spec: type: string enum: - ALL_CHARACTERS_EXCEPT_RESERVED - ALL_CHARACTERS_EXCEPT_SLASH - ALL_CHARACTERS query_param_unescape_plus: type: boolean match_unregistered_custom_verb: type: boolean request_validation_options: type: object properties: reject_unknown_method: type: boolean reject_unknown_query_parameters: type: boolean reject_binding_body_field_collisions: type: boolean additionalProperties: false case_insensitive_enum_parsing: type: boolean max_request_body_size: type: integer max_response_body_size: type: integer '@type': type: string enum: - >- type.googleapis.com/envoy.extensions.filters.http.grpc_json_transcoder.v3.GrpcJsonTranscoder additionalProperties: false additionalProperties: false - type: object properties: priority: type: number excludedWorkloads: type: array items: type: string name: type: string enum: - envoy.filters.http.cors typed_config: type: object properties: allow_origin_string_match: type: array items: type: object properties: exact: type: string prefix: type: string suffix: type: string safe_regex: type: object properties: google_re2: type: object properties: max_program_size: type: integer additionalProperties: false regex: type: string additionalProperties: false contains: type: string ignore_case: type: boolean additionalProperties: false allow_methods: type: string allow_headers: type: string expose_headers: type: string max_age: type: string allow_credentials: type: boolean filter_enabled: type: object properties: default_value: type: object properties: numerator: type: integer denominator: type: integer additionalProperties: false runtime_key: type: string additionalProperties: false shadow_enabled: type: object properties: default_value: type: object properties: numerator: type: integer denominator: type: integer additionalProperties: false runtime_key: type: string additionalProperties: false allow_private_network_access: type: boolean '@type': type: string enum: - >- type.googleapis.com/envoy.extensions.filters.http.cors.v3.Cors additionalProperties: false additionalProperties: false - type: object properties: priority: type: number excludedWorkloads: type: array items: type: string name: type: string enum: - envoy.filters.http.ratelimit typed_config: type: object properties: domain: type: string stage: type: integer request_type: type: string enum: - internal - external - both timeout: oneOf: - type: string - type: object properties: seconds: type: integer nanos: type: integer additionalProperties: false failure_mode_deny: type: boolean rate_limited_as_resource_exhausted: type: boolean rate_limit_service: type: object properties: grpc_service: type: object properties: envoy_grpc: type: object properties: cluster_name: type: string authority: type: string default: adjust: null in: false iterables: null map: null separator: . type: value ancestor: 1 path: - cluster_name depth: 1 key: cluster_name root: cluster_name display: ref:cluster_name retry_policy: type: object properties: retry_back_off: type: object properties: base_interval: oneOf: - type: string - type: object properties: seconds: type: integer nanos: type: integer additionalProperties: false max_interval: oneOf: - type: string - type: object properties: seconds: type: integer nanos: type: integer additionalProperties: false additionalProperties: false num_retries: type: number additionalProperties: false additionalProperties: false google_grpc: type: object properties: target_uri: type: string channel_credentials: type: object properties: ssl_credentials: type: object properties: root_certs: type: object properties: filename: type: string inline_bytes: {} inline_string: type: string environment_variable: type: string additionalProperties: false private_key: type: object properties: filename: type: string inline_bytes: {} inline_string: type: string environment_variable: type: string additionalProperties: false cert_chain: type: object properties: filename: type: string inline_bytes: {} inline_string: type: string environment_variable: type: string additionalProperties: false additionalProperties: false google_default: type: object properties: {} additionalProperties: false additionalProperties: false call_credentials: type: array items: type: object properties: access_token: type: string google_compute_engine: type: object properties: {} additionalProperties: false google_refresh_token: type: string service_account_jwt_access: type: object properties: json_key: type: string token_lifetime_seconds: type: integer additionalProperties: false google_iam: type: object properties: authorization_token: type: string authority_selector: type: string additionalProperties: false from_plugin: type: object properties: name: type: string typed_config: type: object additionalProperties: false sts_service: type: object properties: token_exchange_service_uri: type: string resource: type: string audience: type: string scope: type: string requested_token_type: type: string subject_token_path: type: string subject_token_type: type: string actor_token_path: type: string actor_token_type: type: string additionalProperties: false additionalProperties: false stat_prefix: type: string credentials_factory_name: type: string config: type: object additionalProperties: false timeout: oneOf: - type: string - type: object properties: seconds: type: integer nanos: type: integer additionalProperties: false initial_metadata: type: array items: type: object properties: key: type: string value: type: string raw_value: {} additionalProperties: false additionalProperties: false transport_api_version: type: string enum: - AUTO - V2 - V3 additionalProperties: false enable_x_ratelimit_headers: type: string enum: - 'OFF' - DRAFT_VERSION_03 disable_x_envoy_ratelimited_header: type: boolean rate_limited_status: type: object properties: code: type: string enum: - Empty - Continue - OK - Created - Accepted - NonAuthoritativeInformation - NoContent - ResetContent - PartialContent - MultiStatus - AlradyReported - IMUsed - MultipleChoices - MovedPermanently - Found - SeeOther - NotModified - UseProxy - TemporaryRedirect - PermanentRedirect - BadRequest - Unauthroized - PaymentRequired - Forbidden - NotFound - MethodNotAllowed - NotAcceptable - ProxyAuthenticationRequired - RequestTimeout - Conflict - Gone - LengthRequired - PreconditionFailed - PayloadTooLarge - URITooLong - UnsupportedMediaType - RangeNotSatisfiable - ExpectationFailed - MisdirectedRequest - UnprocessableEntity - Locked - FailedDependency - UpgradeRequired - PreconditionRequired - TooManyRequests - RequestHeaderFieldsTooLarge - InternalServerError - NotImplemented - BadGateway - ServiceUnavailable - GatewayTimeout - HTTPVersionNotSupported - VariantAlsoNegotiates - InsufficientStorage - LoopDetected - NotExtended - NetworkAuthenticationRequired additionalProperties: false response_headers_to_add: type: array items: type: object properties: header: type: object properties: key: type: string value: type: string raw_value: {} additionalProperties: false append: type: boolean append_action: type: string enum: - APPEND_IF_EXISTS_OR_ADD - ADD_IF_ABSENT - OVERWRITE_IF_EXISTS_OR_ADD - OVERWRITE_IF_EXISTS keep_empty_value: type: boolean additionalProperties: false status_on_error: type: object properties: code: type: string enum: - Empty - Continue - OK - Created - Accepted - NonAuthoritativeInformation - NoContent - ResetContent - PartialContent - MultiStatus - AlradyReported - IMUsed - MultipleChoices - MovedPermanently - Found - SeeOther - NotModified - UseProxy - TemporaryRedirect - PermanentRedirect - BadRequest - Unauthroized - PaymentRequired - Forbidden - NotFound - MethodNotAllowed - NotAcceptable - ProxyAuthenticationRequired - RequestTimeout - Conflict - Gone - LengthRequired - PreconditionFailed - PayloadTooLarge - URITooLong - UnsupportedMediaType - RangeNotSatisfiable - ExpectationFailed - MisdirectedRequest - UnprocessableEntity - Locked - FailedDependency - UpgradeRequired - PreconditionRequired - TooManyRequests - RequestHeaderFieldsTooLarge - InternalServerError - NotImplemented - BadGateway - ServiceUnavailable - GatewayTimeout - HTTPVersionNotSupported - VariantAlsoNegotiates - InsufficientStorage - LoopDetected - NotExtended - NetworkAuthenticationRequired additionalProperties: false stat_prefix: type: string '@type': type: string enum: - >- type.googleapis.com/envoy.extensions.filters.http.ratelimit.v3.RateLimit additionalProperties: false additionalProperties: false network: type: array items: type: object volumes: type: array items: type: object properties: uri: type: string recoveryPolicy: type: string enum: - retain - recycle default: retain description: >- Only applicable to persistent volumes, this determines what Control Plane will do when creating a new workload replica if a corresponding volume exists. path: type: string description: >- Mount path inside the container. Required for non-vm workloads; rejected for type=vm. name: type: string maxLength: 63 description: >- VM disk name. Required for type=vm; rejected for other workload types. bus: type: string enum: - virtio - sata - scsi description: >- VM disk bus. Only valid for type=vm. A cpln://secret/ volume on a sata or scsi bus is presented to the guest as a read-only CD-ROM. bootOrder: type: integer description: VM disk boot order. Only valid for type=vm. additionalProperties: false additionalProperties: false additionalProperties: false env: type: array items: type: object properties: name: type: string maxLength: 120 value: type: string maxLength: 4096 additionalProperties: false description: >- These environment variables will be available to any workload in the GVC. Note: a workload must opt-in to receive these variables. loadBalancer: type: object properties: dedicated: type: boolean description: >- Creates a dedicated load balancer in each location and enables additional Domain features: custom ports, protocols and wildcard hostnames. Charges apply for each location. multiZone: type: object properties: enabled: type: boolean additionalProperties: false trustedProxies: type: integer description: >- Controls the address used for request logging and for setting the X-Envoy-External-Address header. If set to 1, then the last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If set to 2, then the second to last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If the XFF header does not have at least two addresses or does not exist then the source client IP address will be used instead. redirect: type: object properties: class: type: object properties: status5xx: type: string description: >- Specify the redirect url for any 500 level status code status401: type: string description: > An optional url redirect for 401 responses. Supports envoy format strings to include request information. E.g. https://your-oauth-server/oauth2/authorize?return_to=%REQ(:path)%&client_id=your-client-id additionalProperties: false description: Specify the redirect url for all status codes in a class additionalProperties: false description: >- Specify the url to be redirected to for different http status codes. ipSet: type: string description: >- A link to an IPSet resource that will be used for this load balancer additionalProperties: false keda: type: object properties: enabled: type: boolean description: >- Enable KEDA for this GVC. KEDA is a Kubernetes-based event-driven autoscaler that allows you to scale workloads based on external events. When enabled,a keda operator will be deployed in the GVC and workloads in the GVC can use KEDA to scale based on external metrics. identityLink: type: string description: >- A link to an Identity resource that will be used for KEDA. This will allow the keda operator to access cloud and network resources. secrets: type: array items: type: string description: >- A list of secrets to be used as TriggerAuthentication objects. The TriggerAuthentication object will be named after the secret and can be used by triggers on workloads in this GVC. additionalProperties: false additionalProperties: false status: type: object properties: {} additionalProperties: false readOnly: true additionalProperties: false error: type: object properties: status: type: integer message: type: string code: type: string details: type: object id: type: string additionalProperties: false link: type: object properties: rel: type: string href: type: string additionalProperties: false securitySchemes: serviceAccountKey: type: apiKey in: header name: Authorization description: Service account key can be used as API keys jwt: type: http scheme: bearer bearerFormat: JWT description: IDP-provided token ````