# IPAddress

IPAddressIPAddress represents a single IP of a single IP Family.apiVersion: networking.k8s.io/v1import "k8s.io/api/networking/v1"IPAddressIPAddress 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::1apiVersion: networking.k8s.io/v1kind: IPAddressmetadata (ObjectMeta)Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataspec (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-statusIPAddressSpecIPAddressSpec describe the attributes in an IP Address.parentRef (ParentReference), requiredParentRef 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), requiredName is the name of the object being referenced.parentRef.resource (string), requiredResource 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.IPAddressListIPAddressList contains a list of IPAddress.apiVersion: networking.k8s.io/v1kind: IPAddressListmetadata (ListMeta)Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataitems ([]IPAddress), requireditems is the list of IPAddresses.Operationsget read the specified IPAddressHTTP RequestGET /apis/networking.k8s.io/v1/ipaddresses/{name}Parametersname (in path): string, requiredname of the IPAddresspretty (in query): stringprettyResponse200 (IPAddress): OK401: Unauthorizedlist list or watch objects of kind IPAddressHTTP RequestGET /apis/networking.k8s.io/v1/ipaddressesParametersallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (IPAddressList): OK401: Unauthorizedcreate create an IPAddressHTTP RequestPOST /apis/networking.k8s.io/v1/ipaddressesParametersbody: IPAddress, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (IPAddress): OK201 (IPAddress): Created202 (IPAddress): Accepted401: Unauthorizedupdate replace the specified IPAddressHTTP RequestPUT /apis/networking.k8s.io/v1/ipaddresses/{name}Parametersname (in path): string, requiredname of the IPAddressbody: IPAddress, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (IPAddress): OK201 (IPAddress): Created401: Unauthorizedpatch partially update the specified IPAddressHTTP RequestPATCH /apis/networking.k8s.io/v1/ipaddresses/{name}Parametersname (in path): string, requiredname of the IPAddressbody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (IPAddress): OK201 (IPAddress): Created401: Unauthorizeddelete delete an IPAddressHTTP RequestDELETE /apis/networking.k8s.io/v1/ipaddresses/{name}Parametersname (in path): string, requiredname of the IPAddressbody: DeleteOptionsdryRun (in query): stringdryRungracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentialpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyResponse200 (Status): OK202 (Status): Accepted401: Unauthorizeddeletecollection delete collection of IPAddressHTTP RequestDELETE /apis/networking.k8s.io/v1/ipaddressesParametersbody: DeleteOptionscontinue (in query): stringcontinuedryRun (in query): stringdryRunfieldSelector (in query): stringfieldSelectorgracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentiallabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondsResponse200 (Status): OK401: UnauthorizedThis 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.