POST /apis/extensions/v1beta1/networkpolicies HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
"kind": "NetworkPolicy",
"apiVersion": "extensions/v1beta1",
...
}
×
v1beta1.NetworkPolicy
- Description
- Object Schema
- Operations
- Create a NetworkPolicy
- Create a NetworkPolicy in a namespace
- Get a NetworkPolicy in a namespace
- Get all NetworkPolicies
- Get all NetworkPolicies in a namespace
- Watch a NetworkPolicy in a namespace
- Watch all NetworkPolicies
- Watch all NetworkPolicies in a namespace
- Update a NetworkPolicy in a namespace
- Patch a NetworkPolicy in a namespace
- Delete a NetworkPolicy in a namespace
- Delete all NetworkPolicies in a namespace
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:
ingress:
- from:
- - namespaceSelector:
- - matchExpressions:
- - - key:operator:values:
- [string]:matchLabels:
[string]:podSelector:
matchExpressions:
- key:operator:values:
- [string]:matchLabels:
[string]:ports:
- port:protocol:podSelector:
matchExpressions:
- key:operator:values:
- [string]:matchLabels:
[string]:
Operations
Create a NetworkPolicy
Create a NetworkPolicy
HTTP request
Create a NetworkPolicy in a namespace
Create a NetworkPolicy
HTTP request
POST /apis/extensions/v1beta1/namespaces/$NAMESPACE/networkpolicies HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
"kind": "NetworkPolicy",
"apiVersion": "extensions/v1beta1",
...
}
Curl request
$ curl -k \
-X POST \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
https://$ENDPOINT/apis/extensions/v1beta1/namespaces/$NAMESPACE/networkpolicies <<'EOF'
{
"kind": "NetworkPolicy",
"apiVersion": "extensions/v1beta1",
...
}
EOF
Get a NetworkPolicy in a namespace
Read the specified NetworkPolicy
HTTP request
GET /apis/extensions/v1beta1/namespaces/$NAMESPACE/networkpolicies/$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/extensions/v1beta1/namespaces/$NAMESPACE/networkpolicies/$NAME
Path parameters
| Parameter | Description |
|---|---|
name |
name of the NetworkPolicy |
namespace |
object name and auth scope, such as for teams and projects |
Get all NetworkPolicies
List or watch objects of kind NetworkPolicy
HTTP request
GET /apis/extensions/v1beta1/networkpolicies 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/extensions/v1beta1/networkpolicies
Query parameters
| 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. |
Get all NetworkPolicies in a namespace
List or watch objects of kind NetworkPolicy
HTTP request
GET /apis/extensions/v1beta1/namespaces/$NAMESPACE/networkpolicies 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/extensions/v1beta1/namespaces/$NAMESPACE/networkpolicies
Path parameters
| Parameter | Description |
|---|---|
namespace |
object name and auth scope, such as for teams and projects |
Query parameters
| 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 a NetworkPolicy in a namespace
Watch changes to an object of kind NetworkPolicy
HTTP request
GET /apis/extensions/v1beta1/watch/namespaces/$NAMESPACE/networkpolicies/$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/extensions/v1beta1/watch/namespaces/$NAMESPACE/networkpolicies/$NAME
Path parameters
| Parameter | Description |
|---|---|
name |
name of the NetworkPolicy |
namespace |
object name and auth scope, such as for teams and projects |
Query parameters
| 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 all NetworkPolicies
Watch individual changes to a list of NetworkPolicy
HTTP request
GET /apis/extensions/v1beta1/watch/networkpolicies 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/extensions/v1beta1/watch/networkpolicies
Query parameters
| 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 all NetworkPolicies in a namespace
Watch individual changes to a list of NetworkPolicy
HTTP request
GET /apis/extensions/v1beta1/watch/namespaces/$NAMESPACE/networkpolicies 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/extensions/v1beta1/watch/namespaces/$NAMESPACE/networkpolicies
Path parameters
| Parameter | Description |
|---|---|
namespace |
object name and auth scope, such as for teams and projects |
Query parameters
| 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. |
Update a NetworkPolicy in a namespace
Replace the specified NetworkPolicy
HTTP request
PUT /apis/extensions/v1beta1/namespaces/$NAMESPACE/networkpolicies/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
"kind": "NetworkPolicy",
"apiVersion": "extensions/v1beta1",
...
}
Curl request
$ curl -k \
-X PUT \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
https://$ENDPOINT/apis/extensions/v1beta1/namespaces/$NAMESPACE/networkpolicies/$NAME <<'EOF'
{
"kind": "NetworkPolicy",
"apiVersion": "extensions/v1beta1",
...
}
EOF
Patch a NetworkPolicy in a namespace
Partially update the specified NetworkPolicy
HTTP request
PATCH /apis/extensions/v1beta1/namespaces/$NAMESPACE/networkpolicies/$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/extensions/v1beta1/namespaces/$NAMESPACE/networkpolicies/$NAME <<'EOF'
{
...
}
EOF
Path parameters
| Parameter | Description |
|---|---|
name |
name of the NetworkPolicy |
namespace |
object name and auth scope, such as for teams and projects |
Delete a NetworkPolicy in a namespace
Delete a NetworkPolicy
HTTP request
DELETE /apis/extensions/v1beta1/namespaces/$NAMESPACE/networkpolicies/$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/extensions/v1beta1/namespaces/$NAMESPACE/networkpolicies/$NAME <<'EOF'
{
...
}
EOF
Path parameters
| Parameter | Description |
|---|---|
name |
name of the NetworkPolicy |
namespace |
object name and auth scope, such as for teams and projects |
Query parameters
| 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 all NetworkPolicies in a namespace
Delete collection of NetworkPolicy
HTTP request
DELETE /apis/extensions/v1beta1/namespaces/$NAMESPACE/networkpolicies 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/extensions/v1beta1/namespaces/$NAMESPACE/networkpolicies
Path parameters
| Parameter | Description |
|---|---|
namespace |
object name and auth scope, such as for teams and projects |
Query parameters
| 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. |