This API is deprecated. Use the Settings API with the Kubernetes connection settings (builtin:cloud.kubernetes) and the Kubernetes platform monitoring settings (builtin:cloud.kubernetes.monitoring) schemas instead.
Creates a new Kubernetes credentials configuration.
The body must not provide an ID. The Dynatrace server automatically assigns an ID.
The request consumes and produces an application/json payload.
| POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/kubernetes/credentials |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/kubernetes/credentials |
To execute this request, you need an access token with WriteConfig scope.
To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | Kubernetes | The JSON body of the request. Contains parameters of the new Kubernetes credentials configuration. | body | optional |
KubernetesCredentials objectConfiguration for specific Kubernetes credentials.
| Element | Type | Description | Required |
|---|---|---|---|
| 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 |
| activeGateGroup | string | Active Gate group to filter active gates for this credentials. | optional |
| 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 |
| 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 |
| davisEventsIntegrationEnabled | boolean | Inclusion of all Davis relevant events is enabled ( | 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 |
| 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 |
| eventAnalysisAndAlertingEnabled | boolean | [Deprecated] With 1.240 the EA events monitoring has been deprecated and replaced by the events GA version which obsoletes this property. Corresponds to the value of The field is ignored during an update, the old value remains unaffected. | optional |
| eventsFieldSelectors | Kubernetes | Kubernetes event filters based on field-selectors. If set to | 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 |
| id | string | The ID of the given credentials configuration. | optional |
| label | string | The name of the Kubernetes credentials configuration. Allowed characters are letters, numbers, whitespaces, and the following characters: | required |
| metadata | Configuration | Metadata useful for debugging | optional |
| prometheusExportersIntegrationEnabled | boolean | Prometheus exporters integration is enabled ( | optional |
| workloadIntegrationEnabled | boolean | Workload and cloud application processing is enabled ( | optional |
KubernetesEventPattern objectRepresents a single Kubernetes events field selector (=event filter based on the K8s field selector).
| Element | Type | Description | Required |
|---|---|---|---|
| active | boolean | Whether subscription to this events field selector is enabled (value set to | required |
| fieldSelector | string | The field selector string (url decoding is applied) when storing it. | required |
| label | string | A label of the events field selector. | required |
ConfigurationMetadata objectMetadata useful for debugging
| Element | Type | Description | Required |
|---|---|---|---|
| clusterVersion | string | Dynatrace version. | optional |
| 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 |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"active": true,"activeGateGroup": "group-1","authToken": "abcd9876","certificateCheckEnabled": true,"davisEventsIntegrationEnabled": true,"endpointUrl": "https://k8s-api.sample.org","eventAnalysisAndAlertingEnabled": true,"eventsFieldSelectors": [{"active": true,"fieldSelector": "involvedObject.kind=Node","label": "Node events"}],"eventsIntegrationEnabled": true,"hostnameVerificationEnabled": true,"id": "KUBERNETES_CLUSTER-CC06304728FC9396","label": "K8s credentials - REST example","prometheusExportersIntegrationEnabled": true,"workloadIntegrationEnabled": true}
| Code | Type | Description |
|---|---|---|
| 201 | Entity | Success. The new Kubernetes credentials configuration has been created. The response body contains the ID of the configuration. |
| 400 | Error | Failed. The input is invalid. |
EntityShortRepresentation objectThe short representation of a Dynatrace entity.
| Element | Type | Description |
|---|---|---|
| description | string | A short description of the Dynatrace entity. |
| id | string | The ID of the Dynatrace entity. |
| name | string | The name of the Dynatrace entity. |
{"description": "Dynatrace entity for the REST API example","id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a","name": "Dynatrace entity"}
We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.
The request consumes an application/json payload.
| POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/kubernetes/credentials/validator |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/kubernetes/credentials/validator |
To execute this request, you need an access token with WriteConfig scope.
To learn how to obtain and use it, see Tokens and authentication.
| Code | Type | Description |
|---|---|---|
| 204 | - | Validated. The submitted configuration is valid. The response doesn't have a body. |
| 400 | Error | Failed. The input is invalid. |