Cloud Foundry credentials API - PUT credentials

This API is deprecated. Use the Settings API with the Cloud Foundry (builtin:cloud.cloudfoundry) schema instead.

Updates the specified Cloud Foundry credentials configuration.

The request consumes and produces an application/json payload.

PUTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/cloudFoundry/credentials/{id}
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/cloudFoundry/credentials/{id}

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter
Type
Description
In
Required
id
string

The ID of the Cloud Foundry foundation credentials.

path
required
body

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
required

Request body objects

The CloudFoundryCredentials object

Configuration for specific Cloud Foundry credentials.

Element
Type
Description
Required
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 remains unaffected.

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

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

  • ASSIGNED
  • DISABLED
  • FASTCHECK_AUTH_ERROR
  • FASTCHECK_AUTH_LOCKED
  • FASTCHECK_INVALID_ENDPOINT
  • FASTCHECK_LOW_MEMORY_ERROR
  • FASTCHECK_MISCONFIGURED_AWS_ROLE
  • FASTCHECK_MISSING_AWS_ROLE
  • FASTCHECK_NO_RESPONSE
  • FASTCHECK_TLS_ERROR
  • FASTCHECK_TOO_BIG_ENVIRONMENT
  • FASTCHECK_TOO_MANY_SUBSCRIPTIONS
  • UNASSIGNED
  • UNKNOWN
optional
endpointStatusInfo
string

The detailed status info of the configured endpoint.

optional
id
string

The ID of the given credentials configuration.

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.

required
metadata

Metadata useful for debugging

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
password
string

The password of the Cloud Foundry foundation credentials.

optional
username
string

The username of the Cloud Foundry foundation credentials.

Leading and trailing whitespaces are not allowed.

required

The ConfigurationMetadata object

Metadata useful for debugging

Element
Type
Description
Required
clusterVersion
string

Dynatrace version.

optional
configurationVersions
integer[]

A sorted list of the version numbers of the configuration.

optional
currentConfigurationVersions
string[]

A sorted list of version numbers of the configuration.

optional

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "active": true,
  "apiUrl": "string",
  "endpointStatus": "ASSIGNED",
  "endpointStatusInfo": "string",
  "id": "string",
  "loginUrl": "string",
  "metadata": {
    "clusterVersion": "1.192.1",
    "configurationVersions": [
      4,
      2
    ],
    "currentConfigurationVersions": [
      "1.0.4",
      "1.23"
    ]
  },
  "name": "string",
  "password": "string",
  "username": "string"
}

Response

Response codes

Code
Type
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

Response body objects

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element
Type
Description
description
string

A short description of the Dynatrace entity.

id
string

The ID of the Dynatrace entity.

name
string

The name of the Dynatrace entity.

Response body JSON model

{
  "description": "Dynatrace entity for the REST API example",
  "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
  "name": "Dynatrace entity"
}

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.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/cloudFoundry/credentials/{id}/validator
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/cloudFoundry/credentials/{id}/validator

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

Code
Type
Description
204
-

Validated. The submitted credentials are valid. Response does not have a body.

400

Failed. The input is invalid.

Related topics