Cloud Foundry credentials API - POST credentials

Creates a new credentials configuration.

The request consumes and produces an application/json payload.

Early Adopter

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
SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/cloudFoundry/credentials
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/cloudFoundry/credentials

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
body	CloudFoundryCredentials	`name`, `apiUrl` and `loginUrl` must be unique.	body	optional

Body format

Request parametersJSON model

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

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

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

Response

Response codes

Code	Description
201	Success. Cloud Foundry foundation credentials have been created. The ID and name of the new credentials are returned.
400	Failed. The input is invalid.

Response body

Response parametersJSON model

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.

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

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.

Early Adopter

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/validator
SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/cloudFoundry/credentials/validator
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/cloudFoundry/credentials/validator

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

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

Response body

A successful request doesn't return any content.