Cloud Foundry foundations credentials API - PUT credentials
Updates the credentials of the specified Cloud Foundry foundation.
The request consumes and produces an application/json
payload.
This request is an early adopter release and may be changed in non compatible way.
PUT |
|
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
id | string |
The ID of the Cloud Foundry foundation credentials. |
path | required |
body | CloudFoundryCredentials |
|
body | optional |
The CloudFoundryCredentials object
Element | Type | Description | Required |
---|---|---|---|
metadata | ConfigurationMetadata |
Metadata useful for debugging. |
optional |
id | string |
The ID of the Cloud Foundry foundation credentials. |
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. |
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. |
optional |
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 |
active | boolean |
Whether Cloud Foundry API polling is enabled for this foundation. If set to |
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 |
clusterVersion | string |
DESK server version. |
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"
],
"clusterVersion": "string"
},
"id": "string",
"name": "string",
"apiUrl": "string",
"loginUrl": "string",
"username": "string",
"password": "string",
"active": true
}
Response format
The EntityShortRepresentation object
The short representation of a DESK entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the DESK entity. |
name | string | The name of the DESK entity. |
description | string | A short description of the DESK entity. |
{}
Response codes
Code | 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. |
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 |
|
Response codes
Code | Description |
---|---|
204 | Validated. The submitted credentials are valid. Response does not have a body. |
400 | Failed. The input is invalid. |