- v1beta1.ThirdPartyResource
v1beta1.ThirdPartyResource
You are viewing documentation for a release that is no longer supported. The latest supported version of version 3 is [3.11]. For the most recent version 4, see [4]
You are viewing documentation for a release that is no longer supported. The latest supported version of version 3 is [3.11]. For the most recent version 4, see [4]
Description
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.
Object Schema
Expand or mouse-over a field for more information about it.
apiVersion:
description:
kind:
metadata:
annotations:
[string]:
clusterName:
creationTimestamp:
deletionGracePeriodSeconds:
deletionTimestamp:
finalizers:
- [string]:
generateName:
generation:
initializers:
pending:
- name:
result:
apiVersion:
code:
details:
causes:
- field:
message:
reason:
group:
kind:
name:
retryAfterSeconds:
uid:
kind:
message:
metadata:
resourceVersion:
selfLink:
reason:
status:
labels:
[string]:
name:
namespace:
ownerReferences:
- apiVersion:
blockOwnerDeletion:
controller:
kind:
name:
uid:
resourceVersion:
selfLink:
uid:
versions:
- name:
Operations
Create a ThirdPartyResource
Create a ThirdPartyResource
HTTP request
POST /apis/extensions/v1beta1/thirdpartyresources HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
"kind": "ThirdPartyResource",
"apiVersion": "extensions/v1beta1",
...
}
Curl request
$ curl -k \
-X POST \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
https://$ENDPOINT/apis/extensions/v1beta1/thirdpartyresources <<'EOF'
{
"kind": "ThirdPartyResource",
"apiVersion": "extensions/v1beta1",
...
}
EOF
HTTP body
Parameter | Schema |
---|---|
body | v1beta1.ThirdPartyResource |
Query parameters
Parameter | Description |
---|---|
pretty | If ‘true’, then the output is pretty printed. |
Responses
HTTP Code | Schema |
---|---|
200 OK | v1beta1.ThirdPartyResource |
401 Unauthorized |
Consumes
- */*
Produces
application/json
application/yaml
application/vnd.kubernetes.protobuf
Get a ThirdPartyResource
Read the specified ThirdPartyResource
HTTP request
GET /apis/extensions/v1beta1/thirdpartyresources/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/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. |
Responses
HTTP Code | Schema |
---|---|
200 OK | v1beta1.ThirdPartyResource |
401 Unauthorized |
Consumes
- */*
Produces
application/json
application/yaml
application/vnd.kubernetes.protobuf
Get all ThirdPartyResources
List or watch objects of kind ThirdPartyResource
HTTP request
GET /apis/extensions/v1beta1/thirdpartyresources HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/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. |
includeUninitialized | If true, partially initialized resources are included in the response. |
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. 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 | 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. |
Responses
HTTP Code | Schema |
---|---|
200 OK | v1beta1.ThirdPartyResourceList |
401 Unauthorized |
Consumes
- */*
Produces
application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch
Watch a ThirdPartyResource
Watch changes to an object of kind ThirdPartyResource
HTTP request
GET /apis/extensions/v1beta1/watch/thirdpartyresources/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/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. |
includeUninitialized | If true, partially initialized resources are included in the response. |
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. 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 | 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. |
Responses
HTTP Code | Schema |
---|---|
200 OK | v1.WatchEvent |
401 Unauthorized |
Consumes
- */*
Produces
application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch
Watch all ThirdPartyResources
Watch individual changes to a list of ThirdPartyResource
HTTP request
GET /apis/extensions/v1beta1/watch/thirdpartyresources HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/extensions/v1beta1/watch/thirdpartyresources
Query parameters
Parameter | Description |
---|---|
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized | If true, partially initialized resources are included in the response. |
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. 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 | 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. |
Responses
HTTP Code | Schema |
---|---|
200 OK | v1.WatchEvent |
401 Unauthorized |
Consumes
- */*
Produces
application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch
Update a ThirdPartyResource
Replace the specified ThirdPartyResource
HTTP request
PUT /apis/extensions/v1beta1/thirdpartyresources/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
"kind": "ThirdPartyResource",
"apiVersion": "extensions/v1beta1",
...
}
Curl request
$ curl -k \
-X PUT \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
https://$ENDPOINT/apis/extensions/v1beta1/thirdpartyresources/$NAME <<'EOF'
{
"kind": "ThirdPartyResource",
"apiVersion": "extensions/v1beta1",
...
}
EOF
HTTP body
Parameter | Schema |
---|---|
body | v1beta1.ThirdPartyResource |
Path parameters
Parameter | Description |
---|---|
name | name of the ThirdPartyResource |
Query parameters
Parameter | Description |
---|---|
pretty | If ‘true’, then the output is pretty printed. |
Responses
HTTP Code | Schema |
---|---|
200 OK | v1beta1.ThirdPartyResource |
401 Unauthorized |
Consumes
- */*
Produces
application/json
application/yaml
application/vnd.kubernetes.protobuf
Patch a ThirdPartyResource
Partially update the specified ThirdPartyResource
HTTP request
PATCH /apis/extensions/v1beta1/thirdpartyresources/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'
{
...
}
Curl request
$ curl -k \
-X PATCH \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json-patch+json' \
https://$ENDPOINT/apis/extensions/v1beta1/thirdpartyresources/$NAME <<'EOF'
{
...
}
EOF
HTTP body
Parameter | Schema |
---|---|
body | v1.Patch |
Path parameters
Parameter | Description |
---|---|
name | name of the ThirdPartyResource |
Query parameters
Parameter | Description |
---|---|
pretty | If ‘true’, then the output is pretty printed. |
Responses
HTTP Code | Schema |
---|---|
200 OK | v1beta1.ThirdPartyResource |
401 Unauthorized |
Consumes
application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json
Produces
application/json
application/yaml
application/vnd.kubernetes.protobuf
Delete a ThirdPartyResource
Delete a ThirdPartyResource
HTTP request
DELETE /apis/extensions/v1beta1/thirdpartyresources/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
...
}
Curl request
$ curl -k \
-X DELETE \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
https://$ENDPOINT/apis/extensions/v1beta1/thirdpartyresources/$NAME <<'EOF'
{
...
}
EOF
HTTP body
Parameter | Schema |
---|---|
body | v1.DeleteOptions |
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 | 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 | 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. |
Responses
HTTP Code | Schema |
---|---|
200 OK | v1.Status |
401 Unauthorized |
Consumes
- */*
Produces
application/json
application/yaml
application/vnd.kubernetes.protobuf
Delete all ThirdPartyResources
Delete collection of ThirdPartyResource
HTTP request
DELETE /apis/extensions/v1beta1/thirdpartyresources HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Curl request
$ curl -k \
-X DELETE \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/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. |
includeUninitialized | If true, partially initialized resources are included in the response. |
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. 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 | 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. |
Responses
HTTP Code | Schema |
---|---|
200 OK | v1.Status |
401 Unauthorized |
Consumes
- */*
Produces
application/json
application/yaml
application/vnd.kubernetes.protobuf