Delete Resource

Delete Resource

Deletes the resource with the specified ID and attempts to delete resource from the Cloud Provider.

Request
URI
DELETE
https://{api_host}/deployment/api/deployments/{deploymentId}/resources/{resourceId}
COPY
Path Parameters
string
deploymentId
Required

Deployment ID

string
resourceId
Required

Resource ID


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Request of type(s) application/json
{
    "actionId": "string",
    "approvedAt": "string",
    "blueprintId": "string",
    "cancelable": false,
    "catalogItemId": "string",
    "completedAt": "string",
    "completedTasks": 0,
    "createdAt": "string",
    "deploymentId": "string",
    "details": "string",
    "dismissed": false,
    "estimatedCompletionTime": "string",
    "id": "string",
    "initializedAt": "string",
    "inputs": {
        "inputs": {}
    },
    "name": "string",
    "outputs": {
        "outputs": {}
    },
    "requestedBy": "string",
    "resourceIds": [
        "string"
    ],
    "resources": [
        {
            "description": "string",
            "id": "string",
            "name": "string",
            "version": "string"
        }
    ],
    "status": "string",
    "totalTasks": 0,
    "updatedAt": "string"
}
string
actionId
Optional

Identifier of the requested action

string As date-time As date-time
approvedAt
Optional

Time at which the request was approved.

string
blueprintId
Optional

Identifier of the requested blueprint in the form 'UUID:version'

boolean
cancelable
Optional

Indicates whether request can be canceled or not.

string
catalogItemId
Optional

Identifier of the requested catalog item in the form 'UUID:version'

string As date-time As date-time
completedAt
Optional

Time at which the request completed.

integer As int32 As int32
completedTasks
Required

The number of tasks completed while fulfilling this request.

string As date-time As date-time
createdAt
Required

Creation time (e.g. date format '2019-07-13T23:16:49.310Z').

string As uuid As uuid
deploymentId
Optional

Identifier of the requested deployment id to which the request applies to

string
details
Optional

Longer user-friendly details of the request.

boolean
dismissed
Optional

Indicates whether request is in dismissed state.

string As date-time As date-time
estimatedCompletionTime
Optional

Estimated time of completion (e.g. date format '2019-07-13T23:16:49.310Z').

string As uuid As uuid
id
Optional

Request identifier

string As date-time As date-time
initializedAt
Optional

Time at which the request was initialized.

object
inputs
Optional

Request inputs

string
name
Required

Short user-friendly label of the request (e.g. 'shuting down myVM')

object
outputs
Optional

Request outputs

string
requestedBy
Required

User that initiated the request

array of string
resourceIds
Optional

Optional resource ids to which the request applies to

array of object
resources
Optional

Optional affected resources details to which the request applies to

string
status
Optional

Request overall execution status.

Possible values are : CREATED, PENDING, INITIALIZATION, CHECKING_APPROVAL, APPROVAL_PENDING, USER_INTERACTION_PENDING, INPROGRESS, COMPLETION, APPROVAL_REJECTED, ABORTED, SUCCESSFUL, FAILED,
integer As int32 As int32
totalTasks
Required

The total number of tasks need to be completed to fulfil this request.

string As date-time As date-time
updatedAt
Optional

Last update time (e.g. date format '2019-07-13T23:16:49.310Z').


401

Unauthorized

Returns Request of type(s) application/json
"Request Object"
string
actionId
Optional

Identifier of the requested action

string As date-time As date-time
approvedAt
Optional

Time at which the request was approved.

string
blueprintId
Optional

Identifier of the requested blueprint in the form 'UUID:version'

boolean
cancelable
Optional

Indicates whether request can be canceled or not.

string
catalogItemId
Optional

Identifier of the requested catalog item in the form 'UUID:version'

string As date-time As date-time
completedAt
Optional

Time at which the request completed.

integer As int32 As int32
completedTasks
Required

The number of tasks completed while fulfilling this request.

string As date-time As date-time
createdAt
Required

Creation time (e.g. date format '2019-07-13T23:16:49.310Z').

string As uuid As uuid
deploymentId
Optional

Identifier of the requested deployment id to which the request applies to

string
details
Optional

Longer user-friendly details of the request.

boolean
dismissed
Optional

Indicates whether request is in dismissed state.

string As date-time As date-time
estimatedCompletionTime
Optional

Estimated time of completion (e.g. date format '2019-07-13T23:16:49.310Z').

string As uuid As uuid
id
Optional

Request identifier

string As date-time As date-time
initializedAt
Optional

Time at which the request was initialized.

object
inputs
Optional

Request inputs

string
name
Required

Short user-friendly label of the request (e.g. 'shuting down myVM')

object
outputs
Optional

Request outputs

string
requestedBy
Required

User that initiated the request

array of string
resourceIds
Optional

Optional resource ids to which the request applies to

array of object
resources
Optional

Optional affected resources details to which the request applies to

string
status
Optional

Request overall execution status.

Possible values are : CREATED, PENDING, INITIALIZATION, CHECKING_APPROVAL, APPROVAL_PENDING, USER_INTERACTION_PENDING, INPROGRESS, COMPLETION, APPROVAL_REJECTED, ABORTED, SUCCESSFUL, FAILED,
integer As int32 As int32
totalTasks
Required

The total number of tasks need to be completed to fulfil this request.

string As date-time As date-time
updatedAt
Optional

Last update time (e.g. date format '2019-07-13T23:16:49.310Z').


403

Forbidden

Returns Request of type(s) application/json
"Request Object"
string
actionId
Optional

Identifier of the requested action

string As date-time As date-time
approvedAt
Optional

Time at which the request was approved.

string
blueprintId
Optional

Identifier of the requested blueprint in the form 'UUID:version'

boolean
cancelable
Optional

Indicates whether request can be canceled or not.

string
catalogItemId
Optional

Identifier of the requested catalog item in the form 'UUID:version'

string As date-time As date-time
completedAt
Optional

Time at which the request completed.

integer As int32 As int32
completedTasks
Required

The number of tasks completed while fulfilling this request.

string As date-time As date-time
createdAt
Required

Creation time (e.g. date format '2019-07-13T23:16:49.310Z').

string As uuid As uuid
deploymentId
Optional

Identifier of the requested deployment id to which the request applies to

string
details
Optional

Longer user-friendly details of the request.

boolean
dismissed
Optional

Indicates whether request is in dismissed state.

string As date-time As date-time
estimatedCompletionTime
Optional

Estimated time of completion (e.g. date format '2019-07-13T23:16:49.310Z').

string As uuid As uuid
id
Optional

Request identifier

string As date-time As date-time
initializedAt
Optional

Time at which the request was initialized.

object
inputs
Optional

Request inputs

string
name
Required

Short user-friendly label of the request (e.g. 'shuting down myVM')

object
outputs
Optional

Request outputs

string
requestedBy
Required

User that initiated the request

array of string
resourceIds
Optional

Optional resource ids to which the request applies to

array of object
resources
Optional

Optional affected resources details to which the request applies to

string
status
Optional

Request overall execution status.

Possible values are : CREATED, PENDING, INITIALIZATION, CHECKING_APPROVAL, APPROVAL_PENDING, USER_INTERACTION_PENDING, INPROGRESS, COMPLETION, APPROVAL_REJECTED, ABORTED, SUCCESSFUL, FAILED,
integer As int32 As int32
totalTasks
Required

The total number of tasks need to be completed to fulfil this request.

string As date-time As date-time
updatedAt
Optional

Last update time (e.g. date format '2019-07-13T23:16:49.310Z').


404

Not Found

Returns Request of type(s) application/json
"Request Object"
string
actionId
Optional

Identifier of the requested action

string As date-time As date-time
approvedAt
Optional

Time at which the request was approved.

string
blueprintId
Optional

Identifier of the requested blueprint in the form 'UUID:version'

boolean
cancelable
Optional

Indicates whether request can be canceled or not.

string
catalogItemId
Optional

Identifier of the requested catalog item in the form 'UUID:version'

string As date-time As date-time
completedAt
Optional

Time at which the request completed.

integer As int32 As int32
completedTasks
Required

The number of tasks completed while fulfilling this request.

string As date-time As date-time
createdAt
Required

Creation time (e.g. date format '2019-07-13T23:16:49.310Z').

string As uuid As uuid
deploymentId
Optional

Identifier of the requested deployment id to which the request applies to

string
details
Optional

Longer user-friendly details of the request.

boolean
dismissed
Optional

Indicates whether request is in dismissed state.

string As date-time As date-time
estimatedCompletionTime
Optional

Estimated time of completion (e.g. date format '2019-07-13T23:16:49.310Z').

string As uuid As uuid
id
Optional

Request identifier

string As date-time As date-time
initializedAt
Optional

Time at which the request was initialized.

object
inputs
Optional

Request inputs

string
name
Required

Short user-friendly label of the request (e.g. 'shuting down myVM')

object
outputs
Optional

Request outputs

string
requestedBy
Required

User that initiated the request

array of string
resourceIds
Optional

Optional resource ids to which the request applies to

array of object
resources
Optional

Optional affected resources details to which the request applies to

string
status
Optional

Request overall execution status.

Possible values are : CREATED, PENDING, INITIALIZATION, CHECKING_APPROVAL, APPROVAL_PENDING, USER_INTERACTION_PENDING, INPROGRESS, COMPLETION, APPROVAL_REJECTED, ABORTED, SUCCESSFUL, FAILED,
integer As int32 As int32
totalTasks
Required

The total number of tasks need to be completed to fulfil this request.

string As date-time As date-time
updatedAt
Optional

Last update time (e.g. date format '2019-07-13T23:16:49.310Z').


Code Samples
COPY
                    curl -X DELETE -H 'Authorization: <value>' https://{api_host}/deployment/api/deployments/{deploymentId}/resources/{resourceId}