Patch Deployment

Updates the deployment with the supplied ID.

Request

URI

PATCH

https://{api_host}/deployment/api/deployments/{deploymentId}

COPY

Path Parameters

string

deploymentId

Required

Deployment ID

Request Body

DeploymentUpdate of type(s) application/json

Required

{
    "description": "string",
    "iconId": "string",
    "name": "string"
}

string

description

Optional

Constraints: maxLength: 2000

New description of the deployment

string As uuid As uuid

iconId

Optional

New iconid of the deployment

string

name

Optional

Constraints: minLength: 1 maxLength: 900

New name of the deployment

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns Deployment of type(s) application/json

"Deployment Object"

object

blueprint

Optional

Optional affected resources details to which the request applies to

string

blueprintId

Optional

Deployment blueprint id

string

blueprintVersion

Optional

Deployment blueprint version

object

catalog

Optional

Optional affected resources details to which the request applies to

string

catalogItemId

Optional

Deployment catalog item id

string

catalogItemVersion

Optional

Deployment catalog version

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

Created by

object

creator

Optional

Expanded policy last updater details

boolean

deleted

Optional

Indicates whether the deployment is deleted or not.

string

description

Optional

Description of the deployment

object

expense

Optional

Expense associated with the deployment.

string

iconId

Optional

Deployment icon id

string As uuid As uuid

Optional

Id of the deployment

object

inprogressRequests

Optional

inprogressRequests

object

inputs

Optional

inputs

object

lastRequest

Optional

Represents deployment requests.

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

Updated by

object

lastUpdater

Optional

Expanded policy last updater details

string As date-time As date-time

leaseExpireAt

Optional

Lease expiration time

integer As int32 As int32

leaseGracePeriodDays

Optional

Deployment lease grace period before deletion in days

string

name

Required

Name of the deployment

string

orgId

Optional

orgId

object

outputs

Optional

outputs

string

ownedBy

Optional

Owned by

object

owner

Optional

Expanded policy last updater details

string

ownerType

Optional

Owner type

Possible values are : USER, AD_GROUP,

object

project

Optional

Optional affected resources details to which the request applies to

string

projectId

Optional

Deployment project id

array of object

resources

Optional

Expanded resources for the deployment. Content of this property will not be maintained backward compatible

string

status

Optional

Represents the status of deployment with respect to its life cycle operations - create/update/delete.

Possible values are : CREATE_SUCCESSFUL, CREATE_INPROGRESS, CREATE_FAILED, UPDATE_SUCCESSFUL, UPDATE_INPROGRESS, UPDATE_FAILED, DELETE_SUCCESSFUL, DELETE_INPROGRESS, DELETE_FAILED,

401

Unauthorized

Returns Deployment of type(s) application/json

"Deployment Object"

object

blueprint

Optional

Optional affected resources details to which the request applies to

string

blueprintId

Optional

Deployment blueprint id

string

blueprintVersion

Optional

Deployment blueprint version

object

catalog

Optional

Optional affected resources details to which the request applies to

string

catalogItemId

Optional

Deployment catalog item id

string

catalogItemVersion

Optional

Deployment catalog version

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

Created by

object

creator

Optional

Expanded policy last updater details

boolean

deleted

Optional

Indicates whether the deployment is deleted or not.

string

description

Optional

Description of the deployment

object

expense

Optional

Expense associated with the deployment.

string

iconId

Optional

Deployment icon id

string As uuid As uuid

Optional

Id of the deployment

object

inprogressRequests

Optional

inprogressRequests

object

inputs

Optional

inputs

object

lastRequest

Optional

Represents deployment requests.

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

Updated by

object

lastUpdater

Optional

Expanded policy last updater details

string As date-time As date-time

leaseExpireAt

Optional

Lease expiration time

integer As int32 As int32

leaseGracePeriodDays

Optional

Deployment lease grace period before deletion in days

string

name

Required

Name of the deployment

string

orgId

Optional

orgId

object

outputs

Optional

outputs

string

ownedBy

Optional

Owned by

object

owner

Optional

Expanded policy last updater details

string

ownerType

Optional

Owner type

Possible values are : USER, AD_GROUP,

object

project

Optional

Optional affected resources details to which the request applies to

string

projectId

Optional

Deployment project id

array of object

resources

Optional

Expanded resources for the deployment. Content of this property will not be maintained backward compatible

string

status

Optional

Represents the status of deployment with respect to its life cycle operations - create/update/delete.

Possible values are : CREATE_SUCCESSFUL, CREATE_INPROGRESS, CREATE_FAILED, UPDATE_SUCCESSFUL, UPDATE_INPROGRESS, UPDATE_FAILED, DELETE_SUCCESSFUL, DELETE_INPROGRESS, DELETE_FAILED,

403

Forbidden

Returns Deployment of type(s) application/json

"Deployment Object"

object

blueprint

Optional

Optional affected resources details to which the request applies to

string

blueprintId

Optional

Deployment blueprint id

string

blueprintVersion

Optional

Deployment blueprint version

object

catalog

Optional

Optional affected resources details to which the request applies to

string

catalogItemId

Optional

Deployment catalog item id

string

catalogItemVersion

Optional

Deployment catalog version

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

Created by

object

creator

Optional

Expanded policy last updater details

boolean

deleted

Optional

Indicates whether the deployment is deleted or not.

string

description

Optional

Description of the deployment

object

expense

Optional

Expense associated with the deployment.

string

iconId

Optional

Deployment icon id

string As uuid As uuid

Optional

Id of the deployment

object

inprogressRequests

Optional

inprogressRequests

object

inputs

Optional

inputs

object

lastRequest

Optional

Represents deployment requests.

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

Updated by

object

lastUpdater

Optional

Expanded policy last updater details

string As date-time As date-time

leaseExpireAt

Optional

Lease expiration time

integer As int32 As int32

leaseGracePeriodDays

Optional

Deployment lease grace period before deletion in days

string

name

Required

Name of the deployment

string

orgId

Optional

orgId

object

outputs

Optional

outputs

string

ownedBy

Optional

Owned by

object

owner

Optional

Expanded policy last updater details

string

ownerType

Optional

Owner type

Possible values are : USER, AD_GROUP,

object

project

Optional

Optional affected resources details to which the request applies to

string

projectId

Optional

Deployment project id

array of object

resources

Optional

Expanded resources for the deployment. Content of this property will not be maintained backward compatible

string

status

Optional

Represents the status of deployment with respect to its life cycle operations - create/update/delete.

Possible values are : CREATE_SUCCESSFUL, CREATE_INPROGRESS, CREATE_FAILED, UPDATE_SUCCESSFUL, UPDATE_INPROGRESS, UPDATE_FAILED, DELETE_SUCCESSFUL, DELETE_INPROGRESS, DELETE_FAILED,

404

Not Found

Returns Deployment of type(s) application/json

"Deployment Object"

object

blueprint

Optional

Optional affected resources details to which the request applies to

string

blueprintId

Optional

Deployment blueprint id

string

blueprintVersion

Optional

Deployment blueprint version

object

catalog

Optional

Optional affected resources details to which the request applies to

string

catalogItemId

Optional

Deployment catalog item id

string

catalogItemVersion

Optional

Deployment catalog version

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

Created by

object

creator

Optional

Expanded policy last updater details

boolean

deleted

Optional

Indicates whether the deployment is deleted or not.

string

description

Optional

Description of the deployment

object

expense

Optional

Expense associated with the deployment.

string

iconId

Optional

Deployment icon id

string As uuid As uuid

Optional

Id of the deployment

object

inprogressRequests

Optional

inprogressRequests

object

inputs

Optional

inputs

object

lastRequest

Optional

Represents deployment requests.

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

Updated by

object

lastUpdater

Optional

Expanded policy last updater details

string As date-time As date-time

leaseExpireAt

Optional

Lease expiration time

integer As int32 As int32

leaseGracePeriodDays

Optional

Deployment lease grace period before deletion in days

string

name

Required

Name of the deployment

string

orgId

Optional

orgId

object

outputs

Optional

outputs

string

ownedBy

Optional

Owned by

object

owner

Optional

Expanded policy last updater details

string

ownerType

Optional

Owner type

Possible values are : USER, AD_GROUP,

object

project

Optional

Optional affected resources details to which the request applies to

string

projectId

Optional

Deployment project id

array of object

resources

Optional

Expanded resources for the deployment. Content of this property will not be maintained backward compatible

string

status

Optional

Represents the status of deployment with respect to its life cycle operations - create/update/delete.

Possible values are : CREATE_SUCCESSFUL, CREATE_INPROGRESS, CREATE_FAILED, UPDATE_SUCCESSFUL, UPDATE_INPROGRESS, UPDATE_FAILED, DELETE_SUCCESSFUL, DELETE_INPROGRESS, DELETE_FAILED,

Code Samples

COPY

                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Deployments Operations

GET

Get Deployments 1

GET

Get Deployment Filters

GET

Get Deployment Filter By Id

GET

Check Deployment Name Exists

GET

Check Deployment Name

Get Deployment By Id 1

PATCH

Patch Deployment

GET

Get Deployment Expense History By Id

GET

Get Deployment Resources

Get Deployments For Project