kubectl-api-resources(1)

1KUBERNETES(1)(kubernetes)                            KUBERNETES(1)(kubernetes)
2
3
4
5Eric Paris Jan 2015
6
7

NAME

9       kubectl api-resources - Print the supported API resources on the server
10
11
12

SYNOPSIS

14       kubectl api-resources [OPTIONS]
15
16
17

DESCRIPTION

19       Print the supported API resources on the server.
20
21
22

OPTIONS

24       --api-group=""      Limit to resources in the specified API group.
25
26
27       --cached=false      Use the cached list of resources if available.
28
29
30       --categories=[]       Limit  to resources that belong the the specified
31       categories.
32
33
34       --namespaced=true      If false, non-namespaced resources will  be  re‐
35       turned, otherwise returning namespaced resources by default.
36
37
38       --no-headers=false       When using the default or custom-column output
39       format, don't print headers (default print headers).
40
41
42       -o, --output=""      Output format. One of: (wide, name).
43
44
45       --sort-by=""      If non-empty, sort list of resources using  specified
46       field. The field can be either 'name' or 'kind'.
47
48
49       --verbs=[]      Limit to resources that support the specified verbs.
50
51
52

OPTIONS INHERITED FROM PARENT COMMANDS

54       --as=""      Username to impersonate for the operation. User could be a
55       regular user or a service account in a namespace.
56
57
58       --as-group=[]      Group to impersonate for the  operation,  this  flag
59       can be repeated to specify multiple groups.
60
61
62       --as-uid=""      UID to impersonate for the operation.
63
64
65       --azure-container-registry-config=""       Path  to the file containing
66       Azure container registry configuration information.
67
68
69       --cache-dir="/builddir/.kube/cache"      Default cache directory
70
71
72       --certificate-authority=""      Path to a cert file for the certificate
73       authority
74
75
76       --client-certificate=""      Path to a client certificate file for TLS
77
78
79       --client-key=""      Path to a client key file for TLS
80
81
82       --cluster=""      The name of the kubeconfig cluster to use
83
84
85       --context=""      The name of the kubeconfig context to use
86
87
88       --disable-compression=false       If true, opt-out of response compres‐
89       sion for all requests to the server
90
91
92       --insecure-skip-tls-verify=false      If true, the server's certificate
93       will not be checked for validity. This will make your HTTPS connections
94       insecure
95
96
97       --kubeconfig=""      Path to the kubeconfig file to  use  for  CLI  re‐
98       quests.
99
100
101       --match-server-version=false        Require  server  version  to  match
102       client version
103
104
105       -n, --namespace=""      If present, the namespace scope  for  this  CLI
106       request
107
108
109       --password=""      Password for basic authentication to the API server
110
111
112       --profile="none"         Name   of   profile   to   capture.   One   of
113       (none|cpu|heap|goroutine|threadcreate|block|mutex)
114
115
116       --profile-output="profile.pprof"      Name of the  file  to  write  the
117       profile to
118
119
120       --request-timeout="0"       The length of time to wait before giving up
121       on a single server request. Non-zero values  should  contain  a  corre‐
122       sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
123       out requests.
124
125
126       -s, --server=""      The address and port of the Kubernetes API server
127
128
129       --tls-server-name=""      Server name to  use  for  server  certificate
130       validation.  If  it  is  not provided, the hostname used to contact the
131       server is used
132
133
134       --token=""      Bearer token for authentication to the API server
135
136
137       --user=""      The name of the kubeconfig user to use
138
139
140       --username=""      Username for basic authentication to the API server
141
142
143       --version=false      Print version information and quit
144
145
146       --warnings-as-errors=false      Treat warnings received from the server
147       as errors and exit with a non-zero exit code
148
149
150

EXAMPLE

152                # Print the supported API resources
153                kubectl api-resources
154
155                # Print the supported API resources with more information
156                kubectl api-resources -o wide
157
158                # Print the supported API resources sorted by a column
159                kubectl api-resources --sort-by=name
160
161                # Print the supported namespaced resources
162                kubectl api-resources --namespaced=true
163
164                # Print the supported non-namespaced resources
165                kubectl api-resources --namespaced=false
166
167                # Print the supported API resources with a specific APIGroup
168                kubectl api-resources --api-group=rbac.authorization.k8s.io
169
170
171
172

HISTORY

179       January  2015,  Originally compiled by Eric Paris (eparis at redhat dot
180       com) based on the kubernetes source material, but hopefully  they  have
181       been automatically generated since!
182
183
184
185Manuals                              User            KUBERNETES(1)(kubernetes)