12 KiB
ThirdPartyResource v1beta1
| Group | Version | Kind |
|---|---|---|
| Extensions | v1beta1 | ThirdPartyResource |
A ThirdPartyResource is a generic representation of a resource, it is used by add-ons and plugins to add new resource types to the API. It consists of one or more Versions of the api.
| Field | 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
| description string |
Description is the description of this object. |
| 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
| metadata ObjectMeta |
Standard object metadata |
| versions APIVersion array |
Versions are versions for this third party object |
ThirdPartyResourceList v1beta1
| Field | 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
| items ThirdPartyResource array |
Items is the list of ThirdPartyResources. |
| 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
| metadata ListMeta |
Standard list metadata. |
Write Operations
See supported operations below...
Create
bdocs-tab:kubectl
kubectlCommand
Coming Soon
bdocs-tab:curl
curlCommand (requireskubectl proxyto be running)
Coming Soon
bdocs-tab:kubectl Output
Coming Soon
bdocs-tab:curl Response Body
Coming Soon
create a ThirdPartyResource
HTTP Request
POST /apis/extensions/v1beta1/thirdpartyresources
Query Parameters
| Parameter | Description |
|---|---|
| pretty | If 'true', then the output is pretty printed. |
Body Parameters
| Parameter | Description |
|---|---|
| body ThirdPartyResource |
Response
| Code | Description |
|---|---|
| 200 ThirdPartyResource |
OK |
Replace
bdocs-tab:kubectl
kubectlCommand
Coming Soon
bdocs-tab:curl
curlCommand (requireskubectl proxyto be running)
Coming Soon
bdocs-tab:kubectl Output
Coming Soon
bdocs-tab:curl Response Body
Coming Soon
replace the specified ThirdPartyResource
HTTP Request
PUT /apis/extensions/v1beta1/thirdpartyresources/{name}
Path Parameters
| Parameter | Description |
|---|---|
| name | name of the ThirdPartyResource |
Query Parameters
| Parameter | Description |
|---|---|
| pretty | If 'true', then the output is pretty printed. |
Body Parameters
| Parameter | Description |
|---|---|
| body ThirdPartyResource |
Response
| Code | Description |
|---|---|
| 200 ThirdPartyResource |
OK |
Patch
bdocs-tab:kubectl
kubectlCommand
Coming Soon
bdocs-tab:curl
curlCommand (requireskubectl proxyto be running)
Coming Soon
bdocs-tab:kubectl Output
Coming Soon
bdocs-tab:curl Response Body
Coming Soon
partially update the specified ThirdPartyResource
HTTP Request
PATCH /apis/extensions/v1beta1/thirdpartyresources/{name}
Path Parameters
| Parameter | Description |
|---|---|
| name | name of the ThirdPartyResource |
Query Parameters
| Parameter | Description |
|---|---|
| pretty | If 'true', then the output is pretty printed. |
Body Parameters
| Parameter | Description |
|---|---|
| body Patch |
Response
| Code | Description |
|---|---|
| 200 ThirdPartyResource |
OK |
Delete
bdocs-tab:kubectl
kubectlCommand
Coming Soon
bdocs-tab:curl
curlCommand (requireskubectl proxyto be running)
Coming Soon
bdocs-tab:kubectl Output
Coming Soon
bdocs-tab:curl Response Body
Coming Soon
delete a ThirdPartyResource
HTTP Request
DELETE /apis/extensions/v1beta1/thirdpartyresources/{name}
Path Parameters
| Parameter | Description |
|---|---|
| name | name of the ThirdPartyResource |
Query Parameters
| Parameter | Description |
|---|---|
| pretty | If 'true', then the output is pretty printed. |
| gracePeriodSeconds | 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 | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. |
Body Parameters
| Parameter | Description |
|---|---|
| body DeleteOptions |
Response
| Code | Description |
|---|---|
| 200 Status |
OK |
Delete Collection
bdocs-tab:kubectl
kubectlCommand
Coming Soon
bdocs-tab:curl
curlCommand (requireskubectl proxyto be running)
Coming Soon
bdocs-tab:kubectl Output
Coming Soon
bdocs-tab:curl Response Body
Coming Soon
delete collection of ThirdPartyResource
HTTP Request
DELETE /apis/extensions/v1beta1/thirdpartyresources
Query Parameters
| Parameter | Description |
|---|---|
| pretty | If 'true', then the output is pretty printed. |
| fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
| labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
| resourceVersion | 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. |
| timeoutSeconds | Timeout for the list/watch call. |
| watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Response
| Code | Description |
|---|---|
| 200 Status |
OK |
Read Operations
See supported operations below...
Read
bdocs-tab:kubectl
kubectlCommand
Coming Soon
bdocs-tab:curl
curlCommand (requireskubectl proxyto be running)
Coming Soon
bdocs-tab:kubectl Output
Coming Soon
bdocs-tab:curl Response Body
Coming Soon
read the specified ThirdPartyResource
HTTP Request
GET /apis/extensions/v1beta1/thirdpartyresources/{name}
Path Parameters
| Parameter | Description |
|---|---|
| name | name of the ThirdPartyResource |
Query Parameters
| Parameter | Description |
|---|---|
| pretty | If 'true', then the output is pretty printed. |
| exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace' |
| export | Should this value be exported. Export strips fields that a user can not specify. |
Response
| Code | Description |
|---|---|
| 200 ThirdPartyResource |
OK |
List
bdocs-tab:kubectl
kubectlCommand
Coming Soon
bdocs-tab:curl
curlCommand (requireskubectl proxyto be running)
Coming Soon
bdocs-tab:kubectl Output
Coming Soon
bdocs-tab:curl Response Body
Coming Soon
list or watch objects of kind ThirdPartyResource
HTTP Request
GET /apis/extensions/v1beta1/thirdpartyresources
Query Parameters
| Parameter | Description |
|---|---|
| pretty | If 'true', then the output is pretty printed. |
| fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
| labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
| resourceVersion | 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. |
| timeoutSeconds | Timeout for the list/watch call. |
| watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Response
| Code | Description |
|---|---|
| 200 ThirdPartyResourceList |
OK |
Watch
bdocs-tab:kubectl
kubectlCommand
Coming Soon
bdocs-tab:curl
curlCommand (requireskubectl proxyto be running)
Coming Soon
bdocs-tab:kubectl Output
Coming Soon
bdocs-tab:curl Response Body
Coming Soon
watch changes to an object of kind ThirdPartyResource
HTTP Request
GET /apis/extensions/v1beta1/watch/thirdpartyresources/{name}
Path Parameters
| Parameter | Description |
|---|---|
| name | name of the ThirdPartyResource |
Query Parameters
| Parameter | Description |
|---|---|
| fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
| labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
| pretty | If 'true', then the output is pretty printed. |
| resourceVersion | 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. |
| timeoutSeconds | Timeout for the list/watch call. |
| watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Response
| Code | Description |
|---|---|
| 200 Event |
OK |