Cloud Foundry credentials API - POST credentials
Creates a new credentials configuration.
The request consumes and produces 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 |
| 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 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 | Cloud |
| body | required |
Request body objects
The CloudFoundryCredentials object
Configuration for specific Cloud Foundry credentials.
| Element | Type | Description | Required |
|---|---|---|---|
| metadata | Configuration | Metadata useful for debugging | optional |
| id | string | The ID of the given credentials configuration. | optional |
| active | boolean | The monitoring is enabled ( If not set on creation, the If the field is omitted during an update, the old value remains unaffected. | 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. | 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: | 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 |
The ConfigurationMetadata object
Metadata useful for debugging
| Element | Type | Description | Required |
|---|---|---|---|
| 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 |
| clusterVersion | string | Dynatrace version. | 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.
{
"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 | Type | Description |
|---|---|---|
| 201 | Entity | Success. Cloud Foundry foundation credentials have been created. The ID and name of the new credentials are returned. |
| 400 | Error | Failed. The input is invalid. |
Response body objects
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
| Element | Type | Description | Required |
|---|---|---|---|
| id | string | The ID of the Dynatrace entity. | required |
| name | string | The name of the Dynatrace entity. | optional |
| description | string | A short description of the Dynatrace entity. | optional |
Response body JSON model
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity",
"description": "Dynatrace entity for the REST API example"
}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/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 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 | Type | Description |
|---|---|---|
| 204 | - | Validated. The submitted credentials are valid. Response does not have a body. |
| 400 | Error | Failed. The input is invalid. |