APIService [apiregistration.k8s.io/v1] - apiregistration.k8s.io | API reference

Important

Azure Red Hat OpenShift 3.11 will be retired 30 June 2022. Support for creation of new Azure Red Hat OpenShift 3.11 clusters continues through 30 November 2020. Following retirement, remaining Azure Red Hat OpenShift 3.11 clusters will be shut down to prevent security vulnerabilities.

Follow this guide to create an Azure Red Hat OpenShift 4 cluster. If you have specific questions, please contact us

Specification
API endpoints

Description: APIService represents a server for a particular GroupVersion. Name must be "version.group".
Type: object

Specification

Property Type Description

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/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/api-conventions.md#types-kinds
`.metadata`	`ObjectMeta meta/v1`
`.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

.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/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/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

.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

service
groupPriorityMinimum
versionPriority

Property Type Description

Property	Type	Description
`caBundle`	`string`	CABundle is a PEM encoded CA bundle which will be used to validate an API server’s serving certificate.
`group`	`string`	Group is the API group name this server hosts
`groupPriorityMinimum`	`integer`	GroupPriorityMininum 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 GroupPriorityMininum 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.

caBundle

string

CABundle is a PEM encoded CA bundle which will be used to validate an API server’s serving certificate.

group

string

Group is the API group name this server hosts

groupPriorityMinimum

integer

GroupPriorityMininum 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 GroupPriorityMininum 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

Property	Type	Description
`name`	`string`	Name is the name of the service
`namespace`	`string`	Namespace is the namespace of the service

name

string

Name is the name of the service

namespace

string

Namespace is the namespace of the service

.status

Description: APIServiceStatus contains derived information about an API server
Type: object

Property Type Description

Property	Type	Description
`conditions`	`array`	Current service state of apiService.
`conditions[]`	`object`

conditions

array

Current service state of apiService.

conditions[]

object

.status.conditions

Description: Current service state of apiService.
Type: array

.status.conditions[]

Description

Type

object

Required

type
status

Property Type Description

Property	Type	Description
`lastTransitionTime`	`Time meta/v1`	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.

lastTransitionTime

Time meta/v1

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/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/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

Table 1. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete collection of APIService

Table 2. Query parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized`	`boolean`	If true, partially initialized resources are included in the response.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	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`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: list or watch objects of kind APIService

Table 4. Query parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized`	`boolean`	If true, partially initialized resources are included in the response.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	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`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`APIServiceList apiregistration.k8s.io/v1`
401 - Unauthorized	Empty

HTTP method: POST
Description: create an APIService

Table 6. Body parameters
Parameter	Type	Description
`body`	`APIService apiregistration.k8s.io/v1`

Table 7. HTTP responses
HTTP code	Reponse body
200 - OK	`APIService apiregistration.k8s.io/v1`
201 - Created	`APIService apiregistration.k8s.io/v1`
202 - Accepted	`APIService apiregistration.k8s.io/v1`
401 - Unauthorized	Empty

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

Table 8. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the APIService

Table 9. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete an APIService

Table 10. Query parameters
Parameter	Type	Description
`gracePeriodSeconds`	`integer`	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`	`boolean`	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`	`string`	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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

Table 11. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions meta/v1`

Table 12. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified APIService

Table 13. Query parameters
Parameter	Type	Description
`exact`	`boolean`	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
`export`	`boolean`	Should this value be exported. Export strips fields that a user can not specify.

Table 14. HTTP responses
HTTP code	Reponse body
200 - OK	`APIService apiregistration.k8s.io/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified APIService

Table 15. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 16. HTTP responses
HTTP code	Reponse body
200 - OK	`APIService apiregistration.k8s.io/v1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified APIService

Table 17. Body parameters
Parameter	Type	Description
`body`	`APIService apiregistration.k8s.io/v1`

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`APIService apiregistration.k8s.io/v1`
201 - Created	`APIService apiregistration.k8s.io/v1`
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

Table 20. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: GET
Description: read status of the specified APIService

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`APIService apiregistration.k8s.io/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified APIService

Table 22. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 23. HTTP responses
HTTP code	Reponse body
200 - OK	`APIService apiregistration.k8s.io/v1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified APIService

Table 24. Body parameters
Parameter	Type	Description
`body`	`APIService apiregistration.k8s.io/v1`

Table 25. HTTP responses
HTTP code	Reponse body
200 - OK	`APIService apiregistration.k8s.io/v1`
201 - Created	`APIService apiregistration.k8s.io/v1`
401 - Unauthorized	Empty