Cloud Foundry credentials API - GET credentials

Reference
Published Aug 29, 2019

This API is deprecated. Use the Settings API with the Cloud Foundry (builtin:cloud.cloudfoundry) schema instead.

Gets parameters of the specified credentials configuration.

The request produces an application/json payload.

GET	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/cloudFoundry/credentials/{id}`
GET	Environment ActiveGate	`https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/cloudFoundry/credentials/{id}`

Authentication

To execute this request, you need an access token with ReadConfig scope.

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	Type	Description
200	CloudFoundryCredentials	Success

Response body objects

The `CloudFoundryCredentials` object

Configuration for specific Cloud Foundry credentials.

Element	Type	Description
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.
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.
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. `ASSIGNED` `DISABLED` `FASTCHECK_AUTH_ERROR` `FASTCHECK_AUTH_LOCKED` `FASTCHECK_INVALID_ENDPOINT` `FASTCHECK_LOW_MEMORY_ERROR` `FASTCHECK_MISCONFIGURED_AWS_ROLE` `FASTCHECK_MISSING_AWS_ROLE` `FASTCHECK_NO_RESPONSE` `FASTCHECK_TLS_ERROR` `FASTCHECK_TOO_BIG_ENVIRONMENT` `FASTCHECK_TOO_MANY_SUBSCRIPTIONS` `UNASSIGNED` `UNKNOWN`
endpointStatusInfo	string	The detailed status info of the configured endpoint.
id	string	The ID of the given credentials configuration.
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.
metadata	ConfigurationMetadata	Metadata useful for debugging
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.
password	string	The password of the Cloud Foundry foundation credentials.
username	string	The username of the Cloud Foundry foundation credentials. Leading and trailing whitespaces are not allowed.

The `ConfigurationMetadata` object

Metadata useful for debugging

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

Response body JSON model

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

Set up Dynatrace on Cloud Foundry