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.

This request is an early adopter release and may be changed in non compatible way.

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

Element Type Description Required
metadata ConfigurationMetadata

Metadata useful for debugging.

optional
id string

The ID of the Cloud Foundry foundation credentials.

optional
name string

The name of the Cloud Foundry foundation credentials.

required
apiUrl string

The URL of the Cloud Foundry foundation credentials.

optional
loginUrl string

The login URL of the Cloud Foundry foundation credentials.

optional
username string

The username of the Cloud Foundry foundation credentials.

required
password string

The password of the Cloud Foundry foundation credentials.

optional
active boolean

Whether Cloud Foundry API polling is enabled for this foundation. If set to false, Dynatrace will stop polling the Cloud Foundry API. Default value is true. If the field is omitted during an update, the old value is used.

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

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.

This request is an early adopter release and may be changed in non compatible way.

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.