v1.Route

Description

A route allows developers to expose services through an HTTP(S) aware load balancing and proxy layer via a public DNS entry. The route may further specify TLS options and a certificate, or specify a public CNAME that the router should also accept for HTTP and HTTPS traffic. An administrator typically configures their router to be visible outside the cluster firewall, and may also add additional security, caching, or traffic controls on the service content. Routers usually talk directly to the service endpoints.

Once a route is created, the host field may not be changed. Generally, routers use the oldest route with a given host when resolving conflicts.

Routers are subject to additional customization and may support additional controls via the annotations field.

Because administrators may configure multiple routers, the route status field is used to return information to clients about the names and states of the route under each router. If a client chooses a duplicate name, for instance, the route status conditions are used to indicate the route cannot be chosen.

Object Schema

Expand or mouse-over a field for more information about it.

apiVersion:
kind:
metadata:
  annotations:
    [string]:
  clusterName:
  creationTimestamp:
  deletionGracePeriodSeconds:
  deletionTimestamp:
  finalizers:
  - [string]:
  generateName:
  generation:
  initializers:
    pending:
    - name:
    result:
      apiVersion:
      code:
      details:
        causes:
        - field:
          message:
          reason:
        group:
        kind:
        name:
        retryAfterSeconds:
        uid:
      kind:
      message:
      metadata:
        resourceVersion:
        selfLink:
      reason:
      status:
  labels:
    [string]:
  name:
  namespace:
  ownerReferences:
  - apiVersion:
    blockOwnerDeletion:
    controller:
    kind:
    name:
    uid:
  resourceVersion:
  selfLink:
  uid:
spec:
  alternateBackends:
  - kind:
    name:
    weight:
  host:
  path:
  port:
    targetPort:
  tls:
    caCertificate:
    certificate:
    destinationCACertificate:
    insecureEdgeTerminationPolicy:
    key:
    termination:
  to:
    kind:
    name:
    weight:
  wildcardPolicy:
status:
  ingress:
  - conditions:
  - - lastTransitionTime:
      message:
      reason:
      status:
      type:
    host:
    routerCanonicalHostname:
    routerName:
    wildcardPolicy:

Operations

Create a Route

Create a Route

HTTP request

POST /apis/route.openshift.io/v1/routes HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "Route",
  "apiVersion": "route.openshift.io/v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/route.openshift.io/v1/routes <<'EOF'
{
  "kind": "Route",
  "apiVersion": "route.openshift.io/v1",
  ...
}
EOF

HTTP body

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Create a Route in a namespace

Create a Route

HTTP request

POST /apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "Route",
  "apiVersion": "route.openshift.io/v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes <<'EOF'
{
  "kind": "Route",
  "apiVersion": "route.openshift.io/v1",
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Get a Route in a namespace

Read the specified Route

HTTP request

GET /apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes/$NAME

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Get all Routes

List or watch objects of kind Route

HTTP request

GET /apis/route.openshift.io/v1/routes HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/route.openshift.io/v1/routes

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

• application/json;stream=watch

• application/vnd.kubernetes.protobuf;stream=watch

Get all Routes in a namespace

List or watch objects of kind Route

HTTP request

GET /apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

• application/json;stream=watch

• application/vnd.kubernetes.protobuf;stream=watch

Watch a Route in a namespace

Watch changes to an object of kind Route

HTTP request

GET /apis/route.openshift.io/v1/watch/namespaces/$NAMESPACE/routes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/route.openshift.io/v1/watch/namespaces/$NAMESPACE/routes/$NAME

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

• application/json;stream=watch

• application/vnd.kubernetes.protobuf;stream=watch

Watch all Routes

Watch individual changes to a list of Route

HTTP request

GET /apis/route.openshift.io/v1/watch/routes HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/route.openshift.io/v1/watch/routes

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

• application/json;stream=watch

• application/vnd.kubernetes.protobuf;stream=watch

Watch all Routes in a namespace

Watch individual changes to a list of Route

HTTP request

GET /apis/route.openshift.io/v1/watch/namespaces/$NAMESPACE/routes HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/route.openshift.io/v1/watch/namespaces/$NAMESPACE/routes

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

• application/json;stream=watch

• application/vnd.kubernetes.protobuf;stream=watch

Update a Route in a namespace

Replace the specified Route

HTTP request

PUT /apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "Route",
  "apiVersion": "route.openshift.io/v1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes/$NAME <<'EOF'
{
  "kind": "Route",
  "apiVersion": "route.openshift.io/v1",
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Patch a Route in a namespace

Partially update the specified Route

HTTP request

PATCH /apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'
{
  ...
}

Curl request

$ curl -k \
    -X PATCH \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json-patch+json' \
    https://$ENDPOINT/apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• application/json-patch+json

• application/merge-patch+json

• application/strategic-merge-patch+json

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Delete a Route in a namespace

Delete a Route

HTTP request

DELETE /apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  ...
}

Curl request

$ curl -k \
    -X DELETE \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Delete all Routes in a namespace

Delete collection of Route

HTTP request

DELETE /apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X DELETE \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Get status of a Route in a namespace

Read status of the specified Route

HTTP request

GET /apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes/$NAME/status

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Update status of a Route in a namespace

Replace status of the specified Route

HTTP request

PUT /apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "Route",
  "apiVersion": "route.openshift.io/v1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes/$NAME/status <<'EOF'
{
  "kind": "Route",
  "apiVersion": "route.openshift.io/v1",
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Patch status of a Route in a namespace

Partially update status of the specified Route

HTTP request

PATCH /apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'
{
  ...
}

Curl request

$ curl -k \
    -X PATCH \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json-patch+json' \
    https://$ENDPOINT/apis/route.openshift.io/v1/namespaces/$NAMESPACE/routes/$NAME/status <<'EOF'
{
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• application/json-patch+json

• application/merge-patch+json

• application/strategic-merge-patch+json

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf