Cloud Foundry foundations credentials API - POST credentials

Creates a new credentials for a single 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.

POST	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/cloudFoundry/credentials SaaS https://{your-environment-id}.live.dexp.ae/api/config/v1/cloudFoundry/credentials

Authentication

To execute this request, you need the Write configuration permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

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

Request parameters JSON model

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: `.+-_`. Leading or trailing whitespaces are 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.	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 `false`, DESK will stop polling the Cloud Foundry API. Default value is `true`. If the field is omitted during an update, the old value is used.	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

Response parameters JSON model

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.

{}

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.dexp.ae/api/config/v1/cloudFoundry/credentials/validator

Authentication

To execute this request, you need the Write configuration permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Response codes

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