1. Documentation
×

APIService [apiregistration.k8s.io/v1]

Specification

Property Type Description

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification.

status

object

APIServiceStatus contains derived information about an API server

.spec

Description

APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification.

Type

object

Required

  • groupPriorityMinimum

  • versionPriority

Property Type Description

caBundle

string

CABundle 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 hosts

groupPriorityMinimum

integer

GroupPriorityMinimum 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 2000s

insecureSkipTLSVerify

boolean

InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.

service

object

ServiceReference holds a reference to Service.legacy.k8s.io

version

string

Version is the API version this server hosts. For example, "v1"

versionPriority

integer

VersionPriority 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.

.spec.service

Description

ServiceReference holds a reference to Service.legacy.k8s.io

Type

object

Property Type Description

name

string

Name is the name of the service

namespace

string

Namespace is the namespace of the service

port

integer

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).

.status

Description

APIServiceStatus contains derived information about an API server

Type

object

Property Type Description

conditions

array

Current service state of apiService.

conditions[]

object

APIServiceCondition describes the state of an APIService at a particular point

.status.conditions

Description

Current service state of apiService.

Type

array

.status.conditions[]

Description

APIServiceCondition describes the state of an APIService at a particular point

Type

object

Required

  • type

  • status

Property Type Description

lastTransitionTime

Time

Last time the condition transitioned from one status to another.

message

string

Human-readable message indicating details about last transition.

reason

string

Unique, one-word, CamelCase reason for the condition’s last transition.

status

string

Status is the status of the condition. Can be True, False, Unknown.

type

string

Type is the type of the condition.

API endpoints

The following API endpoints are available:

  • /apis/apiregistration.k8s.io/v1/apiservices

    • DELETE: delete collection of APIService

    • GET: list or watch objects of kind APIService

    • POST: create an APIService

  • /apis/apiregistration.k8s.io/v1/watch/apiservices

    • GET: watch individual changes to a list of APIService. deprecated: use the 'watch' parameter with a list operation instead.

  • /apis/apiregistration.k8s.io/v1/apiservices/{name}

    • DELETE: delete an APIService

    • GET: read the specified APIService

    • PATCH: partially update the specified APIService

    • PUT: replace the specified APIService

  • /apis/apiregistration.k8s.io/v1/watch/apiservices/{name}

    • GET: watch changes to an object of kind APIService. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

  • /apis/apiregistration.k8s.io/v1/apiservices/{name}/status

    • GET: read status of the specified APIService

    • PATCH: partially update status of the specified APIService

    • PUT: replace status of the specified APIService

/apis/apiregistration.k8s.io/v1/apiservices

HTTP method

DELETE

Description

delete collection of APIService

Table 1. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
Table 2. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

Empty
HTTP method

GET

Description

list or watch objects of kind APIService

Table 3. HTTP responses
HTTP code Reponse body

200 - OK

APIServiceList schema

401 - Unauthorized

Empty
HTTP method

POST

Description

create an APIService

Table 4. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Table 5. Body parameters
Parameter Type Description

body

APIService schema
Table 6. HTTP responses
HTTP code Reponse body

200 - OK

APIService schema

201 - Created

APIService schema

202 - Accepted

APIService schema

401 - Unauthorized

Empty

/apis/apiregistration.k8s.io/v1/watch/apiservices

HTTP method

GET

Description

watch individual changes to a list of APIService. deprecated: use the 'watch' parameter with a list operation instead.

Table 7. HTTP responses
HTTP code Reponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

/apis/apiregistration.k8s.io/v1/apiservices/{name}

Table 8. Global path parameters
Parameter Type Description

name

string

name of the APIService
HTTP method

DELETE

Description

delete an APIService

Table 9. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
Table 10. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty
HTTP method

GET

Description

read the specified APIService

Table 11. HTTP responses
HTTP code Reponse body

200 - OK

APIService schema

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update the specified APIService

Table 12. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Table 13. HTTP responses
HTTP code Reponse body

200 - OK

APIService schema

201 - Created

APIService schema

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace the specified APIService

Table 14. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Table 15. Body parameters
Parameter Type Description

body

APIService schema
Table 16. HTTP responses
HTTP code Reponse body

200 - OK

APIService schema

201 - Created

APIService schema

401 - Unauthorized

Empty

/apis/apiregistration.k8s.io/v1/watch/apiservices/{name}

Table 17. Global path parameters
Parameter Type Description

name

string

name of the APIService
HTTP method

GET

Description

watch changes to an object of kind APIService. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

Table 18. HTTP responses
HTTP code Reponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

/apis/apiregistration.k8s.io/v1/apiservices/{name}/status

Table 19. Global path parameters
Parameter Type Description

name

string

name of the APIService
HTTP method

GET

Description

read status of the specified APIService

Table 20. HTTP responses
HTTP code Reponse body

200 - OK

APIService schema

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update status of the specified APIService

Table 21. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Table 22. HTTP responses
HTTP code Reponse body

200 - OK

APIService schema

201 - Created

APIService schema

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace status of the specified APIService

Table 23. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Table 24. Body parameters
Parameter Type Description

body

APIService schema
Table 25. HTTP responses
HTTP code Reponse body

200 - OK

APIService schema

201 - Created

APIService schema

401 - Unauthorized

Empty