Get Resource By Id 1

Returns the resource with the specified ID that is correlated with the supplied deployment.

Request

URI

GET

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

COPY

Path Parameters

string

deploymentId

Required

Deployment ID

string

resourceId

Required

Resource ID

Query Parameters

string of array

expand

Optional

The expanded details of the requested comma separated objects. Ex. currentRequest

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns DeploymentResource of type(s) application/json

{
    "createdAt": "string",
    "currentRequest": {
        "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"
    },
    "dependsOn": [
        "string"
    ],
    "description": "string",
    "expense": {
        "additionalExpense": "number",
        "code": "string",
        "computeExpense": "number",
        "lastUpdatedTime": "string",
        "message": "string",
        "networkExpense": "number",
        "storageExpense": "number",
        "totalExpense": "number",
        "unit": "string"
    },
    "id": "string",
    "inprogressRequests": {},
    "name": "string",
    "origin": "string",
    "properties": {
        "properties": {}
    },
    "state": "string",
    "syncStatus": "string",
    "type": "string"
}

string As date-time As date-time

createdAt

Optional

Creation time

object

currentRequest

Optional

Represents deployment requests.

array of string

dependsOn

Optional

A list of other resources this resource depends on

string

description

Optional

A description of the resource

object

expense

Optional

Expense associated with the deployment.

string As uuid As uuid

Optional

Unique identifier of the resource

object

inprogressRequests

Optional

inprogressRequests

string

name

Required

Name of the resource

string

origin

Optional

Origin of the resource

Possible values are : DISCOVERED, DEPLOYED, ONBOARDED, MIGRATED, SIMULATED, CCS, DISCOVERED, ONBOARDED, MIGRATED,

object

properties

Optional

properties

string

state

Optional

The current state of the resource

Possible values are : PARTIAL, TAINTED, OK,

string

syncStatus

Optional

The current sync status

Possible values are : SUCCESS, MISSING, STALE,

string

type

Required

Type of the resource

401

Unauthorized

Returns DeploymentResource of type(s) application/json

"DeploymentResource Object"

string As date-time As date-time

createdAt

Optional

Creation time

object

currentRequest

Optional

Represents deployment requests.

array of string

dependsOn

Optional

A list of other resources this resource depends on

string

description

Optional

A description of the resource

object

expense

Optional

Expense associated with the deployment.

string As uuid As uuid

Optional

Unique identifier of the resource

object

inprogressRequests

Optional

inprogressRequests

string

name

Required

Name of the resource

string

origin

Optional

Origin of the resource

Possible values are : DISCOVERED, DEPLOYED, ONBOARDED, MIGRATED, SIMULATED, CCS, DISCOVERED, ONBOARDED, MIGRATED,

object

properties

Optional

properties

string

state

Optional

The current state of the resource

Possible values are : PARTIAL, TAINTED, OK,

string

syncStatus

Optional

The current sync status

Possible values are : SUCCESS, MISSING, STALE,

string

type

Required

Type of the resource

404

Not Found

Returns DeploymentResource of type(s) application/json

"DeploymentResource Object"

string As date-time As date-time

createdAt

Optional

Creation time

object

currentRequest

Optional

Represents deployment requests.

array of string

dependsOn

Optional

A list of other resources this resource depends on

string

description

Optional

A description of the resource

object

expense

Optional

Expense associated with the deployment.

string As uuid As uuid

Optional

Unique identifier of the resource

object

inprogressRequests

Optional

inprogressRequests

string

name

Required

Name of the resource

string

origin

Optional

Origin of the resource

Possible values are : DISCOVERED, DEPLOYED, ONBOARDED, MIGRATED, SIMULATED, CCS, DISCOVERED, ONBOARDED, MIGRATED,

object

properties

Optional

properties

string

state

Optional

The current state of the resource

Possible values are : PARTIAL, TAINTED, OK,

string

syncStatus

Optional

The current sync status

Possible values are : SUCCESS, MISSING, STALE,

string

type

Required

Type of the resource

Code Samples

COPY

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

On This Page

Description

Request

Path Parameters

Query Parameters

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