Contour website screenshot

Contour

A Kubernetes ingress controller using Envoy proxy that provides dynamic configuration updates and advanced routing capabilities for managing external access to services in a cluster.

5 APIs 0 Features
EnvoyIngress ControllerKubernetesNetworkingProxy

APIs

Contour HTTPProxy API

Kubernetes Custom Resource Definition that extends the standard Ingress API with advanced routing, multi-team support, TLS delegation, and weighted load balancing across multipl...

Contour Gateway API

Contour's implementation of the Kubernetes Gateway API, supporting HTTPRoute and TLSRoute resources for defining ingress traffic routing rules. Gateway API is the next-generatio...

Contour Kubernetes Ingress API

Contour's support for the standard Kubernetes Ingress v1 resource, enabling basic ingress use cases such as host-based and path-based routing to backend services. Contour watche...

Contour ExtensionService API

Kubernetes Custom Resource Definition for binding gRPC-based extension services to the Contour API. ExtensionService resources allow external components to implement Contour API...

Contour Configuration API

Contour's ContourConfiguration Custom Resource Definition (v1alpha1) that provides cluster-scoped configuration of a Contour instance, including ingress settings, TLS defaults, ...

Collections

Pricing Plans

Contour Plans Pricing

1 plans

PLANS

Rate Limits

Contour Rate Limits

3 limits

RATE LIMITS

FinOps

Semantic Vocabularies

Contour Context

0 classes · 12 properties

JSON-LD

API Governance Rules

Contour API Rules

5 rules · 4 errors 1 warnings

SPECTRAL

Contour API Rules

5 rules · 3 errors 2 warnings

SPECTRAL

JSON Structure

Contour Structure

0 properties

JSON STRUCTURE

Resources

🔗
Website
Website
🔗
JSONLD
JSONLD
🔗
JSONSchema
JSONSchema
🔗
Vocabulary
Vocabulary
🔗
SpectralRules
SpectralRules
🔗
SpectralRules
SpectralRules
🔗
Capability
Capability
🔗
Capability
Capability
🚀
GettingStarted
GettingStarted
🔗
Documentation
Documentation
👥
GitHubOrganization
GitHubOrganization
👥
GitHubRepository
GitHubRepository
💬
Support
Support
🔗
Community
Community
🔗
Resources
Resources
📄
ChangeLog
ChangeLog
🔗
Issue Tracker
Issue Tracker
🔗
Upgrading
Upgrading

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Contour HTTPProxy API
  version: 1.30.0
items:
- info:
    name: HTTPProxy
    type: folder
  items:
  - info:
      name: Contour List HTTPProxy resources in a namespace
      type: http
    http:
      method: GET
      url: https://{kubernetes-api-server}/apis/projectcontour.io/v1/namespaces/:namespace/httpproxies
      params:
      - name: namespace
        value: ''
        type: path
        description: The Kubernetes namespace of the resource.
      - name: labelSelector
        value: ''
        type: query
        description: A selector to restrict the list of returned resources by their labels. Defaults to everything.
      - name: fieldSelector
        value: ''
        type: query
        description: A selector to restrict the list of returned resources by their fields.
      - name: limit
        value: ''
        type: query
        description: Maximum number of responses to return per page. If there are additional results, a continue token is
          returned.
      - name: continue
        value: ''
        type: query
        description: A continuation token for paginating through large result sets, returned from a previous list call.
    docs: Returns a list of all HTTPProxy custom resources in the specified Kubernetes namespace. Results can be filtered
      using label selectors and field selectors.
  - info:
      name: Contour Create an HTTPProxy resource
      type: http
    http:
      method: POST
      url: https://{kubernetes-api-server}/apis/projectcontour.io/v1/namespaces/:namespace/httpproxies
      params:
      - name: namespace
        value: ''
        type: path
        description: The Kubernetes namespace of the resource.
      body:
        type: json
        data: '{}'
    docs: Creates a new HTTPProxy custom resource in the specified namespace. The HTTPProxy defines virtual hosts, routing
      rules, TLS configuration, and load balancing behavior for inbound HTTP/HTTPS traffic.
  - info:
      name: Contour Get a specific HTTPProxy resource
      type: http
    http:
      method: GET
      url: https://{kubernetes-api-server}/apis/projectcontour.io/v1/namespaces/:namespace/httpproxies/:name
      params:
      - name: namespace
        value: ''
        type: path
        description: The Kubernetes namespace of the resource.
      - name: name
        value: ''
        type: path
        description: The name of the resource.
    docs: Returns the specified HTTPProxy custom resource from the given namespace, including its current status, observed
      generation, and condition information.
  - info:
      name: Contour Replace an HTTPProxy resource
      type: http
    http:
      method: PUT
      url: https://{kubernetes-api-server}/apis/projectcontour.io/v1/namespaces/:namespace/httpproxies/:name
      params:
      - name: namespace
        value: ''
        type: path
        description: The Kubernetes namespace of the resource.
      - name: name
        value: ''
        type: path
        description: The name of the resource.
      body:
        type: json
        data: '{}'
    docs: Replaces the entire HTTPProxy resource with the provided specification. The resourceVersion in the metadata must
      match the current version to prevent conflicting updates.
  - info:
      name: Contour Partially update an HTTPProxy resource
      type: http
    http:
      method: PATCH
      url: https://{kubernetes-api-server}/apis/projectcontour.io/v1/namespaces/:namespace/httpproxies/:name
      params:
      - name: namespace
        value: ''
        type: path
        description: The Kubernetes namespace of the resource.
      - name: name
        value: ''
        type: path
        description: The name of the resource.
      body:
        type: json
        data: '{}'
    docs: Applies a partial update to the specified HTTPProxy resource using JSON Merge Patch or Strategic Merge Patch format.
  - info:
      name: Contour Delete an HTTPProxy resource
      type: http
    http:
      method: DELETE
      url: https://{kubernetes-api-server}/apis/projectcontour.io/v1/namespaces/:namespace/httpproxies/:name
      params:
      - name: namespace
        value: ''
        type: path
        description: The Kubernetes namespace of the resource.
      - name: name
        value: ''
        type: path
        description: The name of the resource.
    docs: Deletes the specified HTTPProxy resource from the namespace. Contour will stop configuring Envoy for the routes
      defined in this resource.
  - info:
      name: Contour List HTTPProxy resources across all namespaces
      type: http
    http:
      method: GET
      url: https://{kubernetes-api-server}/apis/projectcontour.io/v1/httpproxies
      params:
      - name: labelSelector
        value: ''
        type: query
        description: A selector to restrict the list of returned resources by their labels. Defaults to everything.
      - name: fieldSelector
        value: ''
        type: query
        description: A selector to restrict the list of returned resources by their fields.
      - name: limit
        value: ''
        type: query
        description: Maximum number of responses to return per page. If there are additional results, a continue token is
          returned.
      - name: continue
        value: ''
        type: query
        description: A continuation token for paginating through large result sets, returned from a previous list call.
    docs: Returns all HTTPProxy custom resources across all namespaces in the cluster. Useful for cluster-wide visibility
      into all ingress configurations managed by Contour.
- info:
    name: TLSCertificateDelegation
    type: folder
  items:
  - info:
      name: Contour List TLSCertificateDelegation resources
      type: http
    http:
      method: GET
      url: https://{kubernetes-api-server}/apis/projectcontour.io/v1/namespaces/:namespace/tlscertificatedelegations
      params:
      - name: namespace
        value: ''
        type: path
        description: The Kubernetes namespace of the resource.
    docs: Returns all TLSCertificateDelegation resources in the specified namespace. These resources allow TLS certificates
      to be delegated for use by HTTPProxy resources in other namespaces.
  - info:
      name: Contour Create a TLSCertificateDelegation resource
      type: http
    http:
      method: POST
      url: https://{kubernetes-api-server}/apis/projectcontour.io/v1/namespaces/:namespace/tlscertificatedelegations
      params:
      - name: namespace
        value: ''
        type: path
        description: The Kubernetes namespace of the resource.
      body:
        type: json
        data: '{}'
    docs: Creates a TLSCertificateDelegation resource that grants specified target namespaces permission to reference TLS
      certificates from this namespace in their HTTPProxy resources.
bundled: true