Kubernetes credentials API - DELETE credentials
Deletes the specified Kubernetes credentials configuration. Deletion can't be undone.
This request is an Early Adopter release and may be changed in non-compatible way.
| DELETE | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/kubernetes/credentials/{id} |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/kubernetes/credentials/{id} | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/kubernetes/credentials/{id} |
Authentication
To execute this request, you need Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| id | string | The ID of the required Kubernetes credentials configuration. | path | optional |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Kubernetes | Success |
Response body objects
The KubernetesCredentials object
Configuration for specific Kubernetes credentials.
| Element | Type | Description | Required |
|---|---|---|---|
| metadata | Configuration | Metadata useful for debugging | optional |
| id | string | The ID of the given credentials configuration. | optional |
| active | boolean | The monitoring is enabled ( If not set on creation, the If the field is omitted during an update, the old value remains unaffected. | optional |
| endpointStatus | string | The status of the configured endpoint. ASSIGNED: The credentials are assigned to an ActiveGate which is responsible for processing. UNASSIGNED: The credentials are not yet assigned to an ActiveGate so there is currently no processing. DISABLED: The credentials have been disabled by the user. FASTCHECK_AUTH_ERROR: The credentials are invalid. FASTCHECK_TLS_ERROR: The endpoint TLS certificate is invalid. FASTCHECK_NO_RESPONSE: The endpoint did not return a result until the timeout was reached. FASTCHECK_INVALID_ENDPOINT: The endpoint URL was invalid. FASTCHECK_AUTH_LOCKED: The credentials seem to be locked. UNKNOWN: An unknown error occured. | optional |
| endpointStatusInfo | string | The detailed status info of the configured endpoint. | optional |
| label | string | The name of the Kubernetes credentials configuration. Allowed characters are letters, numbers, whitespaces, and the following characters: | required |
| endpointUrl | string | The URL of the Kubernetes API server. It must be unique within a Dynatrace environment. The URL must valid according to RFC 2396. Leading or trailing whitespaces are not allowed. | required |
| authToken | string | The service account bearer token for the Kubernetes API server. Submit your token on creation or update of the configuration. For security reasons, GET requests return this field as If the field is omitted during an update, the old value remains unaffected. | optional |
| activeGateGroup | string | Active Gate group to filter active gates for this credentials. | optional |
| eventsIntegrationEnabled | boolean | The monitoring of events is enabled ( If not set on creation, the If the field is omitted during an update, the old value remains unaffected. | optional |
| eventAnalysisAndAlertingEnabled | boolean | Event analysis and alerting is ( | optional |
| workloadIntegrationEnabled | boolean | Workload and cloud application processing is enabled ( | optional |
| prometheusExportersIntegrationEnabled | boolean | Prometheus exporters integration is enabled ( | optional |
| davisEventsIntegrationEnabled | boolean | Inclusion of all Davis relevant events is enabled ( | optional |
| eventsFieldSelectors | Kubernetes | Kubernetes event filters based on field-selectors. If set to | optional |
| certificateCheckEnabled | boolean | The check of SSL certificates is enabled ( If not set on creation, the If the field is omitted during an update, the old value remains unaffected. | optional |
The ConfigurationMetadata object
Metadata useful for debugging
| Element | Type | Description | Required |
|---|---|---|---|
| configurationVersions | integer[] | A sorted list of the version numbers of the configuration. | optional |
| currentConfigurationVersions | string[] | A sorted list of version numbers of the configuration. | optional |
| clusterVersion | string | Dynatrace version. | optional |
The KubernetesEventPattern object
Represents a single Kubernetes events field selector (=event filter based on the K8s field selector).
| Element | Type | Description | Required |
|---|---|---|---|
| label | string | A label of the events field selector. | required |
| fieldSelector | string | The field selector string (url decoding is applied) when storing it. | required |
| active | boolean | Whether subscription to this events field selector is enabled (value set to | required |
Response body JSON model
{
"id": "KUBERNETES_CLUSTER-CC06304728FC9396",
"label": "K8s credentials - REST example",
"endpointUrl": "https://k8s-api.sample.org",
"eventsFieldSelectors": [
{
"label": "Node events",
"fieldSelector": "involvedObject.kind=Node",
"active": true
}
],
"workloadIntegrationEnabled": true,
"eventsIntegrationEnabled": true,
"authToken": "abcd9876",
"activeGateGroup": "group-1",
"active": true,
"certificateCheckEnabled": true,
"hostnameVerificationEnabled": true,
"prometheusExportersIntegrationEnabled": true,
"davisEventsIntegrationEnabled": true
}