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 |
|
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 |
Cloud |
|
body | optional |
Body format
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 |
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 |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.
{
"metadata": {
"configurationVersions": [
"integer"
],
"currentConfigurationVersions": [
"string"
],
"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
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.
This request is an Early Adopter release and may be changed in non-compatible way.
POST |
|
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.