POST /oapi/v1/egressnetworkpolicies HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close Content-Type: application/json' { "kind": "EgressNetworkPolicy", "apiVersion": "v1", ... }
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.
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:
Create an EgressNetworkPolicy
POST /oapi/v1/egressnetworkpolicies HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close Content-Type: application/json' { "kind": "EgressNetworkPolicy", "apiVersion": "v1", ... }
Create an EgressNetworkPolicy
POST /oapi/v1/namespaces/$NAMESPACE/egressnetworkpolicies HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close Content-Type: application/json' { "kind": "EgressNetworkPolicy", "apiVersion": "v1", ... }
$ curl -k \ -X POST \ -d @- \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/egressnetworkpolicies <<'EOF' { "kind": "EgressNetworkPolicy", "apiVersion": "v1", ... } EOF
Read the specified EgressNetworkPolicy
GET /oapi/v1/namespaces/$NAMESPACE/egressnetworkpolicies/$NAME HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/egressnetworkpolicies/$NAME
Parameter | Description |
---|---|
name |
name of the EgressNetworkPolicy |
namespace |
object name and auth scope, such as for teams and projects |
List or watch objects of kind EgressNetworkPolicy
GET /oapi/v1/egressnetworkpolicies HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/oapi/v1/egressnetworkpolicies
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
List or watch objects of kind EgressNetworkPolicy
GET /oapi/v1/namespaces/$NAMESPACE/egressnetworkpolicies HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/egressnetworkpolicies
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Watch changes to an object of kind EgressNetworkPolicy
GET /oapi/v1/watch/namespaces/$NAMESPACE/egressnetworkpolicies/$NAME HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/oapi/v1/watch/namespaces/$NAMESPACE/egressnetworkpolicies/$NAME
Parameter | Description |
---|---|
name |
name of the EgressNetworkPolicy |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
pretty |
If 'true', then the output is pretty printed. |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Watch individual changes to a list of EgressNetworkPolicy
GET /oapi/v1/watch/egressnetworkpolicies HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/oapi/v1/watch/egressnetworkpolicies
Parameter | Description |
---|---|
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
pretty |
If 'true', then the output is pretty printed. |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Watch individual changes to a list of EgressNetworkPolicy
GET /oapi/v1/watch/namespaces/$NAMESPACE/egressnetworkpolicies HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/oapi/v1/watch/namespaces/$NAMESPACE/egressnetworkpolicies
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
pretty |
If 'true', then the output is pretty printed. |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Replace the specified EgressNetworkPolicy
PUT /oapi/v1/namespaces/$NAMESPACE/egressnetworkpolicies/$NAME HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close Content-Type: application/json' { "kind": "EgressNetworkPolicy", "apiVersion": "v1", ... }
$ curl -k \ -X PUT \ -d @- \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/egressnetworkpolicies/$NAME <<'EOF' { "kind": "EgressNetworkPolicy", "apiVersion": "v1", ... } EOF
Partially update the specified EgressNetworkPolicy
PATCH /oapi/v1/namespaces/$NAMESPACE/egressnetworkpolicies/$NAME HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close Content-Type: application/json-patch+json' { ... }
$ curl -k \ -X PATCH \ -d @- \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ -H 'Content-Type: application/json-patch+json' \ https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/egressnetworkpolicies/$NAME <<'EOF' { ... } EOF
Parameter | Description |
---|---|
name |
name of the EgressNetworkPolicy |
namespace |
object name and auth scope, such as for teams and projects |
Delete an EgressNetworkPolicy
DELETE /oapi/v1/namespaces/$NAMESPACE/egressnetworkpolicies/$NAME HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close Content-Type: application/json' { ... }
$ curl -k \ -X DELETE \ -d @- \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/egressnetworkpolicies/$NAME <<'EOF' { ... } EOF
Parameter | Description |
---|---|
name |
name of the EgressNetworkPolicy |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
Delete collection of EgressNetworkPolicy
DELETE /oapi/v1/namespaces/$NAMESPACE/egressnetworkpolicies HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -X DELETE \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/oapi/v1/namespaces/$NAMESPACE/egressnetworkpolicies
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |