Kubernetes credentials API - GET credentials

Gets the configuration of the specified Kubernetes credentials.

The request produces an application/json payload.

This request is an early adopter release and may be changed in non compatible way.

GET
  • 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}

Parameters

Parameter Type Description In Required
id string

The ID of the required Kubernetes credentials configuration.

path required

Response format

The KubernetesCredentials object

Configuration of a Kubernetes credentials.

Element Type Description
metadata ConfigurationMetadata

Metadata useful for debugging.

id string

The ID of the Kubernetes credentials configuration.

label string

The name of the Kubernetes credentials configuration.

Allowed characters are letters, numbers, whitespaces, and the following characters: .+-_. Leading or trailing whitespace is not allowed.

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.

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 null.

If the field is omitted during an update, the old value is used.

active boolean

The monitoring is enabled (true) or disabled (false) for the Kubernetes cluster.

If not set on creation, the true value is used.

If the field is omitted during an update, the old value is used.

endpointStatus string

The status of the Kubernetes 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. UNKNOWN: An unknown error occured.

endpointStatusInfo string

The detailed status info of the Kubernetes endpoint.

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

clusterVersion string

Dynatrace server version.