Cloud Foundry credentials API - POST credentials
Creates a new credentials configuration.
The request consumes and produces an application/json payload.
| POST | ManagedDynatrace for Government | 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}:9999/e/{your-environment-id}/api/config/v1/cloudFoundry/credentials |
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 |
|---|---|---|---|---|
| body | CloudFoundryCredentials |
| body | required |
Request body objects
The CloudFoundryCredentials object
Configuration for specific Cloud Foundry credentials.
| Element | Type | Description | Required |
|---|---|---|---|
| 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 |
| 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.
| 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 | ConfigurationMetadata | 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: | 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.
1{2 "active": true,3 "apiUrl": "string",4 "endpointStatus": "ASSIGNED",5 "endpointStatusInfo": "string",6 "id": "string",7 "loginUrl": "string",8 "metadata": {9 "clusterVersion": "1.192.1",10 "configurationVersions": [11 4,12 213 ],14 "currentConfigurationVersions": [15 "1.0.4",16 "1.23"17 ]18 },19 "name": "string",20 "password": "string",21 "username": "string"22}
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 201 | EntityShortRepresentation | Success. Cloud Foundry foundation credentials have been created. The ID and name of the new credentials are returned. |
| 400 | ErrorEnvelope | 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
1{2 "description": "Dynatrace entity for the REST API example",3 "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",4 "name": "Dynatrace entity"5}
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.
| POST | ManagedDynatrace for Government | 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}:9999/e/{your-environment-id}/api/config/v1/cloudFoundry/credentials/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 | ErrorEnvelope | Failed. The input is invalid. |