Product Documentation

Deployment Profile API

/deploymentprofile/{id} (GET)

Description

Gets details of an existing deployment profile.

URL structure

https://smart.cloud.com/v0/deploymentprofile/{id}?access_token=VALID_ACCESS_TOKEN

URL example

https://smart.cloud.com/v0/deploymentprofile/2927?access_token=DOTqOd51i78K8gN61bLspZIBO

Method

GET

Response

Sample response:

Deployment Profile id GET response

/deploymentprofile/

Description

Creates a deployment profile.

URL structure

https://smart.cloud.com/v0/deploymentprofile?access_token=VALID_ACCESS_TOKEN

URL example

https: //smart.cloud.com/v0/deploymentprofile?access_token=DOTqOd51i78K8gN61bLspZIBO&processIdStr=58487&deploymentProfileName=deployProfile1446613878199&processVersionStr=1

Method

POST

Parameters

Name Required or Optional
processIDStr Required
processVersionStr Required
deploymentProfileName Required
description Optional
providerIdListStr Optional
profileDetailsStr Required, in API body

Response

JSON payload

Sample response:

Deployment Profile Sample Response

/deploymentprofile/{id} (POST)

Description

Edits or modifies an existing deployment profile.

URL structure

https://smart.cloud.com/v0/deploymentprofile/{id}?access_token=VALID_ACCESS_TOKEN

URL example

https: //smart.cloud.com/v0/deploymentprofile/2921?access_token=DOTqOd51i78K8gN61bLspZIBO&processIdStr=58483&processVersionStr=1&deploymentProfileName=EditProfileName

Method

POST

Parameters

Name Required or Optional
processIDStr Required
processVersionStr Required
deploymentProfileName Required
description Optional
providerIdListStr Optional
profileDetailsStr Required in API body

Response

JSON payload

Sample response:

Deployment Profile id POST response

/deploymentprofile/{id} (DELETE)

Description

Deletes an existing deployment profile.

URL structure

https://smart.cloud.com/v0/deploymentprofile/{id}?access_token=VALID_ACCESS_TOKEN

URL example

https: //smart.cloud.com/v0/deploymentprofile/2922?access_token=DOTqOd51i78K8gN61bLspZIBO

Method

DELETE

Response

JSON payload

Sample response:

true

/deploymentprofile/{id}/deploy

Description

Deploys a blueprint from a deployment profile.

URL structure

https://smart.cloud.com/v0/deploymentprofile/{id}/deploy?access_token=VALID_ACCESS_TOKEN

URL example

https: //smart.cloud.com/v0/deploymentprofile/2907/deploy?access_token=DOTqOd51i78K8gN61bLspZIBO&processId=57613&name=9

Method

POST

Parameters

Name Required or Optional
processId Required
name Required

Response

JSON payload

Sample response:

Deployment Profile id deploy response

/deploymentprofile/list

Description

Gets a list of deployment profiles for a blueprint.

URL structure

https: //smart.cloud.com/v0/deploymentprofile/list?access_token=ACCESS_TOKEN&processId=PROCESS_ID&processVersion=PROCESS_VERSION

URL example

https: //smart.cloud.com/v0/deploymentprofile/list?access_token=DOTqOd51i78K8gN61bLspZIBO&processId=58486&processVersion=1

Method

POST

Parameters

Name Required or Optional
processId Required
processVersion Required
providerIdList Optional

Response

JSON payload

Sample response:

Deployment Profile list response