Migrate from Cloud Foundry credentials API to Settings API
The Cloud Foundry credentials API has been deprecated with Dynatrace version 1.288. It is replaced by the Settings API and the Cloud Foundry schema (builtin:cloud.cloudfoundry). We recommend that you migrate to the new API at your earliest convenience.
The migration affects endpoint URLs, query parameters, and response/request body parameters, as well as the scope of the token for the request.
Base URL
| new Settings 2.0 | old Cloud Foundry credentials |
|---|---|
/api/v2/settings | /api/config/v1/cloudFoundry/credentials |
Authentication token scope
| new Settings 2.0 | old Cloud Foundry credentials |
|---|---|
Read settings (settings.read)Write settings ( settings.write) | Read configuration (ReadConfig)Write configuration ( WriteConfig) |
Parameters
To learn about new query/body parameters, see the documentation of individual requests in the Settings API.
In the Settings 2.0 framework, each Cloud Foundry connection is represented by a settings object. An object contains some metadata (like the scope or creation timestamp) and the configuration itself, encapsulated in the value object. To learn about the parameters of a Cloud Foundry connection, query the Cloud Foundry schema (builtin:cloud.cloudfoundry) with the GET a schema request. The configuration differs from the Cloud Foundry credentials API – check the examples below to see the differences.
Examples
Here are some examples of differences in API usage.
List all Cloud Foundry connection settings
Details for a specific Cloud Foundry connection
Validate creation of a Cloud Foundry connection
In this example, we validate if the request for creating a new Cloud Foundry connection would be successful.
Create a Cloud Foundry connection
In this example, we create a Cloud Foundry connection.
Edit a Cloud Foundry connection
In this example, we modify the Cloud Foundry connection created in the previous example. We change the username to foundation-admin.
Delete a Cloud Foundry connection
In this example, we delete the previously created Cloud Foundry connection again.