Cloud Foundry foundations credentials API - GET credentials

Gets parameters of the credentials of the specified Cloud Foundry foundation.

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/cloudFoundry/credentials/{id} SaaS https://{your-environment-id}.live.dexp.ae/api/config/v1/cloudFoundry/credentials/{id}

Authentication

To execute this request, you need the Read configuration permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

Parameter	Type	Description	In	Required
id	string	The ID of the required Cloud Foundry foundation credentials.	path	required

Response format

Response parameters JSON model

The CloudFoundryCredentials object

Element	Type	Description
metadata	ConfigurationMetadata	Metadata useful for debugging.
id	string	The ID of the Cloud Foundry foundation credentials.
name	string	The name of the Cloud Foundry foundation credentials. Allowed characters are letters, numbers, whitespaces, and the following characters: `.+-_`. Leading or trailing whitespaces are 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.
active	boolean	Whether Cloud Foundry API polling is enabled for this foundation. If set to `false`, DESK will stop polling the Cloud Foundry API. Default value is `true`. If the field is omitted during an update, the old value is used.

The ConfigurationMetadata object

Metadata useful for debugging

Element	Type	Description
configurationVersions	integer[]	A Sorted list of the version numbers of the configuration.
clusterVersion	string	DESK server version.

    
{
  "metadata": {
    "configurationVersions": [
      "integer"
    ],
    "clusterVersion": "string"
  },
  "id": "string",
  "name": "string",
  "apiUrl": "string",
  "loginUrl": "string",
  "username": "string",
  "password": "string",
  "active": true
}