Cloud Foundry foundations credentials API - PUT credentials

Updates the credentials of the specified Cloud Foundry foundation.

The request consumes and produces an application/json payload.

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

Parameters

Parameter Type Description In Required
id string

The ID of the Cloud Foundry foundation credentials.

path required
body CloudFoundryCredentials

name must be unique. password can be omitted for updates, the existing one will be used. apiUrl and loginUrl must be set and may not differ from the existing config if it exists. Use this endpoint for copying credentials between environments while keeping their IDs and for updating existing credentials. You can not use this to create new credentials with an arbitrary ID, use POST instead.

body optional

The CloudFoundryCredentials object

Configuration for specific Cloud Foundry credentials.

Element Type Description Required
metadata ConfigurationMetadata

Metadata of the given credentials configuration which is useful for debugging.

optional
id string

The ID of the given credentials configuration.

optional
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 is used.

optional
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 endpointStatus element can hold these values.
optional
endpointStatusInfo string

The detailed status info of the configured endpoint.

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

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

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

optional
username string

The username of the Cloud Foundry foundation credentials.

Leading and trailing whitespaces are not allowed.

required
password string

The password of the Cloud Foundry foundation credentials.

optional

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description Required
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

optional
clusterVersion string

Dynatrace server version.

optional

Possible values

Possible values for the endpointStatus element in the CloudFoundryCredentials object:

  • ASSIGNED
  • DISABLED
  • FASTCHECK_AUTH_ERROR
  • FASTCHECK_AUTH_LOCKED
  • FASTCHECK_INVALID_ENDPOINT
  • FASTCHECK_NO_RESPONSE
  • FASTCHECK_TLS_ERROR
  • UNASSIGNED
  • UNKNOWN

Response format

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the Dynatrace entity.

Response codes

Code Description
201

Success. Cloud Foundry foundation credentials have been created. The ID and name of the new credentials are returned.

204

Success. Cloud Foundry foundation credentials have been successfully updated.

400

Failed. The input is invalid.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/cloudFoundry/credentials/{id}/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/cloudFoundry/credentials/{id}/validator

Response codes

Code Description
204 Validated. The submitted credentials are valid. Response does not have a body.
400 Failed. The input is invalid.