Top Level API Objects

Definitions

v1.APIResourceList

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

Name	Description	Required	Schema
kind	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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds	false	string
apiVersion	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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources	false	string
groupVersion	groupVersion is the group and version this APIResourceList is for.	true	string
resources	resources contains the name of the resources and if they are namespaced.	true	v1.APIResource array

Name

Description

Required

Schema

Default

kind

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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false

string

groupVersion

groupVersion is the group and version this APIResourceList is for.

true

string

resources

resources contains the name of the resources and if they are namespaced.

true

v1.APIResource array

v1.APIResource

APIResource specifies the name of a resource and whether it is namespaced.

Name	Description	Required	Schema	Default
name	name is the name of the resource.	true	string
namespaced	namespaced indicates if a resource is namespaced or not.	true	boolean	false
kind	kind is the kind for the resource (e.g. Foo is the kind for a resource foo)	true	string
verbs	verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)	true	string array

Name

Description

Required

Schema

Default

name

name is the name of the resource.

true

string

namespaced

namespaced indicates if a resource is namespaced or not.

true

boolean

false

kind

kind is the kind for the resource (e.g. Foo is the kind for a resource foo)

true

string

verbs

verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)

true

string array

any

Represents an untyped JSON map - see the description of the field for more info about the structure of this object.