Cloud Foundry credentials API - GET credentials
Gets parameters of the specified credentials configuration.
The request produces an application/json
payload.
This request is an Early Adopter release and may be changed in non-compatible way.
GET |
|
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
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 ( If not set on creation, the 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. |
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: |
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 string version numbers of the configuration. |
clusterVersion | string | Dynatrace server version. |
{
"metadata": {
"configurationVersions": [
"integer"
],
"currentConfigurationVersions": [
"string"
],
"clusterVersion": "1.192.1"
},
"id": "string",
"active": true,
"endpointStatus": "ASSIGNED",
"endpointStatusInfo": "string",
"name": "string",
"apiUrl": "string",
"loginUrl": "string",
"username": "string",
"password": "string"
}