Cloud Foundry credentials API - GET credentials

Gets parameters of the specified credentials configuration.

The request produces an application/json payload.

Early Adopter

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/cloudFoundry/credentials/{id}
SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/cloudFoundry/credentials/{id}
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/cloudFoundry/credentials/{id}

Authentication

To execute this request, you need the Read configuration (ReadConfig) 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 Cloud Foundry foundation credentials.	path	required

Response

Response codes

Code	Description
200	Success

Response body

Response parametersJSON model

The CloudFoundryCredentials object

Configuration for specific Cloud Foundry credentials.

Element	Type	Description
metadata	ConfigurationMetadata
id	string	The ID of the given credentials configuration.
active	boolean	The monitoring is enabled (`true`) or disabled (`false`) for given credentials configuration. If not set on creation, the `true` value is used. If the field is omitted during an update, the old value remains unaffected.
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. The element can hold these values ASSIGNED DISABLED FASTCHECK_AUTH_ERROR FASTCHECK_AUTH_LOCKED FASTCHECK_INVALID_ENDPOINT FASTCHECK_LOW_MEMORY_ERROR FASTCHECK_NO_RESPONSE FASTCHECK_TLS_ERROR UNASSIGNED UNKNOWN
endpointStatusInfo	string	The detailed status info of the configured endpoint.
name	string	The name of the Cloud Foundry foundation credentials. Allowed characters are letters, numbers, whitespaces, and the following characters: `.+-_`. Leading or trailing whitespace is not allowed.
apiUrl	string	The URL of the Cloud Foundry foundation credentials. The URL must be valid according to RFC 2396. Leading or trailing whitespaces are not allowed.
loginUrl	string	The login URL of the Cloud Foundry foundation credentials. The URL must be valid according to RFC 2396. Leading or trailing whitespaces are not allowed.
username	string	The username of the Cloud Foundry foundation credentials. Leading and trailing whitespaces are not allowed.
password	string	The password of the Cloud Foundry foundation credentials.

The ConfigurationMetadata object

Metadata useful for debugging

Element	Type	Description
configurationVersions	integer[]	A sorted list of the version numbers of the configuration.
currentConfigurationVersions	string[]	A sorted list of version numbers of the configuration.
clusterVersion	string	Dynatrace version.

    {
  "metadata": {
    "configurationVersions": [
      4,
      2
    ],
    "currentConfigurationVersions": [
      "1.0.4",
      "1.23"
    ],
    "clusterVersion": "1.192.1"
  },
  "id": "string",
  "active": true,
  "endpointStatus": "ASSIGNED",
  "endpointStatusInfo": "string",
  "name": "string",
  "apiUrl": "string",
  "loginUrl": "string",
  "username": "string",
  "password": "string"
}