apiVersion: networking.k8s.io/v1
import "k8s.io/api/networking/v1"
IPAddress represents a single IP of a single IP Family. The object is designed to be used by APIs that operate on IP addresses. The object is used by the Service core API for allocation of IP addresses. An IP address can be represented in different formats, to guarantee the uniqueness of the IP, the name of the object is the IP address in canonical format, four decimal digits separated by dots suppressing leading zeros for IPv4 and the representation defined by RFC 5952 for IPv6. Valid: 192.168.1.5 or 2001:db8::1 or 2001:db8:aaaa:bbbb:cccc:dddd:eeee:1 Invalid: 10.01.2.3 or 2001:db8:0:0:0::1
apiVersion: networking.k8s.io/v1
kind: IPAddress
metadata (ObjectMeta)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (IPAddressSpec)
spec is the desired state of the IPAddress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
IPAddressSpec describe the attributes in an IP Address.
parentRef (ParentReference), required
ParentRef references the resource that an IPAddress is attached to. An IPAddress must reference a parent object.
ParentReference describes a reference to a parent object.
parentRef.name (string), required
Name is the name of the object being referenced.
parentRef.resource (string), required
Resource is the resource of the object being referenced.
parentRef.group (string)
Group is the group of the object being referenced.
parentRef.namespace (string)
Namespace is the namespace of the object being referenced.
IPAddressList contains a list of IPAddress.
apiVersion: networking.k8s.io/v1
kind: IPAddressList
metadata (ListMeta)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
items ([]IPAddress), required
items is the list of IPAddresses.
get read the specified IPAddressGET /apis/networking.k8s.io/v1/ipaddresses/{name}
name (in path): string, required
name of the IPAddress
pretty (in query): string
200 (IPAddress): OK
401: Unauthorized
list list or watch objects of kind IPAddressGET /apis/networking.k8s.io/v1/ipaddresses
allowWatchBookmarks (in query): boolean
continue (in query): string
fieldSelector (in query): string
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
sendInitialEvents (in query): boolean
timeoutSeconds (in query): integer
watch (in query): boolean
200 (IPAddressList): OK
401: Unauthorized
create create an IPAddressPOST /apis/networking.k8s.io/v1/ipaddresses
body: IPAddress, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
200 (IPAddress): OK
201 (IPAddress): Created
202 (IPAddress): Accepted
401: Unauthorized
update replace the specified IPAddressPUT /apis/networking.k8s.io/v1/ipaddresses/{name}
name (in path): string, required
name of the IPAddress
body: IPAddress, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
200 (IPAddress): OK
201 (IPAddress): Created
401: Unauthorized
patch partially update the specified IPAddressPATCH /apis/networking.k8s.io/v1/ipaddresses/{name}
name (in path): string, required
name of the IPAddress
body: Patch, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
force (in query): boolean
pretty (in query): string
200 (IPAddress): OK
201 (IPAddress): Created
401: Unauthorized
delete delete an IPAddressDELETE /apis/networking.k8s.io/v1/ipaddresses/{name}
name (in path): string, required
name of the IPAddress
body: DeleteOptions
dryRun (in query): string
gracePeriodSeconds (in query): integer
ignoreStoreReadErrorWithClusterBreakingPotential (in query): boolean
pretty (in query): string
propagationPolicy (in query): string
200 (Status): OK
202 (Status): Accepted
401: Unauthorized
deletecollection delete collection of IPAddressDELETE /apis/networking.k8s.io/v1/ipaddresses
body: DeleteOptions
continue (in query): string
dryRun (in query): string
fieldSelector (in query): string
gracePeriodSeconds (in query): integer
ignoreStoreReadErrorWithClusterBreakingPotential (in query): boolean
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
propagationPolicy (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
sendInitialEvents (in query): boolean
timeoutSeconds (in query): integer
200 (Status): OK
401: Unauthorized
This page is automatically generated.
If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.