Nine Self Service API (v1alpha1)
Download OpenAPI specification:Download
The Nine Self Service API allows you to provision various services using a HTTP REST API. The API is based on Kubernetes, meaning existing tooling can be used to interact with it.
The API uses bearer tokens for authentication. You can get a token by creating an API Service Account using nctl:
nctl auth login <account name>
nctl create asa cicd
nctl get asa cicd --print-token
The token has to be sent with each request using the Authorization: Bearer <token>
HTTP header.
All the resources you can create reside in a namespace allocated for your Cockpit account. This means with all requests you will have to specify the namespace of the resource you are interacting with. The namespace equals to the account name that is displayed under Recently Used in Cockpit. The service account you previously created just has access to resources in the same namespace it resides in.
To verify that the token works as expected, you can try to issue the following
request using curl
. If you get the following reply, the authentication
works:
$ curl https://nineapis.ch/api/ -H "Authorization: Bearer <token>"
{
"kind": "APIVersions",
"versions": [
"v1"
],
...
}
Now that we are authenticated with the API, let's create a first resource with it. Note that a lot of resources that can be created on the API incur costs, so be careful when testing your integration. Here we create an object storage bucket, which by itself is free as long as no data is uploaded to it.
$ curl -X POST https://nineapis.ch/apis/storage.nine.ch/v1alpha1/namespaces/<your namespace>/buckets \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--request POST \
--data '{
"kind": "Bucket",
"apiVersion": "storage.nine.ch/v1alpha1",
"metadata": {
"name": "hello-api"
},
"spec": {
"forProvider": {
"encryption": true,
"location": "nine-es34"
}
}
}'
Besides using any HTTP client, the API can also be interacted with using the
command line tool
kubectl
. After
authenticating with nctl
you can simply access resources by their name.
$ kubectl get buckets.storage.nine.ch
NAME SYNCED READY AGE
hello-api True True 10m
After you create a resource using the API, how do you know it is ready? This
is where the status.conditions
field comes in. It represents the current
state of that resource. For example, when getting the status of a Bucket
it
might look something like this:
"status": {
"conditions": [
{
"lastTransitionTime": "2023-03-05T08:25:41Z",
"reason": "ReconcileSuccess",
"status": "True",
"type": "Synced"
},
{
"lastTransitionTime": "2023-03-05T08:25:41Z",
"reason": "Available",
"status": "True",
"type": "Ready"
}
]
}
For knowing whether a resource is ready to use, the relevant condition is the
one with type: Ready
. This one indicates whether the backend resource is
ready. The other important field within the condition is the reason
. The
following
reasons
exist:
- Available: The resource is available for use.
- Unavailable: The resource is currently unhealthy, making it temporarily unavailable.
- Creating: The resource is currently being created.
- Deleting The resource is currently being deleted.
For catching errors during the creation process, one should look for the type: Synced
.
There is a reason
field, same as with the ready status. Here we simply have
these reasons:
- ReconcileSuccess: The resource has at successfully reconciled at least once. Note that this does not mean it is ready to use.
- ReconcileError: The resource experienced an error during reconciliation. In
this case, have a look at the
message
field to tell you more about why it errored.
For resources which need credentials to access them after creation, there is a
system in place to automatically write those credentials to a normal Kubernetes
secret. For example, when creating a BucketUser
it generates an S3 access key
and secret which can then be used to authenticate against the object storage. As
a user you can simply tell the BucketUser
where to write those credentials by
using the spec.writeConnectionSecretToRef
field.
"spec": {
"writeConnectionSecretToRef": {
"name": "some-secret",
"namespace": "<your namespace>"
}
}
In this case, the credentials would end up in the secret a-secret
within your
organizations namespace.
The deletion protection feature helps prevent accidental deletion of the API resources listed in this documentation. This is an additional security measure intended to protect production applications and related data.
To prevent a resource from being deleted, you can add the
nine.ch/deletion-protection: "true"
annotation. As long as this annotation exists,
the resource can not be deleted. Please make sure you use "true"
to activate
this feature. For example, to protect your projects.management.nine.ch
named foo
,
you can use the following command:
kubectl annotate projects.management.nine.ch foo nine.ch/deletion-protection=true
To test if the annotation prevents an accidental deletion you can use the
--dry-run=server
option of kubectl
:
kubectl delete --dry-run=server projects.management.nine.ch foo
Error from server (Forbidden): admission webhook
"deletion-protection.nine-controllers.nine.ch" denied the request: preventing
deletion because of nine.ch/deletion-protection annotation
To disable the deletion protection, you can either remove the annotation
completely or use the value "false"
:
kubectl annotate --overwrite projects.management.nine.ch foo nine.ch/deletion-protection=false
An additional deletion test should confirm feature deactivation:
kubectl delete --dry-run=server projects.management.nine.ch foo
project.management.nine.ch "nine-staging-foo" deleted (server dry run)
Please note that using a value other than "true"
or "false"
will result in
an error when modifying the resource.
list objects of kind Application
Authorizations:
path Parameters
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
allowWatchBookmarks | boolean unique allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. |
continue | string unique 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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 unique A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | string unique A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | integer unique limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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 unique resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | string unique resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
sendInitialEvents | boolean unique
When
Defaults to true if |
timeoutSeconds | integer unique Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | boolean unique Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Responses
Response samples
- 200
{- "apiVersion": "string",
- "items": [
- {
- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "buildEnv": [
- {
- "name": "string",
- "value": "string"
}
], - "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}, - "dockerfileBuild": {
- "buildContext": "string",
- "dockerfilePath": "string",
- "enabled": true
}, - "git": {
- "auth": {
- "fromSecret": {
- "name": "string"
}, - "password": "string",
- "sshPrivateKey": "string",
- "username": "string"
}, - "revision": "string",
- "subPath": "string",
- "url": "string"
}, - "hosts": [
- "string"
], - "language": ""
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "atProvider": {
- "basicAuthSecret": {
- "name": "string"
}, - "cnameTarget": "string",
- "customHostsCertificateStatus": "string",
- "defaultHostsCertificateStatus": "string",
- "defaultURLs": [
- "string"
], - "hosts": [
- {
- "checkType": "string",
- "error": {
- "message": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "latestSuccess": "2019-08-24T14:15:22Z",
- "name": "string"
}
], - "latestBuild": "string",
- "latestRelease": "string",
- "referenceErrors": [
- {
- "kind": "string",
- "message": "string",
- "name": "string",
- "namespace": "string"
}
], - "replicas": 0,
- "size": "",
- "txtRecordContent": "string",
- "workerJobs": [
- {
- "name": "string",
- "size": ""
}
]
}, - "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
], - "kind": "string",
- "metadata": {
- "continue": "string",
- "remainingItemCount": 0,
- "resourceVersion": "string",
- "selfLink": "string"
}
}
create an Application
Authorizations:
path Parameters
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
dryRun | string unique When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | string unique fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string unique fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Request Body schema: required
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds |
object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta) ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | |
required | object An ApplicationSpec defines the desired state of an Application. |
object An ApplicationStatus represents the observed state of an Application. |
Responses
Request samples
- Payload
{- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "buildEnv": [
- {
- "name": "string",
- "value": "string"
}
], - "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}, - "dockerfileBuild": {
- "buildContext": "string",
- "dockerfilePath": "string",
- "enabled": true
}, - "git": {
- "auth": {
- "fromSecret": {
- "name": "string"
}, - "password": "string",
- "sshPrivateKey": "string",
- "username": "string"
}, - "revision": "string",
- "subPath": "string",
- "url": "string"
}, - "hosts": [
- "string"
], - "language": ""
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "atProvider": {
- "basicAuthSecret": {
- "name": "string"
}, - "cnameTarget": "string",
- "customHostsCertificateStatus": "string",
- "defaultHostsCertificateStatus": "string",
- "defaultURLs": [
- "string"
], - "hosts": [
- {
- "checkType": "string",
- "error": {
- "message": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "latestSuccess": "2019-08-24T14:15:22Z",
- "name": "string"
}
], - "latestBuild": "string",
- "latestRelease": "string",
- "referenceErrors": [
- {
- "kind": "string",
- "message": "string",
- "name": "string",
- "namespace": "string"
}
], - "replicas": 0,
- "size": "",
- "txtRecordContent": "string",
- "workerJobs": [
- {
- "name": "string",
- "size": ""
}
]
}, - "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
Response samples
- 200
- 201
- 202
{- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "buildEnv": [
- {
- "name": "string",
- "value": "string"
}
], - "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}, - "dockerfileBuild": {
- "buildContext": "string",
- "dockerfilePath": "string",
- "enabled": true
}, - "git": {
- "auth": {
- "fromSecret": {
- "name": "string"
}, - "password": "string",
- "sshPrivateKey": "string",
- "username": "string"
}, - "revision": "string",
- "subPath": "string",
- "url": "string"
}, - "hosts": [
- "string"
], - "language": ""
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "atProvider": {
- "basicAuthSecret": {
- "name": "string"
}, - "cnameTarget": "string",
- "customHostsCertificateStatus": "string",
- "defaultHostsCertificateStatus": "string",
- "defaultURLs": [
- "string"
], - "hosts": [
- {
- "checkType": "string",
- "error": {
- "message": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "latestSuccess": "2019-08-24T14:15:22Z",
- "name": "string"
}
], - "latestBuild": "string",
- "latestRelease": "string",
- "referenceErrors": [
- {
- "kind": "string",
- "message": "string",
- "name": "string",
- "namespace": "string"
}
], - "replicas": 0,
- "size": "",
- "txtRecordContent": "string",
- "workerJobs": [
- {
- "name": "string",
- "size": ""
}
]
}, - "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
delete collection of Application
Authorizations:
path Parameters
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
allowWatchBookmarks | boolean unique allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. |
continue | string unique 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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 unique A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | string unique A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | integer unique limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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 unique resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | string unique resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
sendInitialEvents | boolean unique
When
Defaults to true if |
timeoutSeconds | integer unique Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | boolean unique Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Responses
Response samples
- 200
{- "apiVersion": "string",
- "code": 0,
- "details": {
- "causes": [
- {
- "field": "string",
- "message": "string",
- "reason": "string"
}
], - "group": "string",
- "kind": "string",
- "name": "string",
- "retryAfterSeconds": 0,
- "uid": "string"
}, - "kind": "string",
- "message": "string",
- "metadata": {
- "continue": "string",
- "remainingItemCount": 0,
- "resourceVersion": "string",
- "selfLink": "string"
}, - "reason": "string",
- "status": "string"
}
read the specified Application
Authorizations:
path Parameters
name required | string unique name of the Application |
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
resourceVersion | string unique resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
Responses
Response samples
- 200
{- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "buildEnv": [
- {
- "name": "string",
- "value": "string"
}
], - "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}, - "dockerfileBuild": {
- "buildContext": "string",
- "dockerfilePath": "string",
- "enabled": true
}, - "git": {
- "auth": {
- "fromSecret": {
- "name": "string"
}, - "password": "string",
- "sshPrivateKey": "string",
- "username": "string"
}, - "revision": "string",
- "subPath": "string",
- "url": "string"
}, - "hosts": [
- "string"
], - "language": ""
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "atProvider": {
- "basicAuthSecret": {
- "name": "string"
}, - "cnameTarget": "string",
- "customHostsCertificateStatus": "string",
- "defaultHostsCertificateStatus": "string",
- "defaultURLs": [
- "string"
], - "hosts": [
- {
- "checkType": "string",
- "error": {
- "message": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "latestSuccess": "2019-08-24T14:15:22Z",
- "name": "string"
}
], - "latestBuild": "string",
- "latestRelease": "string",
- "referenceErrors": [
- {
- "kind": "string",
- "message": "string",
- "name": "string",
- "namespace": "string"
}
], - "replicas": 0,
- "size": "",
- "txtRecordContent": "string",
- "workerJobs": [
- {
- "name": "string",
- "size": ""
}
]
}, - "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
replace the specified Application
Authorizations:
path Parameters
name required | string unique name of the Application |
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
dryRun | string unique When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | string unique fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string unique fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Request Body schema: required
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds |
object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta) ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | |
required | object An ApplicationSpec defines the desired state of an Application. |
object An ApplicationStatus represents the observed state of an Application. |
Responses
Request samples
- Payload
{- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "buildEnv": [
- {
- "name": "string",
- "value": "string"
}
], - "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}, - "dockerfileBuild": {
- "buildContext": "string",
- "dockerfilePath": "string",
- "enabled": true
}, - "git": {
- "auth": {
- "fromSecret": {
- "name": "string"
}, - "password": "string",
- "sshPrivateKey": "string",
- "username": "string"
}, - "revision": "string",
- "subPath": "string",
- "url": "string"
}, - "hosts": [
- "string"
], - "language": ""
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "atProvider": {
- "basicAuthSecret": {
- "name": "string"
}, - "cnameTarget": "string",
- "customHostsCertificateStatus": "string",
- "defaultHostsCertificateStatus": "string",
- "defaultURLs": [
- "string"
], - "hosts": [
- {
- "checkType": "string",
- "error": {
- "message": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "latestSuccess": "2019-08-24T14:15:22Z",
- "name": "string"
}
], - "latestBuild": "string",
- "latestRelease": "string",
- "referenceErrors": [
- {
- "kind": "string",
- "message": "string",
- "name": "string",
- "namespace": "string"
}
], - "replicas": 0,
- "size": "",
- "txtRecordContent": "string",
- "workerJobs": [
- {
- "name": "string",
- "size": ""
}
]
}, - "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
Response samples
- 200
- 201
{- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "buildEnv": [
- {
- "name": "string",
- "value": "string"
}
], - "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}, - "dockerfileBuild": {
- "buildContext": "string",
- "dockerfilePath": "string",
- "enabled": true
}, - "git": {
- "auth": {
- "fromSecret": {
- "name": "string"
}, - "password": "string",
- "sshPrivateKey": "string",
- "username": "string"
}, - "revision": "string",
- "subPath": "string",
- "url": "string"
}, - "hosts": [
- "string"
], - "language": ""
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "atProvider": {
- "basicAuthSecret": {
- "name": "string"
}, - "cnameTarget": "string",
- "customHostsCertificateStatus": "string",
- "defaultHostsCertificateStatus": "string",
- "defaultURLs": [
- "string"
], - "hosts": [
- {
- "checkType": "string",
- "error": {
- "message": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "latestSuccess": "2019-08-24T14:15:22Z",
- "name": "string"
}
], - "latestBuild": "string",
- "latestRelease": "string",
- "referenceErrors": [
- {
- "kind": "string",
- "message": "string",
- "name": "string",
- "namespace": "string"
}
], - "replicas": 0,
- "size": "",
- "txtRecordContent": "string",
- "workerJobs": [
- {
- "name": "string",
- "size": ""
}
]
}, - "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
delete an Application
Authorizations:
path Parameters
name required | string unique name of the Application |
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
dryRun | string unique When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | integer unique 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 unique 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 unique 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. |
Request Body schema:
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/sig-architecture/api-conventions.md#resources |
dryRun | Array of strings When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | integer <int64> 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. |
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/sig-architecture/api-conventions.md#types-kinds |
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. |
object (io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions) Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out. | |
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. |
Responses
Request samples
- Payload
{- "apiVersion": "string",
- "dryRun": [
- "string"
], - "gracePeriodSeconds": 0,
- "kind": "string",
- "orphanDependents": true,
- "preconditions": {
- "resourceVersion": "string",
- "uid": "string"
}, - "propagationPolicy": "string"
}
Response samples
- 200
- 202
{- "apiVersion": "string",
- "code": 0,
- "details": {
- "causes": [
- {
- "field": "string",
- "message": "string",
- "reason": "string"
}
], - "group": "string",
- "kind": "string",
- "name": "string",
- "retryAfterSeconds": 0,
- "uid": "string"
}, - "kind": "string",
- "message": "string",
- "metadata": {
- "continue": "string",
- "remainingItemCount": 0,
- "resourceVersion": "string",
- "selfLink": "string"
}, - "reason": "string",
- "status": "string"
}
partially update the specified Application
Authorizations:
path Parameters
name required | string unique name of the Application |
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
dryRun | string unique When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | string unique fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
fieldValidation | string unique fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
force | boolean unique Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
Request Body schema: required
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
Responses
Request samples
- Payload
{ }
Response samples
- 200
{- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "buildEnv": [
- {
- "name": "string",
- "value": "string"
}
], - "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}, - "dockerfileBuild": {
- "buildContext": "string",
- "dockerfilePath": "string",
- "enabled": true
}, - "git": {
- "auth": {
- "fromSecret": {
- "name": "string"
}, - "password": "string",
- "sshPrivateKey": "string",
- "username": "string"
}, - "revision": "string",
- "subPath": "string",
- "url": "string"
}, - "hosts": [
- "string"
], - "language": ""
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "atProvider": {
- "basicAuthSecret": {
- "name": "string"
}, - "cnameTarget": "string",
- "customHostsCertificateStatus": "string",
- "defaultHostsCertificateStatus": "string",
- "defaultURLs": [
- "string"
], - "hosts": [
- {
- "checkType": "string",
- "error": {
- "message": "string",
- "timestamp": "2019-08-24T14:15:22Z"
}, - "latestSuccess": "2019-08-24T14:15:22Z",
- "name": "string"
}
], - "latestBuild": "string",
- "latestRelease": "string",
- "referenceErrors": [
- {
- "kind": "string",
- "message": "string",
- "name": "string",
- "namespace": "string"
}
], - "replicas": 0,
- "size": "",
- "txtRecordContent": "string",
- "workerJobs": [
- {
- "name": "string",
- "size": ""
}
]
}, - "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
list objects of kind Build
Authorizations:
path Parameters
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
allowWatchBookmarks | boolean unique allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. |
continue | string unique 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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 unique A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | string unique A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | integer unique limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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 unique resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | string unique resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
sendInitialEvents | boolean unique
When
Defaults to true if |
timeoutSeconds | integer unique Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | boolean unique Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Responses
Response samples
- 200
{- "apiVersion": "string",
- "items": [
- {
- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "buildReference": {
- "build": {
- "name": "string",
- "namespace": "string"
}, - "cluster": {
- "name": "string",
- "namespace": "string"
}
}, - "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}, - "env": [
- {
- "name": "string",
- "value": "string"
}
], - "image": {
- "digest": "string",
- "pullPolicy": "string",
- "pullSecret": "string",
- "registry": "string",
- "repository": "string",
- "tag": "string"
}, - "sourceConfig": {
- "git": {
- "revision": "string",
- "subPath": "string",
- "url": "string"
}
}
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "atProvider": {
- "buildMetadata": [
- {
- "homepage": "string",
- "id": "string",
- "version": "string"
}
], - "buildStatus": "string",
- "stack": "string",
- "stepsCompleted": [
- "string"
]
}, - "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
], - "kind": "string",
- "metadata": {
- "continue": "string",
- "remainingItemCount": 0,
- "resourceVersion": "string",
- "selfLink": "string"
}
}
create a Build
Authorizations:
path Parameters
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
dryRun | string unique When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | string unique fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string unique fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Request Body schema: required
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds |
object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta) ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | |
required | object A BuildSpec defines the desired state of an Build. |
object An BuildStatus represents the observed state of an Build. |
Responses
Request samples
- Payload
{- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "buildReference": {
- "build": {
- "name": "string",
- "namespace": "string"
}, - "cluster": {
- "name": "string",
- "namespace": "string"
}
}, - "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}, - "env": [
- {
- "name": "string",
- "value": "string"
}
], - "image": {
- "digest": "string",
- "pullPolicy": "string",
- "pullSecret": "string",
- "registry": "string",
- "repository": "string",
- "tag": "string"
}, - "sourceConfig": {
- "git": {
- "revision": "string",
- "subPath": "string",
- "url": "string"
}
}
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "atProvider": {
- "buildMetadata": [
- {
- "homepage": "string",
- "id": "string",
- "version": "string"
}
], - "buildStatus": "string",
- "stack": "string",
- "stepsCompleted": [
- "string"
]
}, - "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
Response samples
- 200
- 201
- 202
{- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "buildReference": {
- "build": {
- "name": "string",
- "namespace": "string"
}, - "cluster": {
- "name": "string",
- "namespace": "string"
}
}, - "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}, - "env": [
- {
- "name": "string",
- "value": "string"
}
], - "image": {
- "digest": "string",
- "pullPolicy": "string",
- "pullSecret": "string",
- "registry": "string",
- "repository": "string",
- "tag": "string"
}, - "sourceConfig": {
- "git": {
- "revision": "string",
- "subPath": "string",
- "url": "string"
}
}
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "atProvider": {
- "buildMetadata": [
- {
- "homepage": "string",
- "id": "string",
- "version": "string"
}
], - "buildStatus": "string",
- "stack": "string",
- "stepsCompleted": [
- "string"
]
}, - "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
delete collection of Build
Authorizations:
path Parameters
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
allowWatchBookmarks | boolean unique allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. |
continue | string unique 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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 unique A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | string unique A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | integer unique limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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 unique resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | string unique resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
sendInitialEvents | boolean unique
When
Defaults to true if |
timeoutSeconds | integer unique Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | boolean unique Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Responses
Response samples
- 200
{- "apiVersion": "string",
- "code": 0,
- "details": {
- "causes": [
- {
- "field": "string",
- "message": "string",
- "reason": "string"
}
], - "group": "string",
- "kind": "string",
- "name": "string",
- "retryAfterSeconds": 0,
- "uid": "string"
}, - "kind": "string",
- "message": "string",
- "metadata": {
- "continue": "string",
- "remainingItemCount": 0,
- "resourceVersion": "string",
- "selfLink": "string"
}, - "reason": "string",
- "status": "string"
}
read the specified Build
Authorizations:
path Parameters
name required | string unique name of the Build |
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
resourceVersion | string unique resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
Responses
Response samples
- 200
{- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "buildReference": {
- "build": {
- "name": "string",
- "namespace": "string"
}, - "cluster": {
- "name": "string",
- "namespace": "string"
}
}, - "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}, - "env": [
- {
- "name": "string",
- "value": "string"
}
], - "image": {
- "digest": "string",
- "pullPolicy": "string",
- "pullSecret": "string",
- "registry": "string",
- "repository": "string",
- "tag": "string"
}, - "sourceConfig": {
- "git": {
- "revision": "string",
- "subPath": "string",
- "url": "string"
}
}
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "atProvider": {
- "buildMetadata": [
- {
- "homepage": "string",
- "id": "string",
- "version": "string"
}
], - "buildStatus": "string",
- "stack": "string",
- "stepsCompleted": [
- "string"
]
}, - "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
replace the specified Build
Authorizations:
path Parameters
name required | string unique name of the Build |
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
dryRun | string unique When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | string unique fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string unique fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Request Body schema: required
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds |
object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta) ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | |
required | object A BuildSpec defines the desired state of an Build. |
object An BuildStatus represents the observed state of an Build. |
Responses
Request samples
- Payload
{- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "buildReference": {
- "build": {
- "name": "string",
- "namespace": "string"
}, - "cluster": {
- "name": "string",
- "namespace": "string"
}
}, - "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}, - "env": [
- {
- "name": "string",
- "value": "string"
}
], - "image": {
- "digest": "string",
- "pullPolicy": "string",
- "pullSecret": "string",
- "registry": "string",
- "repository": "string",
- "tag": "string"
}, - "sourceConfig": {
- "git": {
- "revision": "string",
- "subPath": "string",
- "url": "string"
}
}
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "atProvider": {
- "buildMetadata": [
- {
- "homepage": "string",
- "id": "string",
- "version": "string"
}
], - "buildStatus": "string",
- "stack": "string",
- "stepsCompleted": [
- "string"
]
}, - "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
Response samples
- 200
- 201
{- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "buildReference": {
- "build": {
- "name": "string",
- "namespace": "string"
}, - "cluster": {
- "name": "string",
- "namespace": "string"
}
}, - "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}, - "env": [
- {
- "name": "string",
- "value": "string"
}
], - "image": {
- "digest": "string",
- "pullPolicy": "string",
- "pullSecret": "string",
- "registry": "string",
- "repository": "string",
- "tag": "string"
}, - "sourceConfig": {
- "git": {
- "revision": "string",
- "subPath": "string",
- "url": "string"
}
}
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "atProvider": {
- "buildMetadata": [
- {
- "homepage": "string",
- "id": "string",
- "version": "string"
}
], - "buildStatus": "string",
- "stack": "string",
- "stepsCompleted": [
- "string"
]
}, - "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
delete a Build
Authorizations:
path Parameters
name required | string unique name of the Build |
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
dryRun | string unique When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | integer unique 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 unique 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 unique 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. |
Request Body schema:
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/sig-architecture/api-conventions.md#resources |
dryRun | Array of strings When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | integer <int64> 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. |
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/sig-architecture/api-conventions.md#types-kinds |
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. |
object (io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions) Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out. | |
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. |
Responses
Request samples
- Payload
{- "apiVersion": "string",
- "dryRun": [
- "string"
], - "gracePeriodSeconds": 0,
- "kind": "string",
- "orphanDependents": true,
- "preconditions": {
- "resourceVersion": "string",
- "uid": "string"
}, - "propagationPolicy": "string"
}
Response samples
- 200
- 202
{- "apiVersion": "string",
- "code": 0,
- "details": {
- "causes": [
- {
- "field": "string",
- "message": "string",
- "reason": "string"
}
], - "group": "string",
- "kind": "string",
- "name": "string",
- "retryAfterSeconds": 0,
- "uid": "string"
}, - "kind": "string",
- "message": "string",
- "metadata": {
- "continue": "string",
- "remainingItemCount": 0,
- "resourceVersion": "string",
- "selfLink": "string"
}, - "reason": "string",
- "status": "string"
}
partially update the specified Build
Authorizations:
path Parameters
name required | string unique name of the Build |
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
dryRun | string unique When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | string unique fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
fieldValidation | string unique fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
force | boolean unique Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
Request Body schema: required
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
Responses
Request samples
- Payload
{ }
Response samples
- 200
{- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "buildReference": {
- "build": {
- "name": "string",
- "namespace": "string"
}, - "cluster": {
- "name": "string",
- "namespace": "string"
}
}, - "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}, - "env": [
- {
- "name": "string",
- "value": "string"
}
], - "image": {
- "digest": "string",
- "pullPolicy": "string",
- "pullSecret": "string",
- "registry": "string",
- "repository": "string",
- "tag": "string"
}, - "sourceConfig": {
- "git": {
- "revision": "string",
- "subPath": "string",
- "url": "string"
}
}
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "atProvider": {
- "buildMetadata": [
- {
- "homepage": "string",
- "id": "string",
- "version": "string"
}
], - "buildStatus": "string",
- "stack": "string",
- "stepsCompleted": [
- "string"
]
}, - "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
list objects of kind ProjectConfig
Authorizations:
path Parameters
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
allowWatchBookmarks | boolean unique allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. |
continue | string unique 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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 unique A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | string unique A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | integer unique limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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 unique resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | string unique resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
sendInitialEvents | boolean unique
When
Defaults to true if |
timeoutSeconds | integer unique Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | boolean unique Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Responses
Response samples
- 200
{- "apiVersion": "string",
- "items": [
- {
- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
], - "kind": "string",
- "metadata": {
- "continue": "string",
- "remainingItemCount": 0,
- "resourceVersion": "string",
- "selfLink": "string"
}
}
create a ProjectConfig
Authorizations:
path Parameters
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
dryRun | string unique When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | string unique fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string unique fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Request Body schema: required
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds |
object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta) ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | |
required | object An ProjectConfigSpec defines the desired state of a ProjectConfig. |
object An ProjectConfigStatus represents the observed state of a ProjectConfig. |
Responses
Request samples
- Payload
{- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
Response samples
- 200
- 201
- 202
{- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
delete collection of ProjectConfig
Authorizations:
path Parameters
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
allowWatchBookmarks | boolean unique allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. |
continue | string unique 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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 unique A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | string unique A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | integer unique limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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 unique resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | string unique resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
sendInitialEvents | boolean unique
When
Defaults to true if |
timeoutSeconds | integer unique Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | boolean unique Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Responses
Response samples
- 200
{- "apiVersion": "string",
- "code": 0,
- "details": {
- "causes": [
- {
- "field": "string",
- "message": "string",
- "reason": "string"
}
], - "group": "string",
- "kind": "string",
- "name": "string",
- "retryAfterSeconds": 0,
- "uid": "string"
}, - "kind": "string",
- "message": "string",
- "metadata": {
- "continue": "string",
- "remainingItemCount": 0,
- "resourceVersion": "string",
- "selfLink": "string"
}, - "reason": "string",
- "status": "string"
}
read the specified ProjectConfig
Authorizations:
path Parameters
name required | string unique name of the ProjectConfig |
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
resourceVersion | string unique resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
Responses
Response samples
- 200
{- "apiVersion": "string",
- "kind": "string",
- "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "creationTimestamp": "2019-08-24T14:15:22Z",
- "deletionGracePeriodSeconds": 0,
- "deletionTimestamp": "2019-08-24T14:15:22Z",
- "finalizers": [
- "string"
], - "generateName": "string",
- "generation": 0,
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "managedFields": [
- {
- "apiVersion": "string",
- "fieldsType": "string",
- "fieldsV1": { },
- "manager": "string",
- "operation": "string",
- "subresource": "string",
- "time": "2019-08-24T14:15:22Z"
}
], - "name": "string",
- "namespace": "string",
- "ownerReferences": [
- {
- "apiVersion": "string",
- "blockOwnerDeletion": true,
- "controller": true,
- "kind": "string",
- "name": "string",
- "uid": "string"
}
], - "resourceVersion": "string",
- "selfLink": "string",
- "uid": "string"
}, - "spec": {
- "deletionPolicy": "Orphan",
- "forProvider": {
- "config": {
- "deployJob": { },
- "enableBasicAuth": null,
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "port": null,
- "replicas": null,
- "size": "",
- "workerJobs": null
}
}, - "managementPolicies": [
- "Observe"
], - "providerConfigRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "publishConnectionDetailsTo": {
- "configRef": {
- "name": "string",
- "policy": {
- "resolution": "Required",
- "resolve": "Always"
}
}, - "metadata": {
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "labels": {
- "property1": "string",
- "property2": "string"
}, - "type": "string"
}, - "name": "string"
}, - "writeConnectionSecretToRef": {
- "name": "string",
- "namespace": "string"
}
}, - "status": {
- "conditions": [
- {
- "lastTransitionTime": "2019-08-24T14:15:22Z",
- "message": "string",
- "observedGeneration": 0,
- "reason": "string",
- "status": "string",
- "type": "string"
}
], - "observedGeneration": 0
}
}
replace the specified ProjectConfig
Authorizations:
path Parameters
name required | string unique name of the ProjectConfig |
namespace required | string unique object name and auth scope, such as for teams and projects |
query Parameters
pretty | string unique If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
dryRun | string unique When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | string unique fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string unique fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Request Body schema: required
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds |
object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta) ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | |
required | object An ProjectConfigSpec defines the desired state of a ProjectConfig. |