Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Istio VirtualService API

HTTP/TCP routing rules for traffic management

Istio VirtualService API is one of 14 APIs that Istio publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 10 JSON Schema definitions.

Tagged areas include VirtualService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 10 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version v1alpha1.

Requests are made against a single base URL, https://{cluster}/apis/extensions.istio.io/v1alpha1.

5 operations 2 paths 5 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1alpha1
Server
https://{cluster}/apis/extensions.istio.io/v1alpha1
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

Istio VirtualService API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

  • BearerAuth — Kubernetes API server bearer token authentication

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

VirtualService 5

HTTP/TCP routing rules for traffic management

GET
/namespaces/{namespace}/virtualservices
Istio List VirtualServices
listVirtualServices 4 params → 200401
POST
/namespaces/{namespace}/virtualservices
Istio Create a VirtualService
createVirtualService 1 param body → 201401409
GET
/namespaces/{namespace}/virtualservices/{name}
Istio Get a VirtualService
getVirtualService 2 params → 200401404
PUT
/namespaces/{namespace}/virtualservices/{name}
Istio Replace a VirtualService
replaceVirtualService 2 params body → 200401404
DELETE
/namespaces/{namespace}/virtualservices/{name}
Istio Delete a VirtualService
deleteVirtualService 2 params → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are HTTPRoute (8 properties), ObjectMeta (6 properties), VirtualServiceList (4 properties), VirtualService (4 properties). Each schema is shown below with its type and property counts.

HTTPRoute
object
8 properties
VirtualService
object
4 properties
ObjectMeta
object
6 properties
VirtualServiceList
object
4 properties
ListMeta
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

istio-virtualservice-api-openapi.yml Raw ↑

Other APIs Istio publishes across the network.

Istio Telemetry API
Istio Mesh Config API
Istio Operator API
Istio AuthorizationPolicy API
Istio DestinationRule API
Istio Gateway API
Istio PeerAuthentication API
Istio RequestAuthentication API
Istio ServiceEntry API
Istio Sidecar API
Istio WasmPlugin API
Istio WorkloadEntry API