# APIService

APIServiceAPIService represents a server for a particular GroupVersion.apiVersion: apiregistration.k8s.io/v1import "k8s.io/kube-aggregator/pkg/apis/apiregistration/v1"APIServiceAPIService represents a server for a particular GroupVersion. Name must be "version.group".apiVersion: apiregistration.k8s.io/v1kind: APIServicemetadata (ObjectMeta)Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataspec (APIServiceSpec)Spec contains information for locating and communicating with a serverstatus (APIServiceStatus)Status contains derived information about an API serverAPIServiceSpecAPIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification.groupPriorityMinimum (int32), requiredGroupPriorityMinimum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMinimum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000sversionPriority (int32), requiredVersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.caBundle ([]byte)Atomic: will be replaced during a mergeCABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used.group (string)Group is the API group name this server hostsinsecureSkipTLSVerify (boolean)InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.service (ServiceReference)Service is a reference to the service for this API server. It must communicate on port 443. If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled.ServiceReference holds a reference to Service.legacy.k8s.ioservice.name (string)Name is the name of the serviceservice.namespace (string)Namespace is the namespace of the serviceservice.port (int32)If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. port should be a valid port number (1-65535, inclusive).version (string)Version is the API version this server hosts. For example, "v1"APIServiceStatusAPIServiceStatus contains derived information about an API serverconditions ([]APIServiceCondition)Patch strategy: merge on key typeMap: unique values on key type will be kept during a mergeCurrent service state of apiService.APIServiceCondition describes the state of an APIService at a particular pointconditions.status (string), requiredStatus is the status of the condition. Can be True, False, Unknown.conditions.type (string), requiredType is the type of the condition.conditions.lastTransitionTime (Time)Last time the condition transitioned from one status to another.Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.conditions.message (string)Human-readable message indicating details about last transition.conditions.reason (string)Unique, one-word, CamelCase reason for the condition's last transition.APIServiceListAPIServiceList is a list of APIService objects.apiVersion: apiregistration.k8s.io/v1kind: APIServiceListmetadata (ListMeta)Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataitems ([]APIService), requiredItems is the list of APIServiceOperationsget read the specified APIServiceHTTP RequestGET /apis/apiregistration.k8s.io/v1/apiservices/{name}Parametersname (in path): string, requiredname of the APIServicepretty (in query): stringprettyResponse200 (APIService): OK401: Unauthorizedget read status of the specified APIServiceHTTP RequestGET /apis/apiregistration.k8s.io/v1/apiservices/{name}/statusParametersname (in path): string, requiredname of the APIServicepretty (in query): stringprettyResponse200 (APIService): OK401: Unauthorizedlist list or watch objects of kind APIServiceHTTP RequestGET /apis/apiregistration.k8s.io/v1/apiservicesParametersallowWatchBookmarks (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 (APIServiceList): OK401: Unauthorizedcreate create an APIServiceHTTP RequestPOST /apis/apiregistration.k8s.io/v1/apiservicesParametersbody: APIService, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (APIService): OK201 (APIService): Created202 (APIService): Accepted401: Unauthorizedupdate replace the specified APIServiceHTTP RequestPUT /apis/apiregistration.k8s.io/v1/apiservices/{name}Parametersname (in path): string, requiredname of the APIServicebody: APIService, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (APIService): OK201 (APIService): Created401: Unauthorizedupdate replace status of the specified APIServiceHTTP RequestPUT /apis/apiregistration.k8s.io/v1/apiservices/{name}/statusParametersname (in path): string, requiredname of the APIServicebody: APIService, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (APIService): OK201 (APIService): Created401: Unauthorizedpatch partially update the specified APIServiceHTTP RequestPATCH /apis/apiregistration.k8s.io/v1/apiservices/{name}Parametersname (in path): string, requiredname of the APIServicebody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (APIService): OK201 (APIService): Created401: Unauthorizedpatch partially update status of the specified APIServiceHTTP RequestPATCH /apis/apiregistration.k8s.io/v1/apiservices/{name}/statusParametersname (in path): string, requiredname of the APIServicebody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (APIService): OK201 (APIService): Created401: Unauthorizeddelete delete an APIServiceHTTP RequestDELETE /apis/apiregistration.k8s.io/v1/apiservices/{name}Parametersname (in path): string, requiredname of the APIServicebody: DeleteOptionsdryRun (in query): stringdryRungracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentialpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyResponse200 (Status): OK202 (Status): Accepted401: Unauthorizeddeletecollection delete collection of APIServiceHTTP RequestDELETE /apis/apiregistration.k8s.io/v1/apiservicesParametersbody: 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.