v1.EgressNetworkPolicy

You are viewing documentation for a release that is no longer supported. The latest supported version of version 3 is [3.11]. For the most recent version 4, see [4]

You are viewing documentation for a release that is no longer supported. The latest supported version of version 3 is [3.11]. For the most recent version 4, see [4]

Description

EgressNetworkPolicy describes the current egress network policy for a Namespace. When using the ‘redhat/openshift-ovs-multitenant’ network plugin, traffic from a pod to an IP address outside the cluster will be checked against each EgressNetworkPolicyRule in the pod’s namespace’s EgressNetworkPolicy, in order. If no rule matches (or no EgressNetworkPolicy is present) then the traffic will be allowed by default.

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:
  egress:
  - to:
  -   cidrSelector:
      dnsName:
    type:

Operations

Create a EgressNetworkPolicy

Create an EgressNetworkPolicy

HTTP request

POST /apis/network.openshift.io/v1/egressnetworkpolicies HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "EgressNetworkPolicy",
  "apiVersion": "network.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/network.openshift.io/v1/egressnetworkpolicies <<'EOF'
{
  "kind": "EgressNetworkPolicy",
  "apiVersion": "network.openshift.io/v1",
  ...
}
EOF

HTTP body

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Create a EgressNetworkPolicy in a namespace

Create an EgressNetworkPolicy

HTTP request

POST /apis/network.openshift.io/v1/namespaces/$NAMESPACE/egressnetworkpolicies HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "EgressNetworkPolicy",
  "apiVersion": "network.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/network.openshift.io/v1/namespaces/$NAMESPACE/egressnetworkpolicies <<'EOF'
{
  "kind": "EgressNetworkPolicy",
  "apiVersion": "network.openshift.io/v1",
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Get a EgressNetworkPolicy in a namespace

Read the specified EgressNetworkPolicy

HTTP request

GET /apis/network.openshift.io/v1/namespaces/$NAMESPACE/egressnetworkpolicies/$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/network.openshift.io/v1/namespaces/$NAMESPACE/egressnetworkpolicies/$NAME

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Get all EgressNetworkPolicies

List or watch objects of kind EgressNetworkPolicy

HTTP request

GET /apis/network.openshift.io/v1/egressnetworkpolicies 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/network.openshift.io/v1/egressnetworkpolicies

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 EgressNetworkPolicies in a namespace

List or watch objects of kind EgressNetworkPolicy

HTTP request

GET /apis/network.openshift.io/v1/namespaces/$NAMESPACE/egressnetworkpolicies 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/network.openshift.io/v1/namespaces/$NAMESPACE/egressnetworkpolicies

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 EgressNetworkPolicy in a namespace

Watch changes to an object of kind EgressNetworkPolicy

HTTP request

GET /apis/network.openshift.io/v1/watch/namespaces/$NAMESPACE/egressnetworkpolicies/$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/network.openshift.io/v1/watch/namespaces/$NAMESPACE/egressnetworkpolicies/$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 EgressNetworkPolicies

Watch individual changes to a list of EgressNetworkPolicy

HTTP request

GET /apis/network.openshift.io/v1/watch/egressnetworkpolicies 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/network.openshift.io/v1/watch/egressnetworkpolicies

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 EgressNetworkPolicies in a namespace

Watch individual changes to a list of EgressNetworkPolicy

HTTP request

GET /apis/network.openshift.io/v1/watch/namespaces/$NAMESPACE/egressnetworkpolicies 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/network.openshift.io/v1/watch/namespaces/$NAMESPACE/egressnetworkpolicies

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 EgressNetworkPolicy in a namespace

Replace the specified EgressNetworkPolicy

HTTP request

PUT /apis/network.openshift.io/v1/namespaces/$NAMESPACE/egressnetworkpolicies/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "EgressNetworkPolicy",
  "apiVersion": "network.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/network.openshift.io/v1/namespaces/$NAMESPACE/egressnetworkpolicies/$NAME <<'EOF'
{
  "kind": "EgressNetworkPolicy",
  "apiVersion": "network.openshift.io/v1",
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Patch a EgressNetworkPolicy in a namespace

Partially update the specified EgressNetworkPolicy

HTTP request

PATCH /apis/network.openshift.io/v1/namespaces/$NAMESPACE/egressnetworkpolicies/$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/network.openshift.io/v1/namespaces/$NAMESPACE/egressnetworkpolicies/$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 EgressNetworkPolicy in a namespace

Delete an EgressNetworkPolicy

HTTP request

DELETE /apis/network.openshift.io/v1/namespaces/$NAMESPACE/egressnetworkpolicies/$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/network.openshift.io/v1/namespaces/$NAMESPACE/egressnetworkpolicies/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf

Delete all EgressNetworkPolicies in a namespace

Delete collection of EgressNetworkPolicy

HTTP request

DELETE /apis/network.openshift.io/v1/namespaces/$NAMESPACE/egressnetworkpolicies 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/network.openshift.io/v1/namespaces/$NAMESPACE/egressnetworkpolicies

Path parameters

Query parameters

Responses

Consumes

• */*

Produces

• application/json

• application/yaml

• application/vnd.kubernetes.protobuf