API Reference

Last updated: 04-04-2024

API docs by Redocly

NCM Self-Service (3.1.0)

Download OpenAPI specification:Download

Introduction

NCM Self-Service allows you to seamlessly select, provision, and manage your business applications across infrastructures for both, private and public clouds.

Self-Service provides application lifecycle, monitoring, and remediation to manage heterogeneous infrastructure. For example, VMs or bare-metal servers. Self-Service supports multiple platforms through its single self-service and automation interface to manage all your infrastructure.

Authentication

  • Basic Authentication : The user provides user ID and password every time a request is sent as the auth-header.

  • Session Authentication : The user credentials are stored in a cookie.

Accounts

Create account

Creates an account using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (account Intent Spec with placement specified)

An intentful representation of a account spec

required
object (account metadata)

The account kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/accounts \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "parent_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "price_items": [
                {
                    "description": "string",
                    "details": {
                        "association_type": "string",
                        "occurrence": "string",
                        "provider_type": "string"
                    },
                    "name": "string",
                    "state_cost_list": [
                        {
                            "cost_list": [
                                {
                                    "interval": "string",
                                    "name": "string",
                                    "value": null
                                }
                            ],
                            "state": "string"
                        }
                    ],
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "sync_interval_secs": 0,
            "tunnel_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "type": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Delete account

Deletes the specified account.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/accounts/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get account

Retrieves the specified account.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/accounts/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get all resource types of this account's provider

Get all resource types of this account's provider

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "account"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/accounts/{uuid}/resource_types/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "account",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List accounts

Retrieves the list of accounts, applying filters provided (if any) in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "account"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/accounts/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "account",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List cluster information of accounts

Retrieves the list of clusters for accounts, applying filters provided (if any) in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "account"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/accounts/clusters/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "account",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "cluster_list": [
    ]
}

List of vms associated with the Account

Retrieves the list of VM's from the Account. Supported filters are:

  • name
  • uuid
  • cpu
  • memory
  • power_state
  • ip_addresses
  • categories
  • tags
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

fields
Array of strings
length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/accounts/{uuid}/vms/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "fields": [
        "string"
    ],
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Trigger platform sync

Trigger platform sync on an account

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/accounts/{uuid}/sync \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Update account

Updates the specified account using data included in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
required
object (account Intent Spec with placement specified)

An intentful representation of a account spec

required
object (account metadata)

The account kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/accounts/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "parent_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "price_items": [
                {
                    "description": "string",
                    "details": {
                        "association_type": "string",
                        "occurrence": "string",
                        "provider_type": "string"
                    },
                    "name": "string",
                    "state_cost_list": [
                        {
                            "cost_list": [
                                {
                                    "interval": "string",
                                    "name": "string",
                                    "value": null
                                }
                            ],
                            "state": "string"
                        }
                    ],
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "sync_interval_secs": 0,
            "tunnel_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "type": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Verify account

Verifies credentials associated with the specified account.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/accounts/{uuid}/verify \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "kind": "account",
  • "code": 0,
  • "message_list": [
    ],
  • "state": "string",
  • "api_version": "3.1.0"
}

App Icons

Check app icon

Check if App icon is used by MarketPlaceItem given its UUID

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_icons/{uuid}/is_marketplaceicon \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "kind": "app_icon",
  • "code": 0,
  • "message_list": [
    ],
  • "state": "string",
  • "api_version": "3.1.0"
}

Create app icon

Creates an app icon object using data included in the request and returns metadata of created image object.

Authorizations:
basicAuth
Request Body schema: multipart/form-data
required

icon file

any <binary>

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_icons/upload \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: multipart/form-data' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Delete app icon

Delete an App icon given its UUID.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_icons/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "kind": "app_icon",
  • "code": 0,
  • "message_list": [
    ],
  • "state": "string",
  • "api_version": "3.1.0"
}

Delete marketplace icon

Delete an icon for marketplace item.

Authorizations:
basicAuth

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/icons/constant/marketplace/delete \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "kind": "marketplace_icon",
  • "code": 0,
  • "message_list": [
    ],
  • "state": "string",
  • "api_version": "3.1.0"
}

Get app icon

Retrieves the specified app icon metadata and base64 encoded icon.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_icons/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get app icon summary

Retrieves the metadata of the specified app icon.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_icons/{uuid}/summary \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List app icons

Retrieves the list of all app icons' metadata.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "app_icon"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_icons/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "app_icon",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

App Runlogs

Get archived runlog

Retrieves information of the specified runlog archive.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_runlogs/archival_policy/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "name": "string",
  • "start_time": "2019-08-24T14:15:22Z",
  • "creation_time": "2019-08-24T14:15:22Z",
  • "is_available": true,
  • "end_time": "2019-08-24T14:15:22Z",
  • "uuid": "string"
}

Get runlog archive

Downloads the specified archive file containing scripts and execution outputs.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_runlogs/archive_file/{uuid}/download \
    --header 'Accept: application/octet-stream' \
    --header 'Authorization: Basic <basic_auth_token>' \

List archived runlogs

Retrieves the information of all runlog archives, applying filters provided (if any) in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "app_runlog"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_runlogs/archival_policy/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "app_runlog",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ]
}

App Showback

App showback csv file preparation

API to trigger app showback cost data csv preparation

Authorizations:
basicAuth
query Parameters
project_reference
string

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_showback/prepare_csv \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

App showback data csv download

API for showback data csv download

Authorizations:
basicAuth
query Parameters
project_reference
string

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_showback/export_file \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Cancel showback enable/disable

Cancels the triggered showback enablement/disablement operation.

Authorizations:
basicAuth

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_showback/cancel \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

checks csv file readiness status

API to check csv file readiness status

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_showback/{uuid}/csv_file_readiness_status \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

checks existing prepare_csv task

API to check existing prepare_csv task

Authorizations:
basicAuth
query Parameters
project_reference
string

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_showback/prepare_csv_task_exists \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Disable showback

Disables showback on the current instance.

Authorizations:
basicAuth

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_showback/disable \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Enable showback

Enables showback on the current instance.

Authorizations:
basicAuth

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_showback/enable \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Get showback status

Retrieves showback status on the current instance.

Authorizations:
basicAuth

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_showback/status \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "current_state": "string",
  • "previous_state_timestamps": {
    }
}

App Tasks

Create library task

Creates a library task using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (app_task Intent Spec with placement specified)

An intentful representation of a app_task spec

required
object (app_task metadata)

The app_task kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_tasks \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "child_tasks_local_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "exec_target_reference": {
                "categories": {
                    "property1": "string",
                    "property2": "string"
                },
                "kind": "string",
                "name": "string",
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "inherit_target": true,
            "retries": "string",
            "target_any_local_reference": {
                "categories": {
                    "property1": "string",
                    "property2": "string"
                },
                "kind": "string",
                "name": "string",
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "timeout_secs": "string",
            "type": "string",
            "variable_list": [
                {
                    "data_type": "string",
                    "description": "string",
                    "is_hidden": true,
                    "is_mandatory": true,
                    "label": "string",
                    "library_reference": "string",
                    "name": "string",
                    "options": {
                        "choices": [
                            "string"
                        ],
                        "type": "string"
                    },
                    "regex": {
                        "should_validate": true,
                        "value": "string"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "val_type": "string",
                    "value": "string"
                }
            ]
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Delete library task

Deletes the specified library task.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_tasks/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "kind": "app_task",
  • "code": 0,
  • "message_list": [
    ],
  • "state": "string",
  • "api_version": "3.1.0"
}

Get library task

Retrieves the specified library task.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_tasks/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List library tasks

Retrieves the list of library tasks, applying filters provided (if any) in the request. Supported filters are:

  • name
  • type.
Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "app_task"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_tasks/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "app_task",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Share library task

Shares the specified library task between projects.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
required
object (App task share kind)

App task share kind

api_version
required
string
required
object (app_task metadata)

The app_task kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_tasks/{uuid}/share \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "child_tasks_local_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "exec_target_reference": {
                "categories": {
                    "property1": "string",
                    "property2": "string"
                },
                "kind": "string",
                "name": "string",
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "inherit_target": true,
            "project_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "retries": "string",
            "target_any_local_reference": {
                "categories": {
                    "property1": "string",
                    "property2": "string"
                },
                "kind": "string",
                "name": "string",
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "timeout_secs": "string",
            "type": "string",
            "variable_list": [
                {
                    "data_type": "string",
                    "description": "string",
                    "is_hidden": true,
                    "is_mandatory": true,
                    "label": "string",
                    "library_reference": "string",
                    "name": "string",
                    "options": {
                        "choices": [
                            "string"
                        ],
                        "type": "string"
                    },
                    "regex": {
                        "should_validate": true,
                        "value": "string"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "val_type": "string",
                    "value": "string"
                }
            ]
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Update library task

Updates the specified library task using data included in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
required
object (app_task Intent Spec with placement specified)

An intentful representation of a app_task spec

required
object (app_task metadata)

The app_task kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_tasks/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "child_tasks_local_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "exec_target_reference": {
                "categories": {
                    "property1": "string",
                    "property2": "string"
                },
                "kind": "string",
                "name": "string",
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "inherit_target": true,
            "retries": "string",
            "target_any_local_reference": {
                "categories": {
                    "property1": "string",
                    "property2": "string"
                },
                "kind": "string",
                "name": "string",
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "timeout_secs": "string",
            "type": "string",
            "variable_list": [
                {
                    "data_type": "string",
                    "description": "string",
                    "is_hidden": true,
                    "is_mandatory": true,
                    "label": "string",
                    "library_reference": "string",
                    "name": "string",
                    "options": {
                        "choices": [
                            "string"
                        ],
                        "type": "string"
                    },
                    "regex": {
                        "should_validate": true,
                        "value": "string"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "val_type": "string",
                    "value": "string"
                }
            ]
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

App Variables

Create variable type

Creates a library variable type using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (app_variable Intent Spec with placement specified)

An intentful representation of a app_variable spec

required
object (app_variable metadata)

The app_variable kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_variables \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "created_by": "string",
            "data_type": "string",
            "is_hidden": true,
            "is_mandatory": true,
            "label": "string",
            "library_reference": "string",
            "options": {
                "choices": [
                    "string"
                ],
                "type": "string"
            },
            "regex": {
                "should_validate": true,
                "value": "string"
            },
            "type": "string",
            "val_type": "string",
            "value": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Delete variable type

Deletes the specified library variable type

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_variables/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "kind": "app_variable",
  • "code": 0,
  • "message_list": [
    ],
  • "state": "string",
  • "api_version": "3.1.0"
}

Get variable type

Retrieves the specified Variable type.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_variables/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List variable types

Retrieves a list of all library variable types. Supported filters are:

  • name
  • type.
Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "app_variable"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_variables/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "app_variable",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Share variable type

Share the library variable type between projects.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
required
object (App variable share kind)

App variable share kind

api_version
required
string
required
object (app_variable metadata)

The app_variable kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_variables/{uuid}/share \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "created_by": "string",
            "data_type": "string",
            "is_hidden": true,
            "is_mandatory": true,
            "label": "string",
            "library_reference": "string",
            "options": {
                "choices": [
                    "string"
                ],
                "type": "string"
            },
            "project_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "regex": {
                "should_validate": true,
                "value": "string"
            },
            "type": "string",
            "val_type": "string",
            "value": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Update variable type

Updates the specified Variable type using data included in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
required
object (app_variable Intent Spec with placement specified)

An intentful representation of a app_variable spec

required
object (app_variable metadata)

The app_variable kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_variables/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "created_by": "string",
            "data_type": "string",
            "is_hidden": true,
            "is_mandatory": true,
            "label": "string",
            "library_reference": "string",
            "options": {
                "choices": [
                    "string"
                ],
                "type": "string"
            },
            "regex": {
                "should_validate": true,
                "value": "string"
            },
            "type": "string",
            "val_type": "string",
            "value": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

app_runlogs

Returns status information of the runlogs

Returns status information of the runlogs

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/engine_runlogs/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "entities": [
    ]
}

Returns status of trls

Returns status of trls

Authorizations:
basicAuth
Request Body schema: application/json
required
trl_uuid
required
Array of strings

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/engine_runlogs/status \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "trl_uuid": [
        "string"
    ]
}'

Response samples

Content type
application/json
{
  • "entities": [
    ]
}

Returns the engine runlog task information

Returns the engine runlog task information

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/engine_runlogs/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "entities": [
    ]
}

Returns tree of depth=1

Returns tree of depth=1

Authorizations:
basicAuth
Request Body schema: application/json
required
task_id
required
string
run_id
required
string

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/engine_runlogs/tree \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "run_id": "string",
    "task_id": "string"
}'

Response samples

Content type
application/json
{
  • "entities": {
    }
}

AppProtectionPolicies

Create app_protection_policy

Creates an app_protection_policy using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (app_protection_policy Intent Spec with placement specified)

An intentful representation of a app_protection_policy spec

required
object (app_protection_policy metadata)

The app_protection_policy kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_protection_policies \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "app_protection_rule_list": [
                {
                    "category_filter": {
                        "type": "CATEGORIES_MATCH_ANY"
                    },
                    "enabled": true,
                    "first_availability_site_index": 0,
                    "is_default": false,
                    "local_snapshot_retention_policy": {
                        "num_snapshots": 0,
                        "rollup_retention_policy": {
                            "multiple": 0,
                            "snapshot_interval_type": "string"
                        },
                        "snapshot_expiry_policy": {
                            "interval_type": "string",
                            "multiple": 0
                        }
                    },
                    "name": "string",
                    "provider_protection_rule_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "recovery_point_objective_secs": 0,
                    "remote_snapshot_retention_policy": {
                        "num_snapshots": 0,
                        "rollup_retention_policy": {
                            "multiple": 0,
                            "snapshot_interval_type": "string"
                        },
                        "snapshot_expiry_policy": {
                            "interval_type": "string",
                            "multiple": 0
                        }
                    },
                    "second_availability_site_index": 0,
                    "snapshot_type": "string",
                    "type": "SNAPSHOT",
                    "uuid": "string"
                }
            ],
            "is_default": false,
            "ordered_availability_site_list": [
                {
                    "environment_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "infra_inclusion_list": {
                        "account_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    }
                }
            ],
            "rpo": null,
            "type": "MANUAL"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Delete app_protection_policy

Deletes the specified app_protection_policy.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_protection_policies/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get app_protection_policy

Retrieves the specified app_protection_policy.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_protection_policies/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List app_protection_policies

Retrieves the list of app_protection_policies, applying filters provided (if any) in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "app_protection_policy"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_protection_policies/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "app_protection_policy",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List app_protection_policies

Retrieves the list of app_protection_policies corresponding to the config uuid

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "app_protection_policy"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/app_profile/{app_profile_uuid}/config_spec/{config_uuid}/app_protection_policies/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "app_protection_policy",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Update app_protection_policy

Updates the specified app_protection_policy using data included in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
required
object (app_protection_policy Intent Spec with placement specified)

An intentful representation of a app_protection_policy spec

required
object (app_protection_policy metadata)

The app_protection_policy kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/app_protection_policies/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "app_protection_rule_list": [
                {
                    "category_filter": {
                        "type": "CATEGORIES_MATCH_ANY"
                    },
                    "enabled": true,
                    "first_availability_site_index": 0,
                    "is_default": false,
                    "local_snapshot_retention_policy": {
                        "num_snapshots": 0,
                        "rollup_retention_policy": {
                            "multiple": 0,
                            "snapshot_interval_type": "string"
                        },
                        "snapshot_expiry_policy": {
                            "interval_type": "string",
                            "multiple": 0
                        }
                    },
                    "name": "string",
                    "provider_protection_rule_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "recovery_point_objective_secs": 0,
                    "remote_snapshot_retention_policy": {
                        "num_snapshots": 0,
                        "rollup_retention_policy": {
                            "multiple": 0,
                            "snapshot_interval_type": "string"
                        },
                        "snapshot_expiry_policy": {
                            "interval_type": "string",
                            "multiple": 0
                        }
                    },
                    "second_availability_site_index": 0,
                    "snapshot_type": "string",
                    "type": "SNAPSHOT",
                    "uuid": "string"
                }
            ],
            "is_default": false,
            "ordered_availability_site_list": [
                {
                    "environment_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "infra_inclusion_list": {
                        "account_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    }
                }
            ],
            "rpo": null,
            "type": "MANUAL"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

approval_requests

Get Approval

Retrieves the specified approval_request

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/approvals/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get Approval Request

Retrieves the specified approval_request

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/approval_requests/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List Approval Requests

Retrieves the list of approval_requests, applying filters provided (if any) in the request

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "approval_request"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/approval_requests/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "approval_request",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List Approvals

Retrieves the list of approvals, applying filters provided (if any) in the request

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "approval_request"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/approvals/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "approval_request",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Update Approval

Updates the specified approval_request's state

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

The UUID of the approval set.

required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

The UUID of the approval element.

Request Body schema: application/json
required

Request body

comment
required
string
state
required
string
Enum: "APPROVED" "REJECTED"
spec_version
required
integer

Version number of the latest spec.

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/approvals/{uuid}/approval_sets/{set_uuid}/approval_elements/{element_uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "comment": "string",
    "spec_version": 0,
    "state": "APPROVED"
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

apps

The API for image_create action of application on provided target.

API for image_create action on provided target.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

substrate_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Uuid of substrate on which the action is run

Request Body schema: application/json
required
required
object (Spec for image create action launch.)

Spec for image create action launch.

api_version
required
string
required
object (app metadata)

The app kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/substrates/{substrate_uuid}/image_create \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "image_details_list": [
            {
                "description": "string",
                "image_name": "string",
                "source_disk_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            }
        ]
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

The API for recovery_group_delete action of application on provided target.

API for recovery_group_delete action on provided target.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
required
object (Spec for action launch.)

Spec for action launch.

api_version
required
string
required
object (app metadata)

The app kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/recovery_group_delete \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "args": [
            {
                "name": "string",
                "task_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                "value": "string"
            }
        ],
        "target_kind": "string",
        "target_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

The API for restore action of application on provided target.

API for restore action on provided target.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

substrate_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Uuid of substrate on which the action is run

Request Body schema: application/json
required
required
object (Spec for action launch.)

Spec for action launch.

api_version
required
string
required
object (app metadata)

The app kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/substrates/{substrate_uuid}/restore \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "args": [
            {
                "name": "string",
                "task_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                "value": "string"
            }
        ],
        "target_kind": "string",
        "target_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

The API for snapshot_create action of application on provided target.

API for snapshot_create action on provided target.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

substrate_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Uuid of substrate on which the action is run

Request Body schema: application/json
required
required
object (Spec for action launch.)

Spec for action launch.

api_version
required
string
required
object (app metadata)

The app kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/substrates/{substrate_uuid}/snapshot_create \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "args": [
            {
                "name": "string",
                "task_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                "value": "string"
            }
        ],
        "target_kind": "string",
        "target_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

The API for snapshot_delete action of application on provided target.

API for snapshot_delete action on provided target.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

substrate_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Uuid of substrate on which the action is run

Request Body schema: application/json
required
required
object (Spec for action launch.)

Spec for action launch.

api_version
required
string
required
object (app metadata)

The app kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/substrates/{substrate_uuid}/snapshot_delete \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "args": [
            {
                "name": "string",
                "task_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                "value": "string"
            }
        ],
        "target_kind": "string",
        "target_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Apps

Abort runlog

Aborts the specified application runlog.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

runlog_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Runlog UUID to abort

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/app_runlogs/{runlog_uuid}/abort \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Abort script

Aborts the specified script run request using data provided in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Application uuid

runid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

run id of the script

trlid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

trl UUID of the script

Request Body schema: application/json
required
required
object (abort script input spec)

abort script input spec

api_version
string

api version

object (app metadata)

The app kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/run_script/abort/{runid}/{trlid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {}
}'

Response samples

Content type
application/json
{ }

Apply changes to blueprint

Apply changes to the application blueprint for the specified application.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Application UUID

Request Body schema: application/json
required
required
object (Spec for action launch.)

Spec for action launch.

api_version
required
string
required
object (app metadata)

The app kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/blueprints/new/apply \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "args": [
            {
                "name": "string",
                "task_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                "value": "string"
            }
        ],
        "target_kind": "string",
        "target_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Clone application

Clone the application with given uuid.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required

Request body

required
object (Spec for application clone)

Spec for application clone

api_version
required
string
required
object (app metadata)

The app kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/clone \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "description": "string",
        "name": "string"
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Create application

Creates an application using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

object (app Intent Spec with placement specified)

An intentful representation of a app spec

api_version
required
string
required
object (app metadata)

The app kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "action_list": [
                {
                    "critical": false,
                    "description": "string",
                    "name": "string",
                    "runbook": {
                        "description": "string",
                        "main_task_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "name": "string",
                        "task_definition_list": [
                            {
                                "child_tasks_local_reference_list": [
                                    {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "exec_target_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "inherit_target": true,
                                "name": "string",
                                "retries": "string",
                                "target_any_local_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "timeout_secs": "string",
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "app_blueprint_config_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "app_blueprint_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "app_profile_config_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "application_url": "string",
            "cloned_from_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "credential_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "default_credential_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "dependency_list": [
                {
                    "action_name": "string",
                    "action_resource_kind": "string",
                    "action_resource_name": "string",
                    "from_resource_kind": "string",
                    "getter_resource_kind": "string",
                    "getter_resource_name": "string",
                    "setter_resource_attr": "string",
                    "setter_resource_kind": "string",
                    "setter_resource_name": "string"
                }
            ],
            "deployment_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "brownfield_instance_list": [
                        {
                            "address": [
                                "string"
                            ],
                            "instance_id": "string",
                            "instance_name": "string",
                            "nic_index": 0,
                            "power_state": "string"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "default_replicas": "string",
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "fault_domain_scope": "string",
                    "max_replicas": "1",
                    "min_replicas": "1",
                    "name": "string",
                    "num_fault_tolerance": 0,
                    "package_list": [
                        {
                            "action_list": [
                                {
                                    "critical": false,
                                    "description": "string",
                                    "name": "string",
                                    "runbook": {
                                        "description": "string",
                                        "main_task_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "name": "string",
                                        "task_definition_list": [
                                            {
                                                "child_tasks_local_reference_list": [
                                                    {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    }
                                                ],
                                                "description": "string",
                                                "exec_target_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "inherit_target": true,
                                                "name": "string",
                                                "retries": "string",
                                                "target_any_local_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "timeout_secs": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "variable_list": [
                                                    {
                                                        "data_type": "string",
                                                        "description": "string",
                                                        "is_hidden": true,
                                                        "is_mandatory": true,
                                                        "label": "string",
                                                        "library_reference": "string",
                                                        "name": "string",
                                                        "options": {
                                                            "choices": [
                                                                "string"
                                                            ],
                                                            "type": "string"
                                                        },
                                                        "regex": {
                                                            "should_validate": true,
                                                            "value": "string"
                                                        },
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                        "val_type": "string",
                                                        "value": "string"
                                                    }
                                                ]
                                            }
                                        ],
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "config_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "description": "string",
                            "name": "string",
                            "service_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ],
                            "version": "string"
                        }
                    ],
                    "percent_fault_tolerance": 0,
                    "published_service_list": [
                        {
                            "action_list": [
                                {
                                    "critical": false,
                                    "description": "string",
                                    "name": "string",
                                    "runbook": {
                                        "description": "string",
                                        "main_task_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "name": "string",
                                        "task_definition_list": [
                                            {
                                                "child_tasks_local_reference_list": [
                                                    {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    }
                                                ],
                                                "description": "string",
                                                "exec_target_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "inherit_target": true,
                                                "name": "string",
                                                "retries": "string",
                                                "target_any_local_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "timeout_secs": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "variable_list": [
                                                    {
                                                        "data_type": "string",
                                                        "description": "string",
                                                        "is_hidden": true,
                                                        "is_mandatory": true,
                                                        "label": "string",
                                                        "library_reference": "string",
                                                        "name": "string",
                                                        "options": {
                                                            "choices": [
                                                                "string"
                                                            ],
                                                            "type": "string"
                                                        },
                                                        "regex": {
                                                            "should_validate": true,
                                                            "value": "string"
                                                        },
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                        "val_type": "string",
                                                        "value": "string"
                                                    }
                                                ]
                                            }
                                        ],
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "config_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "depends_on_list": [
                                {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "name": "string",
                            "port_list": [
                                {
                                    "endpoint_name": "string",
                                    "exposed_address": "string",
                                    "exposed_port": "string",
                                    "protocol": "string",
                                    "target_port": "string",
                                    "type": "string"
                                }
                            ],
                            "singleton": false,
                            "tier": "string",
                            "type": "K8S_SERVICE",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "service_list": [
                        {
                            "action_list": [
                                {
                                    "critical": false,
                                    "description": "string",
                                    "name": "string",
                                    "runbook": {
                                        "description": "string",
                                        "main_task_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "name": "string",
                                        "task_definition_list": [
                                            {
                                                "child_tasks_local_reference_list": [
                                                    {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    }
                                                ],
                                                "description": "string",
                                                "exec_target_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "inherit_target": true,
                                                "name": "string",
                                                "retries": "string",
                                                "target_any_local_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "timeout_secs": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "variable_list": [
                                                    {
                                                        "data_type": "string",
                                                        "description": "string",
                                                        "is_hidden": true,
                                                        "is_mandatory": true,
                                                        "label": "string",
                                                        "library_reference": "string",
                                                        "name": "string",
                                                        "options": {
                                                            "choices": [
                                                                "string"
                                                            ],
                                                            "type": "string"
                                                        },
                                                        "regex": {
                                                            "should_validate": true,
                                                            "value": "string"
                                                        },
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                        "val_type": "string",
                                                        "value": "string"
                                                    }
                                                ]
                                            }
                                        ],
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "config_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "depends_on_list": [
                                {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "name": "string",
                            "port_list": [
                                {
                                    "endpoint_name": "string",
                                    "exposed_address": "string",
                                    "exposed_port": "string",
                                    "protocol": "string",
                                    "target_port": "string",
                                    "type": "string"
                                }
                            ],
                            "singleton": false,
                            "tier": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "state": "string",
                    "substrate": {
                        "action_list": [
                            {
                                "critical": false,
                                "description": "string",
                                "name": "string",
                                "runbook": {
                                    "description": "string",
                                    "main_task_local_reference": {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    },
                                    "name": "string",
                                    "task_definition_list": [
                                        {
                                            "child_tasks_local_reference_list": [
                                                {
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                }
                                            ],
                                            "description": "string",
                                            "exec_target_reference": {
                                                "categories": {
                                                    "property1": "string",
                                                    "property2": "string"
                                                },
                                                "kind": "string",
                                                "name": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "inherit_target": true,
                                            "name": "string",
                                            "retries": "string",
                                            "target_any_local_reference": {
                                                "categories": {
                                                    "property1": "string",
                                                    "property2": "string"
                                                },
                                                "kind": "string",
                                                "name": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "timeout_secs": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        }
                                    ],
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "variable_list": [
                                        {
                                            "data_type": "string",
                                            "description": "string",
                                            "is_hidden": true,
                                            "is_mandatory": true,
                                            "label": "string",
                                            "library_reference": "string",
                                            "name": "string",
                                            "options": {
                                                "choices": [
                                                    "string"
                                                ],
                                                "type": "string"
                                            },
                                            "regex": {
                                                "should_validate": true,
                                                "value": "string"
                                            },
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "val_type": "string",
                                            "value": "string"
                                        }
                                    ]
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            }
                        ],
                        "config_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "description": "string",
                        "instance_address": "string",
                        "instance_id": "string",
                        "instance_name": "string",
                        "instance_power_state": "string",
                        "name": "string",
                        "os_type": "string",
                        "platform_data": "string",
                        "readiness_probe": {
                            "address": "string",
                            "connection_port": 22,
                            "connection_protocol": "string",
                            "connection_type": "string",
                            "delay_secs": "string",
                            "disable_readiness_probe": true,
                            "login_credential_local_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "retries": "5",
                            "timeout_secs": "string"
                        },
                        "recovery_point_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "tunnel_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    },
                    "type": "GREENFIELD",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "environment_reference_list": [
                "string"
            ],
            "patch_list": [
                {
                    "attrs_list": [
                        {}
                    ],
                    "config_reference_list": [
                        {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "is_system_generated": false,
                    "name": "string",
                    "runbook": {
                        "description": "string",
                        "main_task_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "name": "string",
                        "task_definition_list": [
                            {
                                "child_tasks_local_reference_list": [
                                    {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "exec_target_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "inherit_target": true,
                                "name": "string",
                                "retries": "string",
                                "target_any_local_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "timeout_secs": "string",
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "published_service_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "restore_config_list": [
                {
                    "attrs_list": [
                        {}
                    ],
                    "config_reference_list": [
                        {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "is_system_generated": false,
                    "name": "string",
                    "runbook": {
                        "description": "string",
                        "main_task_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "name": "string",
                        "task_definition_list": [
                            {
                                "child_tasks_local_reference_list": [
                                    {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "exec_target_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "inherit_target": true,
                                "name": "string",
                                "retries": "string",
                                "target_any_local_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "timeout_secs": "string",
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "snapshot_config_list": [
                {
                    "attrs_list": [
                        {}
                    ],
                    "config_reference_list": [
                        {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "is_system_generated": false,
                    "name": "string",
                    "runbook": {
                        "description": "string",
                        "main_task_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "name": "string",
                        "task_definition_list": [
                            {
                                "child_tasks_local_reference_list": [
                                    {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "exec_target_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "inherit_target": true,
                                "name": "string",
                                "retries": "string",
                                "target_any_local_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "timeout_secs": "string",
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "variable_list": [
                {
                    "data_type": "string",
                    "description": "string",
                    "is_hidden": true,
                    "is_mandatory": true,
                    "label": "string",
                    "library_reference": "string",
                    "name": "string",
                    "options": {
                        "choices": [
                            "string"
                        ],
                        "type": "string"
                    },
                    "regex": {
                        "should_validate": true,
                        "value": "string"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "val_type": "string",
                    "value": "string"
                }
            ]
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Credential update api

This will update the secret and passphrase of the credentials

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Application UUID

Request Body schema: application/json
required
required
object (Spec for application credential update)

Spec for application credential update

api_version
required
string
required
object (app metadata)

The app kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/credential/update \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "resources": {
            "credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ]
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Delete application

Deletes the specified application.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "kind": "app",
  • "code": 0,
  • "message_list": [
    ],
  • "state": "string",
  • "api_version": "3.1.0"
}

Delete unreachable vms

Delete all unreachable vms in app

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/unreachable_vms \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "kind": "app",
  • "code": 0,
  • "message_list": [
    ],
  • "state": "string",
  • "api_version": "3.1.0"
}

Download all action logs of an application

Downloads the output files of all the action logs for the specified application.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/output/download \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
"string"

Download runlog output file

Downloads the output file of the specified application runlog.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

runlog_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Runlog UUID to get

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/app_runlogs/{runlog_uuid}/output/download \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
"string"

Get app action variables

Retrieves variables defined on the specified application action.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

action_name
required
string

Action name whose variables are to be fetched

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/actions/{action_name}/variables \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
[
  • {
    }
]

Get application

Retrieves the specified application.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get application's blueprint

Retrieves the source blueprint used for the specified application.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/blueprints/original \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Get consumption details

Retrieves the consumption details for the specified application.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

query Parameters
limit
number
offset
number
Request Body schema: application/json
required
group_by
string

Group by attribute

time_unit
required
string

Grannularity of consumption data

object

Filter consumption data

object

Time range for cunsumption data

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/consumption \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filters": {
        "cluster_ids": [
            "string"
        ],
        "entity_ids": [
            "string"
        ],
        "entity_names": [
            "string"
        ],
        "entity_tags": {},
        "entity_types": [
            "string"
        ],
        "providers": [
            "string"
        ]
    },
    "group_by": "string",
    "time_range": {
        "end_time": 0,
        "start_time": 0,
        "time_delta": 0
    },
    "time_unit": "string"
}'

Response samples

Content type
application/json
{
  • "total_spend": 0,
  • "data_available_till": 0,
  • "entries": [
    ],
  • "next": "string",
  • "currency": "string"
}

Get dynamic variable values

Initiates execution of escript/http request configured for the specific variable and returns the final value.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

variable_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Variable UUID

Request Body schema: application/json
required
trlId
string

trl ID of the initiated execution

overridden_field
string

will be used to override several field for http request or eScript value

requestId
string

Request ID

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/variables/{variable_uuid}/values \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "overridden_field": "string",
    "requestId": "string",
    "trlId": "string"
}'

Response samples

Content type
application/json
{
  • "trl_id": "string",
  • "state": "string",
  • "run_id": "string",
  • "values": [
    ],
  • "request_id": "string"
}

Get dynamic variable values

Initiates execution of escript/http request configured for the specific variable and returns the final value.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

app UUID to get

variable_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of variable whose value needs to be fetched

query Parameters
trlId
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

trl ID of the initiated execution

requestId
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Request ID

overridden_field
string

will be used to override several field for http request or eScript value

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/variables/{variable_uuid}/values \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "trl_id": "string",
  • "state": "string",
  • "run_id": "string",
  • "values": [
    ],
  • "request_id": "string"
}

Get modified application blueprint

Returns the modified blueprint if the blueprint has been modified. It will throw an error if there is no modification in the blueprint after launch.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/blueprints/new \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Get published service element

Retrieves the published substrate element specified, from the application.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

published_service_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Uuid of published service element to get

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/published_services/{published_service_uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "singleton": false,
  • "description": "string",
  • "action_list": [
    ],
  • "element_list": [
    ],
  • "type": "K8S_SERVICE",
  • "depends_on_list": [
    ],
  • "name": "string",
  • "config_reference": {
    },
  • "state": "string",
  • "port_list": [
    ],
  • "editables": { },
  • "tier": "string",
  • "message_list": [
    ],
  • "options": { },
  • "variable_list": [
    ],
  • "uuid": "string"
}

Get runlog

Retrieves the specified application runlog information.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

runlog_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Runlog UUID to get

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/app_runlogs/{runlog_uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Get runlog output

Retrieves last ten lines of output of the specified application runlog.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

runlog_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Runlog UUID to get

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/app_runlogs/{runlog_uuid}/output \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Get script output

Retrives the output for the script run with data included in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Application UUID to get

trlid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

trl UUID of the script

ergon_task_id
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Ergont task UUID

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/run_script/output/{trlid}/{ergon_task_id} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "output": "string",
  • "state": "string"
}

Get substrate element

Retrieves the specified substrate element from the application.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

substrate_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Uuid of substrate element to get

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/substrates/{substrate_uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "instance_name": "string",
  • "account_reference": {
    },
  • "recovery_point_reference": {
    },
  • "readiness_probe": {
    },
  • "config_reference": {
    },
  • "description": "string",
  • "platform_data": "string",
  • "instance_address": "string",
  • "uuid": "string",
  • "state": "string",
  • "tunnel_reference": {
    },
  • "editables": { },
  • "message_list": [
    ],
  • "variable_list": [
    ],
  • "instance_power_state": "string",
  • "action_list": [
    ],
  • "element_list": [
    ],
  • "create_spec": { },
  • "name": "string",
  • "type": "string",
  • "instance_id": "string",
  • "os_type": "string"
}

Import nutanix brownfield app

Imports a nutanix brownfield application

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

service_name
required
string
service_ip
required
string

vm ip

account_reference
required
string

Nutanix PC account to which this VM belongs

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/brownfield \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "account_reference": "string",
    "service_ip": "string",
    "service_name": "string"
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List application runlogs

Retrieves the list of runlogs associated with the application, applying filter provided (if any) in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
kind
string
Default: "app_runlog"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/app_runlogs/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "app_runlog",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string",
  • "metadata": {
    }
}

List applications

Retrieves the list of applications, applying filters provided (if any) in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "app"

The kind name

object (Supported filters in app list call)

Supported filters in app list call

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "advanced_filter": {
        "account_reference_list": [
            "string"
        ],
        "cluster_reference_list": [
            "string"
        ],
        "environment_reference_list": [
            "string"
        ],
        "project_reference_list": [
            "string"
        ],
        "subnet_reference_list": [
            "string"
        ],
        "tunnel_reference_list": [
            "string"
        ],
        "vm_name_list": [
            "string"
        ],
        "vpc_reference_list": [
            "string"
        ]
    },
    "filter": "string",
    "kind": "app",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List consumptions for the given application uuids

Retrieves the consumption information for the provided application UUIDs.

Authorizations:
basicAuth
query Parameters
limit
number
offset
number
Request Body schema: application/json
required
group_by
string

Group by attribute

time_unit
required
string

Grannularity of consumption data

object

Filter consumption data

object

Time range for cunsumption data

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/consumption_list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filters": {
        "cluster_ids": [
            "string"
        ],
        "entity_ids": [
            "string"
        ],
        "entity_names": [
            "string"
        ],
        "entity_tags": {},
        "entity_types": [
            "string"
        ],
        "providers": [
            "string"
        ]
    },
    "group_by": "string",
    "time_range": {
        "end_time": 0,
        "start_time": 0,
        "time_delta": 0
    },
    "time_unit": "string"
}'

Response samples

Content type
application/json
{
  • "total_spend": 0,
  • "data_available_till": 0,
  • "entries": [
    ],
  • "next": "string",
  • "currency": "string"
}

List recovery groups

Retrieves the list of all the recovery groups under a substrate.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
kind
string
Default: "app"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/recovery_groups/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "app",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ]
}

List recovery points

Retrieves the list of all the recovery points under a substrate.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

substrate_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Substrate UUID

Request Body schema: application/json
required
kind
string
Default: "app"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/substrates/{substrate_uuid}/recovery_points/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "app",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ]
}

Rerun app runlog

Reruns the specified failed app runlog.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

app uuid

runlog_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Runlog UUID to rerun

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/app_runlogs/{runlog_uuid}/rerun \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Run action(with name)

Runs the specified application action on provided target.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
Array of objects (Argument format for action run)

Argument that need to be passed in action run. It is a dictionary of name-values.

name
required
string

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/actions/run \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "args": [
        {
            "name": "string",
            "task_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
            "value": "string"
        }
    ],
    "name": "string"
}'

Response samples

Content type
application/json
{
  • "runlog_uuid": "string"
}

Run action(with UUID)

Runs the specified application action on provided target.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

action_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Action UUID to execute

Request Body schema: application/json
required
required
object (Spec for action launch.)

Spec for action launch.

api_version
required
string
required
object (app metadata)

The app kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/actions/{action_uuid}/run \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "args": [
            {
                "name": "string",
                "task_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                "value": "string"
            }
        ],
        "target_kind": "string",
        "target_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Run Patch(with UUID)

Run the specified patch on the application.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

patch_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Patch UUID to execute

Request Body schema: application/json
required
required
object (Spec for patch run.)

Spec for patch run.

api_version
required
string
required
object (app metadata)

The app kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/patch/{patch_uuid}/run \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "args": {
            "patch": {
                "attrs_list": [
                    {}
                ],
                "config_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "description": "string",
                "is_system_generated": false,
                "name": "string",
                "runbook": {
                    "description": "string",
                    "main_task_local_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "task_definition_list": [
                        {
                            "child_tasks_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "exec_target_reference": {
                                "categories": {
                                    "property1": "string",
                                    "property2": "string"
                                },
                                "kind": "string",
                                "name": "string",
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "inherit_target": true,
                            "name": "string",
                            "retries": "string",
                            "target_any_local_reference": {
                                "categories": {
                                    "property1": "string",
                                    "property2": "string"
                                },
                                "kind": "string",
                                "name": "string",
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "timeout_secs": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                },
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                "variable_list": [
                    {
                        "data_type": "string",
                        "description": "string",
                        "is_hidden": true,
                        "is_mandatory": true,
                        "label": "string",
                        "library_reference": "string",
                        "name": "string",
                        "options": {
                            "choices": [
                                "string"
                            ],
                            "type": "string"
                        },
                        "regex": {
                            "should_validate": true,
                            "value": "string"
                        },
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "val_type": "string",
                        "value": "string"
                    }
                ]
            },
            "variables": [
                {
                    "name": "string",
                    "task_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "value": "string"
                }
            ]
        },
        "target_kind": "string",
        "target_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Run script

Runs the script with data included in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

application UUID

Request Body schema: application/json
required
required
object (script input spec)

script input spec

api_version
string

api version

object (app metadata)

The app kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/run_script \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "machine": "string",
        "port": "string",
        "provider_operation_payload": "string",
        "runid": "string"
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "metadata": {
    }
}

Sync application

Synchronises the specified application on beam.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/beamsync \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Response samples

Content type
application/json
{
  • "kind": "app",
  • "code": 0,
  • "message_list": [
    ],
  • "state": "string",
  • "api_version": "3.1.0"
}

Update application

Updates the specified application using data included in the request

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
required
object (app Intent Spec with placement specified)

An intentful representation of a app spec

required
object (app metadata)

The app kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "action_list": [
                {
                    "critical": false,
                    "description": "string",
                    "name": "string",
                    "runbook": {
                        "description": "string",
                        "main_task_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "name": "string",
                        "task_definition_list": [
                            {
                                "child_tasks_local_reference_list": [
                                    {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "exec_target_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "inherit_target": true,
                                "name": "string",
                                "retries": "string",
                                "target_any_local_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "timeout_secs": "string",
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "app_blueprint_config_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "app_blueprint_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "app_profile_config_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "application_url": "string",
            "cloned_from_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "credential_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "default_credential_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "dependency_list": [
                {
                    "action_name": "string",
                    "action_resource_kind": "string",
                    "action_resource_name": "string",
                    "from_resource_kind": "string",
                    "getter_resource_kind": "string",
                    "getter_resource_name": "string",
                    "setter_resource_attr": "string",
                    "setter_resource_kind": "string",
                    "setter_resource_name": "string"
                }
            ],
            "deployment_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "brownfield_instance_list": [
                        {
                            "address": [
                                "string"
                            ],
                            "instance_id": "string",
                            "instance_name": "string",
                            "nic_index": 0,
                            "power_state": "string"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "default_replicas": "string",
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "fault_domain_scope": "string",
                    "max_replicas": "1",
                    "min_replicas": "1",
                    "name": "string",
                    "num_fault_tolerance": 0,
                    "package_list": [
                        {
                            "action_list": [
                                {
                                    "critical": false,
                                    "description": "string",
                                    "name": "string",
                                    "runbook": {
                                        "description": "string",
                                        "main_task_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "name": "string",
                                        "task_definition_list": [
                                            {
                                                "child_tasks_local_reference_list": [
                                                    {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    }
                                                ],
                                                "description": "string",
                                                "exec_target_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "inherit_target": true,
                                                "name": "string",
                                                "retries": "string",
                                                "target_any_local_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "timeout_secs": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "variable_list": [
                                                    {
                                                        "data_type": "string",
                                                        "description": "string",
                                                        "is_hidden": true,
                                                        "is_mandatory": true,
                                                        "label": "string",
                                                        "library_reference": "string",
                                                        "name": "string",
                                                        "options": {
                                                            "choices": [
                                                                "string"
                                                            ],
                                                            "type": "string"
                                                        },
                                                        "regex": {
                                                            "should_validate": true,
                                                            "value": "string"
                                                        },
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                        "val_type": "string",
                                                        "value": "string"
                                                    }
                                                ]
                                            }
                                        ],
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "config_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "description": "string",
                            "name": "string",
                            "service_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ],
                            "version": "string"
                        }
                    ],
                    "percent_fault_tolerance": 0,
                    "published_service_list": [
                        {
                            "action_list": [
                                {
                                    "critical": false,
                                    "description": "string",
                                    "name": "string",
                                    "runbook": {
                                        "description": "string",
                                        "main_task_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "name": "string",
                                        "task_definition_list": [
                                            {
                                                "child_tasks_local_reference_list": [
                                                    {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    }
                                                ],
                                                "description": "string",
                                                "exec_target_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "inherit_target": true,
                                                "name": "string",
                                                "retries": "string",
                                                "target_any_local_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "timeout_secs": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "variable_list": [
                                                    {
                                                        "data_type": "string",
                                                        "description": "string",
                                                        "is_hidden": true,
                                                        "is_mandatory": true,
                                                        "label": "string",
                                                        "library_reference": "string",
                                                        "name": "string",
                                                        "options": {
                                                            "choices": [
                                                                "string"
                                                            ],
                                                            "type": "string"
                                                        },
                                                        "regex": {
                                                            "should_validate": true,
                                                            "value": "string"
                                                        },
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                        "val_type": "string",
                                                        "value": "string"
                                                    }
                                                ]
                                            }
                                        ],
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "config_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "depends_on_list": [
                                {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "name": "string",
                            "port_list": [
                                {
                                    "endpoint_name": "string",
                                    "exposed_address": "string",
                                    "exposed_port": "string",
                                    "protocol": "string",
                                    "target_port": "string",
                                    "type": "string"
                                }
                            ],
                            "singleton": false,
                            "tier": "string",
                            "type": "K8S_SERVICE",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "service_list": [
                        {
                            "action_list": [
                                {
                                    "critical": false,
                                    "description": "string",
                                    "name": "string",
                                    "runbook": {
                                        "description": "string",
                                        "main_task_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "name": "string",
                                        "task_definition_list": [
                                            {
                                                "child_tasks_local_reference_list": [
                                                    {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    }
                                                ],
                                                "description": "string",
                                                "exec_target_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "inherit_target": true,
                                                "name": "string",
                                                "retries": "string",
                                                "target_any_local_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "timeout_secs": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "variable_list": [
                                                    {
                                                        "data_type": "string",
                                                        "description": "string",
                                                        "is_hidden": true,
                                                        "is_mandatory": true,
                                                        "label": "string",
                                                        "library_reference": "string",
                                                        "name": "string",
                                                        "options": {
                                                            "choices": [
                                                                "string"
                                                            ],
                                                            "type": "string"
                                                        },
                                                        "regex": {
                                                            "should_validate": true,
                                                            "value": "string"
                                                        },
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                        "val_type": "string",
                                                        "value": "string"
                                                    }
                                                ]
                                            }
                                        ],
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "config_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "depends_on_list": [
                                {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "name": "string",
                            "port_list": [
                                {
                                    "endpoint_name": "string",
                                    "exposed_address": "string",
                                    "exposed_port": "string",
                                    "protocol": "string",
                                    "target_port": "string",
                                    "type": "string"
                                }
                            ],
                            "singleton": false,
                            "tier": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "state": "string",
                    "substrate": {
                        "action_list": [
                            {
                                "critical": false,
                                "description": "string",
                                "name": "string",
                                "runbook": {
                                    "description": "string",
                                    "main_task_local_reference": {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    },
                                    "name": "string",
                                    "task_definition_list": [
                                        {
                                            "child_tasks_local_reference_list": [
                                                {
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                }
                                            ],
                                            "description": "string",
                                            "exec_target_reference": {
                                                "categories": {
                                                    "property1": "string",
                                                    "property2": "string"
                                                },
                                                "kind": "string",
                                                "name": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "inherit_target": true,
                                            "name": "string",
                                            "retries": "string",
                                            "target_any_local_reference": {
                                                "categories": {
                                                    "property1": "string",
                                                    "property2": "string"
                                                },
                                                "kind": "string",
                                                "name": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "timeout_secs": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        }
                                    ],
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "variable_list": [
                                        {
                                            "data_type": "string",
                                            "description": "string",
                                            "is_hidden": true,
                                            "is_mandatory": true,
                                            "label": "string",
                                            "library_reference": "string",
                                            "name": "string",
                                            "options": {
                                                "choices": [
                                                    "string"
                                                ],
                                                "type": "string"
                                            },
                                            "regex": {
                                                "should_validate": true,
                                                "value": "string"
                                            },
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "val_type": "string",
                                            "value": "string"
                                        }
                                    ]
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            }
                        ],
                        "config_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "description": "string",
                        "instance_address": "string",
                        "instance_id": "string",
                        "instance_name": "string",
                        "instance_power_state": "string",
                        "name": "string",
                        "os_type": "string",
                        "platform_data": "string",
                        "readiness_probe": {
                            "address": "string",
                            "connection_port": 22,
                            "connection_protocol": "string",
                            "connection_type": "string",
                            "delay_secs": "string",
                            "disable_readiness_probe": true,
                            "login_credential_local_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "retries": "5",
                            "timeout_secs": "string"
                        },
                        "recovery_point_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "tunnel_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    },
                    "type": "GREENFIELD",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "environment_reference_list": [
                "string"
            ],
            "patch_list": [
                {
                    "attrs_list": [
                        {}
                    ],
                    "config_reference_list": [
                        {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "is_system_generated": false,
                    "name": "string",
                    "runbook": {
                        "description": "string",
                        "main_task_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "name": "string",
                        "task_definition_list": [
                            {
                                "child_tasks_local_reference_list": [
                                    {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "exec_target_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "inherit_target": true,
                                "name": "string",
                                "retries": "string",
                                "target_any_local_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "timeout_secs": "string",
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "published_service_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "restore_config_list": [
                {
                    "attrs_list": [
                        {}
                    ],
                    "config_reference_list": [
                        {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "is_system_generated": false,
                    "name": "string",
                    "runbook": {
                        "description": "string",
                        "main_task_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "name": "string",
                        "task_definition_list": [
                            {
                                "child_tasks_local_reference_list": [
                                    {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "exec_target_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "inherit_target": true,
                                "name": "string",
                                "retries": "string",
                                "target_any_local_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "timeout_secs": "string",
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "snapshot_config_list": [
                {
                    "attrs_list": [
                        {}
                    ],
                    "config_reference_list": [
                        {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "is_system_generated": false,
                    "name": "string",
                    "runbook": {
                        "description": "string",
                        "main_task_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "name": "string",
                        "task_definition_list": [
                            {
                                "child_tasks_local_reference_list": [
                                    {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "exec_target_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "inherit_target": true,
                                "name": "string",
                                "retries": "string",
                                "target_any_local_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "timeout_secs": "string",
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "variable_list": [
                {
                    "data_type": "string",
                    "description": "string",
                    "is_hidden": true,
                    "is_mandatory": true,
                    "label": "string",
                    "library_reference": "string",
                    "name": "string",
                    "options": {
                        "choices": [
                            "string"
                        ],
                        "type": "string"
                    },
                    "regex": {
                        "should_validate": true,
                        "value": "string"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "val_type": "string",
                    "value": "string"
                }
            ]
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Update application blueprint

Updates the blueprint for the specified application using data included in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Application UUID to be updated

Request Body schema: application/json
required
required
object (App blueprint input for application edit)

App blueprint input for application edit

api_version
required
string
required
object (blueprint metadata)

The blueprint kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/blueprints/new \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "environment_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
        "name": "string",
        "resources": {
            "app_profile_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "application_url": "string",
                    "deployment_create_list": [
                        {
                            "action_list": [
                                {
                                    "critical": false,
                                    "description": "string",
                                    "name": "string",
                                    "runbook": {
                                        "description": "string",
                                        "main_task_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "name": "string",
                                        "task_definition_list": [
                                            {
                                                "child_tasks_local_reference_list": [
                                                    {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    }
                                                ],
                                                "description": "string",
                                                "exec_target_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "inherit_target": true,
                                                "name": "string",
                                                "retries": "string",
                                                "target_any_local_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "timeout_secs": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "variable_list": [
                                                    {
                                                        "data_type": "string",
                                                        "description": "string",
                                                        "is_hidden": true,
                                                        "is_mandatory": true,
                                                        "label": "string",
                                                        "library_reference": "string",
                                                        "name": "string",
                                                        "options": {
                                                            "choices": [
                                                                "string"
                                                            ],
                                                            "type": "string"
                                                        },
                                                        "regex": {
                                                            "should_validate": true,
                                                            "value": "string"
                                                        },
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                        "val_type": "string",
                                                        "value": "string"
                                                    }
                                                ]
                                            }
                                        ],
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "brownfield_instance_list": [
                                {
                                    "address": [
                                        "string"
                                    ],
                                    "instance_id": "string",
                                    "instance_name": "string",
                                    "nic_index": 0,
                                    "power_state": "string"
                                }
                            ],
                            "default_replicas": "string",
                            "depends_on_list": [
                                {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "fault_domain_scope": "string",
                            "max_replicas": "1",
                            "min_replicas": "1",
                            "name": "string",
                            "num_fault_tolerance": 0,
                            "package_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "percent_fault_tolerance": 0,
                            "published_service_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "substrate_local_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "type": "GREENFIELD",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "description": "string",
                    "environment_reference_list": [
                        "string"
                    ],
                    "name": "string",
                    "patch_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "published_service_local_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "restore_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "snapshot_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "default_credential_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "endpoint_definition_list": [
                {
                    "description": "string",
                    "name": "string",
                    "resources": {
                        "name": "string",
                        "provider_type": "string",
                        "tunnel_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "type": "string",
                        "value_type": "string"
                    }
                }
            ],
            "endpoints_mapping": {
                "property1": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                },
                "property2": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                }
            },
            "package_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "name": "string",
                    "service_local_reference_list": [
                        {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ],
                    "version": "string"
                }
            ],
            "published_service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "type": "K8S_SERVICE",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "substrate_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "instance_address": "string",
                    "instance_id": "string",
                    "instance_name": "string",
                    "instance_power_state": "string",
                    "name": "string",
                    "os_type": "string",
                    "platform_data": "string",
                    "readiness_probe": {
                        "address": "string",
                        "connection_port": 22,
                        "connection_protocol": "string",
                        "connection_type": "string",
                        "delay_secs": "string",
                        "disable_readiness_probe": true,
                        "login_credential_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "retries": "5",
                        "timeout_secs": "string"
                    },
                    "recovery_point_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "tunnel_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "type": "string"
        },
        "source_marketplace_name": "string",
        "source_marketplace_version": "string"
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Usage of the credential in all tasks

Usage of the credential in all tasks

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Application UUID

cred_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Credential UUID

Request Body schema: application/json
required
required
object (App blueprint input for application edit)

App blueprint input for application edit

api_version
required
string
required
object (blueprint metadata)

The blueprint kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/credential/{cred_uuid}/usage \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "environment_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
        "name": "string",
        "resources": {
            "app_profile_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "application_url": "string",
                    "deployment_create_list": [
                        {
                            "action_list": [
                                {
                                    "critical": false,
                                    "description": "string",
                                    "name": "string",
                                    "runbook": {
                                        "description": "string",
                                        "main_task_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "name": "string",
                                        "task_definition_list": [
                                            {
                                                "child_tasks_local_reference_list": [
                                                    {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    }
                                                ],
                                                "description": "string",
                                                "exec_target_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "inherit_target": true,
                                                "name": "string",
                                                "retries": "string",
                                                "target_any_local_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "timeout_secs": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "variable_list": [
                                                    {
                                                        "data_type": "string",
                                                        "description": "string",
                                                        "is_hidden": true,
                                                        "is_mandatory": true,
                                                        "label": "string",
                                                        "library_reference": "string",
                                                        "name": "string",
                                                        "options": {
                                                            "choices": [
                                                                "string"
                                                            ],
                                                            "type": "string"
                                                        },
                                                        "regex": {
                                                            "should_validate": true,
                                                            "value": "string"
                                                        },
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                        "val_type": "string",
                                                        "value": "string"
                                                    }
                                                ]
                                            }
                                        ],
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "brownfield_instance_list": [
                                {
                                    "address": [
                                        "string"
                                    ],
                                    "instance_id": "string",
                                    "instance_name": "string",
                                    "nic_index": 0,
                                    "power_state": "string"
                                }
                            ],
                            "default_replicas": "string",
                            "depends_on_list": [
                                {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "fault_domain_scope": "string",
                            "max_replicas": "1",
                            "min_replicas": "1",
                            "name": "string",
                            "num_fault_tolerance": 0,
                            "package_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "percent_fault_tolerance": 0,
                            "published_service_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "substrate_local_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "type": "GREENFIELD",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "description": "string",
                    "environment_reference_list": [
                        "string"
                    ],
                    "name": "string",
                    "patch_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "published_service_local_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "restore_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "snapshot_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "default_credential_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "endpoint_definition_list": [
                {
                    "description": "string",
                    "name": "string",
                    "resources": {
                        "name": "string",
                        "provider_type": "string",
                        "tunnel_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "type": "string",
                        "value_type": "string"
                    }
                }
            ],
            "endpoints_mapping": {
                "property1": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                },
                "property2": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                }
            },
            "package_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "name": "string",
                    "service_local_reference_list": [
                        {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ],
                    "version": "string"
                }
            ],
            "published_service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "type": "K8S_SERVICE",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "substrate_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "instance_address": "string",
                    "instance_id": "string",
                    "instance_name": "string",
                    "instance_power_state": "string",
                    "name": "string",
                    "os_type": "string",
                    "platform_data": "string",
                    "readiness_probe": {
                        "address": "string",
                        "connection_port": 22,
                        "connection_protocol": "string",
                        "connection_type": "string",
                        "delay_secs": "string",
                        "disable_readiness_probe": true,
                        "login_credential_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "retries": "5",
                        "timeout_secs": "string"
                    },
                    "recovery_point_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "tunnel_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "type": "string"
        },
        "source_marketplace_name": "string",
        "source_marketplace_version": "string"
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Validate application blueprint

Validates updated application blueprint for the specified application.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Application UUID

Request Body schema: application/json
required
required
object (App blueprint input for application edit)

App blueprint input for application edit

api_version
required
string
required
object (blueprint metadata)

The blueprint kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/apps/{uuid}/blueprints/new/validate \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "environment_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
        "name": "string",
        "resources": {
            "app_profile_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "application_url": "string",
                    "deployment_create_list": [
                        {
                            "action_list": [
                                {
                                    "critical": false,
                                    "description": "string",
                                    "name": "string",
                                    "runbook": {
                                        "description": "string",
                                        "main_task_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "name": "string",
                                        "task_definition_list": [
                                            {
                                                "child_tasks_local_reference_list": [
                                                    {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    }
                                                ],
                                                "description": "string",
                                                "exec_target_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "inherit_target": true,
                                                "name": "string",
                                                "retries": "string",
                                                "target_any_local_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "timeout_secs": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "variable_list": [
                                                    {
                                                        "data_type": "string",
                                                        "description": "string",
                                                        "is_hidden": true,
                                                        "is_mandatory": true,
                                                        "label": "string",
                                                        "library_reference": "string",
                                                        "name": "string",
                                                        "options": {
                                                            "choices": [
                                                                "string"
                                                            ],
                                                            "type": "string"
                                                        },
                                                        "regex": {
                                                            "should_validate": true,
                                                            "value": "string"
                                                        },
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                        "val_type": "string",
                                                        "value": "string"
                                                    }
                                                ]
                                            }
                                        ],
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "brownfield_instance_list": [
                                {
                                    "address": [
                                        "string"
                                    ],
                                    "instance_id": "string",
                                    "instance_name": "string",
                                    "nic_index": 0,
                                    "power_state": "string"
                                }
                            ],
                            "default_replicas": "string",
                            "depends_on_list": [
                                {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "fault_domain_scope": "string",
                            "max_replicas": "1",
                            "min_replicas": "1",
                            "name": "string",
                            "num_fault_tolerance": 0,
                            "package_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "percent_fault_tolerance": 0,
                            "published_service_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "substrate_local_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "type": "GREENFIELD",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "description": "string",
                    "environment_reference_list": [
                        "string"
                    ],
                    "name": "string",
                    "patch_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "published_service_local_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "restore_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "snapshot_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "default_credential_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "endpoint_definition_list": [
                {
                    "description": "string",
                    "name": "string",
                    "resources": {
                        "name": "string",
                        "provider_type": "string",
                        "tunnel_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "type": "string",
                        "value_type": "string"
                    }
                }
            ],
            "endpoints_mapping": {
                "property1": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                },
                "property2": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                }
            },
            "package_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "name": "string",
                    "service_local_reference_list": [
                        {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ],
                    "version": "string"
                }
            ],
            "published_service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "type": "K8S_SERVICE",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "substrate_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "instance_address": "string",
                    "instance_id": "string",
                    "instance_name": "string",
                    "instance_power_state": "string",
                    "name": "string",
                    "os_type": "string",
                    "platform_data": "string",
                    "readiness_probe": {
                        "address": "string",
                        "connection_port": 22,
                        "connection_protocol": "string",
                        "connection_type": "string",
                        "delay_secs": "string",
                        "disable_readiness_probe": true,
                        "login_credential_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "retries": "5",
                        "timeout_secs": "string"
                    },
                    "recovery_point_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "tunnel_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "type": "string"
        },
        "source_marketplace_name": "string",
        "source_marketplace_version": "string"
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

aws/availability_zones

List all the AWS availability zones

List all the AWS roles. Supported filters are:

  • account_uuid
  • region Use account_uuid filter to list all the availability zones on a particular AWS account. Use the account_uuid and region filters together to list all the availability zones on a particular region of an AWS account .
Authorizations:
basicAuth
Request Body schema: application/json
required
filter
string

The filter used for the results

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/aws/v1/availability_zones/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string",
  • "metadata": {
    }
}

aws/images

List all AWS AMIs.

List AWS AMIs . Supported filters are:

  • account_uuid
  • region
  • is-public
  • name
  • image-id Use account_uuid to list images on a particular account. Use account_uuid and region filters together to list images belonging to a particular region. Provide name to limit the results to those AMI names containing the provided name Provide image-ids to limit the results to corresponding AMIs
Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "aws_image"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/aws/v1/images/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "aws_image",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string",
  • "metadata": {
    }
}

aws/key_pairs

List all the AWS key pairs

List all the AWS key pairs. Supported filters are:

  • account_uuid
  • region Use account_uuid filter to list all the key pairs on the default region of a particular AWS account. Use account_uuid and region filters together to list the key pairs on a particular region of an AWS account.
Authorizations:
basicAuth
Request Body schema: application/json
required
filter
string

The filter used for the results

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/aws/v1/key_pairs/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string",
  • "metadata": {
    }
}

aws/machine_types

List all the AWS machine types

List all the AWS machine types. No filters to be mentioned.

Authorizations:
basicAuth
Request Body schema: application/json
required
filter
string

The filter used for the results

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/aws/v1/machine_types/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string",
  • "metadata": {
    }
}

aws/mixed_images

List AWS mixed images

Retrieves the list of all mixed images available. Supported filters are:

  • account_uuid
  • region Use account_uuid to list images on a particular account. Use account_uuid and region filters together to list images belonging to a particular region.
Authorizations:
basicAuth
Request Body schema: application/json
required
filter
string

The filter used for the results

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/aws/v1/mixed_images/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string",
  • "metadata": {
    }
}

aws/regions

List all the AWS regions

List all the AWS regions. No filters to be mentioned.

Authorizations:
basicAuth
Request Body schema: application/json
required
object (Metadata for aws_region list)

All api calls will return aws regions

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/aws/v1/regions/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string",
  • "metadata": {
    }
}

aws/roles

List all the AWS roles

List all the AWS roles. Supported filters are:

  • account_uuid
  • region Use account_uuid filter to list all the roles on the default region of a particular AWS account. Use account_uuid and region filter together to list all the roles on a particular region of an aws_account.
Authorizations:
basicAuth
Request Body schema: application/json
required
filter
string

The filter used for the results

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/aws/v1/roles/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string",
  • "metadata": {
    }
}

aws/security_groups

List all AWS Security Groups

List all AWS Security Groups. Supported filters are:

  • account_uuid
  • region
  • vpc_id
  • include_classic_sg Use account_uuid to list all security groups on the default region of a particular AWS account. Use account_uuid and region filters together to list all security groups in a particular region. Use account_uuid, region and vpc_id filters together to list all security groups in a particular vpc. Set include_classic_sg filter to 'True' to also show EC2 classic security groups in the above three cases.
Authorizations:
basicAuth
Request Body schema: application/json
required
filter
string

The filter used for the results

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/aws/v1/security_groups/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string",
  • "metadata": {
    }
}

aws/subnets

List all AWS subnets.

List all AWS subnets. Supported filters are:

  • account_uuid
  • region
  • vpc_id
  • availability_zone Use account_uuid filter to list all the subnets on the default region of a particular account. Use account_uuid and region filters together to list the subnets on all VPCs and AZs of a particular region. Use account_uuid, region and vpc_id filter together to list the subnets on a particular VPC. Use account_uuid, region and availability_zone filter together to list the subnets on a particular AZ.
Authorizations:
basicAuth
Request Body schema: application/json
required
filter
string

The filter used for the results

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/aws/v1/subnets/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string",
  • "metadata": {
    }
}

aws/volume_types

List all the AWS volume types

List all the AWS volume types. No filters to be mentioned.

Authorizations:
basicAuth
Request Body schema: application/json
required
filter
string

The filter used for the results

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/aws/v1/volume_types/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string",
  • "metadata": {
    }
}

aws/vpcs

List all AWS VPCs

List all AWS VPCs. Supported filters are:

  • account_uuid
  • region Use account_uuid to list all VPCs on the default region of a particular AWS account. Use account_uuid and region filters together to list the VPCs in a particular region.
Authorizations:
basicAuth
Request Body schema: application/json
required
filter
string

The filter used for the results

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/aws/v1/vpcs/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string",
  • "metadata": {
    }
}

azure_rm/application_security_groups

List Azure application_security_groups

Retrieves the list of all application_security_groups available. Supported filters are:

  • account_uuid
  • location
  • resource_group
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/application_security_groups/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/availability_sets

List Azure availability_sets

Retrieves the list of all availability_sets available. Supported filters are:

  • account_uuid
  • resource_group
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/availability_sets/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/availability_zones

List Azure availability_zones

Retrieves the list of all availability_zones available. Supported filters are:

  • account_uuid
  • location
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/availability_zones/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/galleries

List Azure Shared Image Galleries

Retrieves the list of all galleries available. Supported filters are:

  • account_uuid
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/galleries/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/gallery_image_versions

List Azure Shared Gallery Image Versions

Retrieves the list of all gallery image version available. Supported filters are:

  • account_uuid
  • resource_group
  • gallery_name
  • image_name
  • location
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/gallery_image_versions/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/gallery_images

List Azure Shared Gallery Images

Retrieves the list of all gallery images available. Supported filters are:

  • account_uuid
  • resource_group
  • gallery_name
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/gallery_images/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/image_offers

List Azure image_offers

Retrieves the list of all image_offers available. Supported filters are:

  • account_uuid
  • location
  • publisher
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/image_offers/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/image_publishers

List Azure image_publishers

Retrieves the list of all image_publishers available. Supported filters are:

  • account_uuid
  • location
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/image_publishers/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/image_skus

List Azure image_skus

Retrieves the list of all image_skus available. Supported filters are:

  • account_uuid
  • location
  • publisher
  • offer
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/image_skus/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/image_versions

List Azure image_versions

Retrieves the list of all image_versions available. Supported filters are:

  • account_uuid
  • location
  • publisher
  • offer
  • sku
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/image_versions/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/images

List Azure images

Retrieves the list of all images available. Supported filters are:

  • account_uuid
  • location
  • publisher
  • offer
  • sku
  • version
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/images/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/locations

List Azure locations

Retrieves the list of all locations available. Supported filters are:

  • account_uuid
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/locations/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/resource_groups

List Azure resource_groups

Retrieves the list of all resource_groups available. Supported filters are:

  • account_uuid
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/resource_groups/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/security_groups

List Azure security_groups

Retrieves the list of all security_groups available. Supported filters are:

  • account_uuid
  • location
  • resource_group
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/security_groups/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/security_rules

List Azure security_rules

Retrieves the list of security_rules available. Required filters are:

  • account_uuid
  • network_security_group
  • resource_group
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/security_rules/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/storage_accounts

List Azure storage_accounts

Retrieves the list of all storage_accounts available. Supported filters are:

  • account_uuid
  • location
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/storage_accounts/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/subnets

List Azure subnets

Retrieves the list of all subscriptions available. Supported filters are:

  • account_uuid
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/subscriptions/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

List Azure subnets

Retrieves the list of all subnets available. Supported filters are:

  • account_uuid
  • location
  • resource_group
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/subnets/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/subscription_images

List Azure subscription_images

Retrieves the list of all subscription_images available. Supported filters are:

  • account_uuid
  • location
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/subscription_images/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/virtual_networks

List Azure virtual_networks

Retrieves the list of all virtual_networks available. Supported filters are:

  • account_uuid
  • location
  • resource_group
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/virtual_networks/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

azure_rm/vm_sizes

List Azure vm_sizes

Retrieves the list of all vm_sizes available. Supported filters are:

  • account_uuid
  • location
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/azure_rm/v1/vm_sizes/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

Blueprints

Abort script

Aborts the specified script run request using data provided in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Blueprint UUID to get

runid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

run id of the script

trlid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

trl UUID of the script

Request Body schema: application/json
required
required
object (abort script input spec)

abort script input spec

api_version
string

api version

object (blueprint metadata)

The blueprint kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/run_script/abort/{runid}/{trlid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {}
}'

Response samples

Content type
application/json
{ }

Clone blueprint

Clones the specified blueprint.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Blueprint UUID to be cloned

Request Body schema: application/json
required
blueprint_name
required
string <= 64 characters
required
object (blueprint metadata)

The blueprint kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/clone \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "blueprint_name": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    }
}'

Response samples

Content type
application/json
{
  • "blueprint_uuid": "string"
}

Create blueprint

Creates a blueprint using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (blueprint Intent Spec with placement specified)

An intentful representation of a blueprint spec

api_version
required
string
required
object (blueprint metadata)

The blueprint kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "app_profile_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "application_url": "string",
                    "deployment_create_list": [
                        {
                            "action_list": [
                                {
                                    "critical": false,
                                    "description": "string",
                                    "name": "string",
                                    "runbook": {
                                        "description": "string",
                                        "main_task_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "name": "string",
                                        "task_definition_list": [
                                            {
                                                "child_tasks_local_reference_list": [
                                                    {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    }
                                                ],
                                                "description": "string",
                                                "exec_target_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "inherit_target": true,
                                                "name": "string",
                                                "retries": "string",
                                                "target_any_local_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "timeout_secs": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "variable_list": [
                                                    {
                                                        "data_type": "string",
                                                        "description": "string",
                                                        "is_hidden": true,
                                                        "is_mandatory": true,
                                                        "label": "string",
                                                        "library_reference": "string",
                                                        "name": "string",
                                                        "options": {
                                                            "choices": [
                                                                "string"
                                                            ],
                                                            "type": "string"
                                                        },
                                                        "regex": {
                                                            "should_validate": true,
                                                            "value": "string"
                                                        },
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                        "val_type": "string",
                                                        "value": "string"
                                                    }
                                                ]
                                            }
                                        ],
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "brownfield_instance_list": [
                                {
                                    "address": [
                                        "string"
                                    ],
                                    "instance_id": "string",
                                    "instance_name": "string",
                                    "nic_index": 0,
                                    "power_state": "string"
                                }
                            ],
                            "default_replicas": "string",
                            "depends_on_list": [
                                {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "fault_domain_scope": "string",
                            "max_replicas": "1",
                            "min_replicas": "1",
                            "name": "string",
                            "num_fault_tolerance": 0,
                            "package_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "percent_fault_tolerance": 0,
                            "published_service_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "substrate_local_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "type": "GREENFIELD",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "description": "string",
                    "environment_reference_list": [
                        "string"
                    ],
                    "name": "string",
                    "patch_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "published_service_local_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "restore_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "snapshot_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "default_credential_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "endpoint_definition_list": [
                {
                    "description": "string",
                    "name": "string",
                    "resources": {
                        "name": "string",
                        "provider_type": "string",
                        "tunnel_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "type": "string",
                        "value_type": "string"
                    }
                }
            ],
            "endpoints_mapping": {
                "property1": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                },
                "property2": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                }
            },
            "package_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "name": "string",
                    "service_local_reference_list": [
                        {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ],
                    "version": "string"
                }
            ],
            "published_service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "type": "K8S_SERVICE",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "substrate_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "instance_address": "string",
                    "instance_id": "string",
                    "instance_name": "string",
                    "instance_power_state": "string",
                    "name": "string",
                    "os_type": "string",
                    "platform_data": "string",
                    "readiness_probe": {
                        "address": "string",
                        "connection_port": 22,
                        "connection_protocol": "string",
                        "connection_type": "string",
                        "delay_secs": "string",
                        "disable_readiness_probe": true,
                        "login_credential_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "retries": "5",
                        "timeout_secs": "string"
                    },
                    "recovery_point_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "tunnel_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "type": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Delete blueprint

Deletes the specified blueprint.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Blueprint UUID to be deleted

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Download blueprint

Downloads the specified blueprint in JSON format

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Blueprint UUID to get

Request Body schema: multipart/form-data
passphrase
string

Passphrase to encrypt secrets

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/export_file \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: multipart/form-data' \
    --data '{
    "passphrase": "string"
}'

Response samples

Content type
application/json
null

Download blueprint

Downloads the specified blueprint in JSON format.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Blueprint UUID to get

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/export_file \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
null

Export blueprint

Retrieves the specified blueprint in JSON format.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Blueprint UUID to get

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/export_json \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Express launch marketplace item

Launches the marketplace item without environment patching using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
required
object (Express launch spec)

Details of the Marketplace item and project to be launched

api_version
required
string
required
object (blueprint metadata)

The blueprint kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/marketplace_express_launch \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "marketplace_item_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
        "project_uuid": "string"
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Get blueprint

Returns the specified blueprint.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Blueprint UUID to get

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get cost for app profile

Retrives the cost of blueprint for the given app profile taking into account all the deployments.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Blueprint UUID

app_profile_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

UUID of App Profile

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/app_profile/{app_profile_uuid}/cost \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "cost": "string",
  • "deployments": [
    ]
}

Get dynamic variable values

Initiates execution of escript/http request configured for the specific variable and returns the final value.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

variable_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Variable UUID

Request Body schema: application/json
required
trlId
string

trl ID of the initiated execution

overridden_field
string

will be used to override several field for http request or eScript value

requestId
string

Request ID

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/variables/{variable_uuid}/values \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "overridden_field": "string",
    "requestId": "string",
    "trlId": "string"
}'

Response samples

Content type
application/json
{
  • "trl_id": "string",
  • "state": "string",
  • "run_id": "string",
  • "values": [
    ],
  • "request_id": "string"
}

Get dynamic variable values

Initiates execution of escript/http request configured for the specific variable and returns the final value.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

blueprint UUID to get

variable_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of variable whose value needs to be fetched

query Parameters
trlId
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

trl ID of the initiated execution

requestId
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Request ID

overridden_field
string

will be used to override several field for http request or eScript value

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/variables/{variable_uuid}/values \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "trl_id": "string",
  • "state": "string",
  • "run_id": "string",
  • "values": [
    ],
  • "request_id": "string"
}

Get pending launch details

Retrieves the current status of blueprint launch for the specified launch id.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Blueprint UUID to get

launched_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Launch UUID

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/pending_launches/{launched_uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Get runtime variables

Retrieves all the runtime editables for the specified blueprint.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Blueprint UUID

query Parameters
app_profile_uuid
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Uuid of app profile

app_profile_name
string

Name of app profile

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/runtime_editables \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "resources": [
    ]
}

Get script output

Retrives the output for the script run with data included in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Blueprint UUID to get

trlid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

trl UUID of the script

ergon_task_id
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Ergont task UUID

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/run_script/output/{trlid}/{ergon_task_id} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "output": "string",
  • "state": "string"
}

Import blueprint

Creates a blueprint using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (App blueprint upload kind)

App blueprint upload kind

api_version
required
string
required
object (blueprint metadata)

The blueprint kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/import_json \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "app_profile_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "application_url": "string",
                    "deployment_create_list": [
                        {
                            "action_list": [
                                {
                                    "critical": false,
                                    "description": "string",
                                    "name": "string",
                                    "runbook": {
                                        "description": "string",
                                        "main_task_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "name": "string",
                                        "task_definition_list": [
                                            {
                                                "child_tasks_local_reference_list": [
                                                    {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    }
                                                ],
                                                "description": "string",
                                                "exec_target_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "inherit_target": true,
                                                "name": "string",
                                                "retries": "string",
                                                "target_any_local_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "timeout_secs": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "variable_list": [
                                                    {
                                                        "data_type": "string",
                                                        "description": "string",
                                                        "is_hidden": true,
                                                        "is_mandatory": true,
                                                        "label": "string",
                                                        "library_reference": "string",
                                                        "name": "string",
                                                        "options": {
                                                            "choices": [
                                                                "string"
                                                            ],
                                                            "type": "string"
                                                        },
                                                        "regex": {
                                                            "should_validate": true,
                                                            "value": "string"
                                                        },
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                        "val_type": "string",
                                                        "value": "string"
                                                    }
                                                ]
                                            }
                                        ],
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "brownfield_instance_list": [
                                {
                                    "address": [
                                        "string"
                                    ],
                                    "instance_id": "string",
                                    "instance_name": "string",
                                    "nic_index": 0,
                                    "power_state": "string"
                                }
                            ],
                            "default_replicas": "string",
                            "depends_on_list": [
                                {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "fault_domain_scope": "string",
                            "max_replicas": "1",
                            "min_replicas": "1",
                            "name": "string",
                            "num_fault_tolerance": 0,
                            "package_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "percent_fault_tolerance": 0,
                            "published_service_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "substrate_local_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "type": "GREENFIELD",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "description": "string",
                    "environment_reference_list": [
                        "string"
                    ],
                    "name": "string",
                    "patch_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "published_service_local_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "restore_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "snapshot_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "default_credential_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "endpoint_definition_list": [
                {
                    "description": "string",
                    "name": "string",
                    "resources": {
                        "name": "string",
                        "provider_type": "string",
                        "tunnel_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "type": "string",
                        "value_type": "string"
                    }
                }
            ],
            "endpoints_mapping": {
                "property1": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                },
                "property2": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                }
            },
            "package_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "name": "string",
                    "service_local_reference_list": [
                        {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ],
                    "version": "string"
                }
            ],
            "published_service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "type": "K8S_SERVICE",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "substrate_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "instance_address": "string",
                    "instance_id": "string",
                    "instance_name": "string",
                    "instance_power_state": "string",
                    "name": "string",
                    "os_type": "string",
                    "platform_data": "string",
                    "readiness_probe": {
                        "address": "string",
                        "connection_port": 22,
                        "connection_protocol": "string",
                        "connection_type": "string",
                        "delay_secs": "string",
                        "disable_readiness_probe": true,
                        "login_credential_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "retries": "5",
                        "timeout_secs": "string"
                    },
                    "recovery_point_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "tunnel_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "type": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "uuid": "string"
}

Launch blueprint

Launches the specified blueprint.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Blueprint UUID to be launched

Request Body schema: application/json
required
required
object (Spec for Blueprint launch.)

Spec for Blueprint launch.

api_version
required
string
required
object (blueprint metadata)

The blueprint kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/launch \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "app_profile_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "application_name": "string",
        "description": "string",
        "resources": {
            "app_profile_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "application_url": "string",
                    "deployment_create_list": [
                        {
                            "action_list": [
                                {
                                    "critical": false,
                                    "description": "string",
                                    "name": "string",
                                    "runbook": {
                                        "description": "string",
                                        "main_task_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "name": "string",
                                        "task_definition_list": [
                                            {
                                                "child_tasks_local_reference_list": [
                                                    {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    }
                                                ],
                                                "description": "string",
                                                "exec_target_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "inherit_target": true,
                                                "name": "string",
                                                "retries": "string",
                                                "target_any_local_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "timeout_secs": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "variable_list": [
                                                    {
                                                        "data_type": "string",
                                                        "description": "string",
                                                        "is_hidden": true,
                                                        "is_mandatory": true,
                                                        "label": "string",
                                                        "library_reference": "string",
                                                        "name": "string",
                                                        "options": {
                                                            "choices": [
                                                                "string"
                                                            ],
                                                            "type": "string"
                                                        },
                                                        "regex": {
                                                            "should_validate": true,
                                                            "value": "string"
                                                        },
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                        "val_type": "string",
                                                        "value": "string"
                                                    }
                                                ]
                                            }
                                        ],
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "brownfield_instance_list": [
                                {
                                    "address": [
                                        "string"
                                    ],
                                    "instance_id": "string",
                                    "instance_name": "string",
                                    "nic_index": 0,
                                    "power_state": "string"
                                }
                            ],
                            "default_replicas": "string",
                            "depends_on_list": [
                                {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "fault_domain_scope": "string",
                            "max_replicas": "1",
                            "min_replicas": "1",
                            "name": "string",
                            "num_fault_tolerance": 0,
                            "package_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "percent_fault_tolerance": 0,
                            "published_service_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "substrate_local_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "type": "GREENFIELD",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "description": "string",
                    "environment_reference_list": [
                        "string"
                    ],
                    "name": "string",
                    "patch_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "published_service_local_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "restore_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "snapshot_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "default_credential_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "endpoint_definition_list": [
                {
                    "description": "string",
                    "name": "string",
                    "resources": {
                        "name": "string",
                        "provider_type": "string",
                        "tunnel_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "type": "string",
                        "value_type": "string"
                    }
                }
            ],
            "endpoints_mapping": {
                "property1": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                },
                "property2": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                }
            },
            "package_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "name": "string",
                    "service_local_reference_list": [
                        {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ],
                    "version": "string"
                }
            ],
            "published_service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "type": "K8S_SERVICE",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "substrate_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "instance_address": "string",
                    "instance_id": "string",
                    "instance_name": "string",
                    "instance_power_state": "string",
                    "name": "string",
                    "os_type": "string",
                    "platform_data": "string",
                    "readiness_probe": {
                        "address": "string",
                        "connection_port": 22,
                        "connection_protocol": "string",
                        "connection_type": "string",
                        "delay_secs": "string",
                        "disable_readiness_probe": true,
                        "login_credential_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "retries": "5",
                        "timeout_secs": "string"
                    },
                    "recovery_point_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "tunnel_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "type": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Launch marketplace item

Launches the marketplace item using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
required
object (Spec for Blueprint launch.)

Spec for Blueprint launch.

api_version
required
string
required
object (blueprint metadata)

The blueprint kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/marketplace_launch \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "app_blueprint_name": "string",
        "description": "string",
        "environment_profile_pairs": [
            {
                "app_profile": {
                    "categories": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "kind": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "environment": {
                    "categories": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "kind": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "keep_secrets": false
            }
        ],
        "environment_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
        "resources": {
            "app_profile_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "application_url": "string",
                    "deployment_create_list": [
                        {
                            "action_list": [
                                {
                                    "critical": false,
                                    "description": "string",
                                    "name": "string",
                                    "runbook": {
                                        "description": "string",
                                        "main_task_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "name": "string",
                                        "task_definition_list": [
                                            {
                                                "child_tasks_local_reference_list": [
                                                    {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    }
                                                ],
                                                "description": "string",
                                                "exec_target_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "inherit_target": true,
                                                "name": "string",
                                                "retries": "string",
                                                "target_any_local_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "timeout_secs": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "variable_list": [
                                                    {
                                                        "data_type": "string",
                                                        "description": "string",
                                                        "is_hidden": true,
                                                        "is_mandatory": true,
                                                        "label": "string",
                                                        "library_reference": "string",
                                                        "name": "string",
                                                        "options": {
                                                            "choices": [
                                                                "string"
                                                            ],
                                                            "type": "string"
                                                        },
                                                        "regex": {
                                                            "should_validate": true,
                                                            "value": "string"
                                                        },
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                        "val_type": "string",
                                                        "value": "string"
                                                    }
                                                ]
                                            }
                                        ],
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "brownfield_instance_list": [
                                {
                                    "address": [
                                        "string"
                                    ],
                                    "instance_id": "string",
                                    "instance_name": "string",
                                    "nic_index": 0,
                                    "power_state": "string"
                                }
                            ],
                            "default_replicas": "string",
                            "depends_on_list": [
                                {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "fault_domain_scope": "string",
                            "max_replicas": "1",
                            "min_replicas": "1",
                            "name": "string",
                            "num_fault_tolerance": 0,
                            "package_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "percent_fault_tolerance": 0,
                            "published_service_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "substrate_local_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "type": "GREENFIELD",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "description": "string",
                    "environment_reference_list": [
                        "string"
                    ],
                    "name": "string",
                    "patch_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "published_service_local_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "restore_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "snapshot_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "default_credential_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "endpoint_definition_list": [
                {
                    "description": "string",
                    "name": "string",
                    "resources": {
                        "name": "string",
                        "provider_type": "string",
                        "tunnel_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "type": "string",
                        "value_type": "string"
                    }
                }
            ],
            "endpoints_mapping": {
                "property1": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                },
                "property2": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                }
            },
            "package_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "name": "string",
                    "service_local_reference_list": [
                        {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ],
                    "version": "string"
                }
            ],
            "published_service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "type": "K8S_SERVICE",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "substrate_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "instance_address": "string",
                    "instance_id": "string",
                    "instance_name": "string",
                    "instance_power_state": "string",
                    "name": "string",
                    "os_type": "string",
                    "platform_data": "string",
                    "readiness_probe": {
                        "address": "string",
                        "connection_port": 22,
                        "connection_protocol": "string",
                        "connection_type": "string",
                        "delay_secs": "string",
                        "disable_readiness_probe": true,
                        "login_credential_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "retries": "5",
                        "timeout_secs": "string"
                    },
                    "recovery_point_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "tunnel_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "type": "string"
        },
        "source_marketplace_name": "string",
        "source_marketplace_version": "string"
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Launch the blueprint

Launch the given blueprint.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Blueprint UUID to be launched

Request Body schema: application/json
required
required
object (Spec for Blueprint launch.)

Spec for Blueprint launch.

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/simple_launch \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "spec": {
        "app_description": "string",
        "app_name": "string",
        "app_profile_reference": {
            "kind": "app_profile",
            "name": "string",
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "runtime_editables": {
            "action_list": [
                {
                    "description": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "app_profile": {
                "description": "string",
                "name": "string",
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "credential_list": [
                {
                    "description": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "deployment_list": [
                {
                    "description": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "package_list": [
                {
                    "description": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "restore_config_list": [
                {
                    "description": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "service_list": [
                {
                    "description": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "snapshot_config_list": [
                {
                    "description": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "substrate_list": [
                {
                    "description": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "task_list": [
                {
                    "description": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "variable_list": [
                {
                    "description": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ]
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    }
}

List blueprint

Retrieves the list of blueprints, applying filters provided (if any) in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "blueprint"

The kind name

object (Supported filters in blueprint list call)

Supported filters in blueprint list call

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "advanced_filter": {
        "account_reference_list": [
            "string"
        ],
        "cluster_reference_list": [
            "string"
        ],
        "environment_reference_list": [
            "string"
        ],
        "project_reference_list": [
            "string"
        ],
        "subnet_reference_list": [
            "string"
        ],
        "tunnel_reference_list": [
            "string"
        ],
        "vpc_reference_list": [
            "string"
        ]
    },
    "filter": "string",
    "kind": "blueprint",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List brownfield import vms

Retrieves a list of all the blueprint launch pending request. Supported filters are:

  • platform_type
  • account_uuid
  • platform_filters.
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

kind
string
Default: "blueprint"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/brownfield_import/vms/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "blueprint",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{ }

List pending launches

Retrieves a list of all pending launch requests for the specified blueprint

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "blueprint"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/pending_launches/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "blueprint",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entites": [
    ],
  • "api_version": "string",
  • "metadata": {
    }
}

Patch blueprint

Patch the specified app profiles in the blueprint with the specified environments

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
required
object (Spec for blueprint patch patch request)

Spec for blueprint patch request

api_version
required
string
required
object (blueprint metadata)

The blueprint kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/patch_with_environment \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "environment_profile_pairs": [
            {
                "app_profile": {
                    "categories": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "kind": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "environment": {
                    "categories": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "kind": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "keep_secrets": false
            }
        ],
        "new_blueprint": {
            "name": "string",
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Run script

Runs the script with data included in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Blueprint UUID to get

Request Body schema: application/json
required
required
object (script input spec)

script input spec

api_version
string

api version

object (blueprint metadata)

The blueprint kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/run_script \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "machine": "string",
        "port": "string",
        "provider_operation_payload": "string",
        "runid": "string"
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "metadata": {
    }
}

Update blueprint

Updates the specified blueprint using data included in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Blueprint UUID to be updated

Request Body schema: application/json
required
required
object (blueprint Intent Spec with placement specified)

An intentful representation of a blueprint spec

api_version
required
string
required
object (blueprint metadata)

The blueprint kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "app_profile_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "application_url": "string",
                    "deployment_create_list": [
                        {
                            "action_list": [
                                {
                                    "critical": false,
                                    "description": "string",
                                    "name": "string",
                                    "runbook": {
                                        "description": "string",
                                        "main_task_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "name": "string",
                                        "task_definition_list": [
                                            {
                                                "child_tasks_local_reference_list": [
                                                    {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    }
                                                ],
                                                "description": "string",
                                                "exec_target_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "inherit_target": true,
                                                "name": "string",
                                                "retries": "string",
                                                "target_any_local_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "timeout_secs": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "variable_list": [
                                                    {
                                                        "data_type": "string",
                                                        "description": "string",
                                                        "is_hidden": true,
                                                        "is_mandatory": true,
                                                        "label": "string",
                                                        "library_reference": "string",
                                                        "name": "string",
                                                        "options": {
                                                            "choices": [
                                                                "string"
                                                            ],
                                                            "type": "string"
                                                        },
                                                        "regex": {
                                                            "should_validate": true,
                                                            "value": "string"
                                                        },
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                        "val_type": "string",
                                                        "value": "string"
                                                    }
                                                ]
                                            }
                                        ],
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "brownfield_instance_list": [
                                {
                                    "address": [
                                        "string"
                                    ],
                                    "instance_id": "string",
                                    "instance_name": "string",
                                    "nic_index": 0,
                                    "power_state": "string"
                                }
                            ],
                            "default_replicas": "string",
                            "depends_on_list": [
                                {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "fault_domain_scope": "string",
                            "max_replicas": "1",
                            "min_replicas": "1",
                            "name": "string",
                            "num_fault_tolerance": 0,
                            "package_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "percent_fault_tolerance": 0,
                            "published_service_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "substrate_local_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "type": "GREENFIELD",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "description": "string",
                    "environment_reference_list": [
                        "string"
                    ],
                    "name": "string",
                    "patch_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "published_service_local_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "restore_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "snapshot_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "default_credential_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "endpoint_definition_list": [
                {
                    "description": "string",
                    "name": "string",
                    "resources": {
                        "name": "string",
                        "provider_type": "string",
                        "tunnel_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "type": "string",
                        "value_type": "string"
                    }
                }
            ],
            "endpoints_mapping": {
                "property1": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                },
                "property2": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                }
            },
            "package_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "name": "string",
                    "service_local_reference_list": [
                        {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ],
                    "version": "string"
                }
            ],
            "published_service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "type": "K8S_SERVICE",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "substrate_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "instance_address": "string",
                    "instance_id": "string",
                    "instance_name": "string",
                    "instance_power_state": "string",
                    "name": "string",
                    "os_type": "string",
                    "platform_data": "string",
                    "readiness_probe": {
                        "address": "string",
                        "connection_port": 22,
                        "connection_protocol": "string",
                        "connection_type": "string",
                        "delay_secs": "string",
                        "disable_readiness_probe": true,
                        "login_credential_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "retries": "5",
                        "timeout_secs": "string"
                    },
                    "recovery_point_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "tunnel_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "type": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Upload blueprint

Creates a blueprint from uploaded file.

Authorizations:
basicAuth
Request Body schema: application/octet-stream
required

blueprint_file

object

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/import_file \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/octet-stream' \

Response samples

Content type
application/json
{
  • "uuid": "string"
}

Validate blueprint

Validate the given blueprint spec.

Authorizations:
basicAuth
Request Body schema: application/json
required
required
object (blueprint Intent Spec with placement specified)

An intentful representation of a blueprint spec

api_version
required
string
required
object (blueprint metadata)

The blueprint kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/validate \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "app_profile_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "application_url": "string",
                    "deployment_create_list": [
                        {
                            "action_list": [
                                {
                                    "critical": false,
                                    "description": "string",
                                    "name": "string",
                                    "runbook": {
                                        "description": "string",
                                        "main_task_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "name": "string",
                                        "task_definition_list": [
                                            {
                                                "child_tasks_local_reference_list": [
                                                    {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    }
                                                ],
                                                "description": "string",
                                                "exec_target_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "inherit_target": true,
                                                "name": "string",
                                                "retries": "string",
                                                "target_any_local_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "timeout_secs": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "variable_list": [
                                                    {
                                                        "data_type": "string",
                                                        "description": "string",
                                                        "is_hidden": true,
                                                        "is_mandatory": true,
                                                        "label": "string",
                                                        "library_reference": "string",
                                                        "name": "string",
                                                        "options": {
                                                            "choices": [
                                                                "string"
                                                            ],
                                                            "type": "string"
                                                        },
                                                        "regex": {
                                                            "should_validate": true,
                                                            "value": "string"
                                                        },
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                        "val_type": "string",
                                                        "value": "string"
                                                    }
                                                ]
                                            }
                                        ],
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "brownfield_instance_list": [
                                {
                                    "address": [
                                        "string"
                                    ],
                                    "instance_id": "string",
                                    "instance_name": "string",
                                    "nic_index": 0,
                                    "power_state": "string"
                                }
                            ],
                            "default_replicas": "string",
                            "depends_on_list": [
                                {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "fault_domain_scope": "string",
                            "max_replicas": "1",
                            "min_replicas": "1",
                            "name": "string",
                            "num_fault_tolerance": 0,
                            "package_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "percent_fault_tolerance": 0,
                            "published_service_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "substrate_local_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "type": "GREENFIELD",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "description": "string",
                    "environment_reference_list": [
                        "string"
                    ],
                    "name": "string",
                    "patch_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "published_service_local_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "restore_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "snapshot_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "default_credential_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "endpoint_definition_list": [
                {
                    "description": "string",
                    "name": "string",
                    "resources": {
                        "name": "string",
                        "provider_type": "string",
                        "tunnel_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "type": "string",
                        "value_type": "string"
                    }
                }
            ],
            "endpoints_mapping": {
                "property1": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                },
                "property2": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                }
            },
            "package_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "name": "string",
                    "service_local_reference_list": [
                        {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ],
                    "version": "string"
                }
            ],
            "published_service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "type": "K8S_SERVICE",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "substrate_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "instance_address": "string",
                    "instance_id": "string",
                    "instance_name": "string",
                    "instance_power_state": "string",
                    "name": "string",
                    "os_type": "string",
                    "platform_data": "string",
                    "readiness_probe": {
                        "address": "string",
                        "connection_port": 22,
                        "connection_protocol": "string",
                        "connection_type": "string",
                        "delay_secs": "string",
                        "disable_readiness_probe": true,
                        "login_credential_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "retries": "5",
                        "timeout_secs": "string"
                    },
                    "recovery_point_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "tunnel_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "type": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Validate blueprint patching

Validate if the specified app-profiles in the blueprint can be patched with the specified environments

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
required
object (Spec for blueprint patch validate.)

Spec for blueprint patch validate.

api_version
required
string
required
object (blueprint metadata)

The blueprint kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/patch_with_environment/validate \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "environment_profile_pairs": [
            {
                "app_profile": {
                    "categories": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "kind": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "environment": {
                    "categories": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "kind": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "keep_secrets": false
            }
        ]
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Validate launch params

Validates given launch params

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Blueprint UUID to be launched

Request Body schema: application/json
required
required
object (Spec for Blueprint launch.)

Spec for Blueprint launch.

api_version
required
string
required
object (blueprint metadata)

The blueprint kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/blueprints/{uuid}/validate_launch \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "app_profile_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "application_name": "string",
        "description": "string",
        "resources": {
            "app_profile_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "application_url": "string",
                    "deployment_create_list": [
                        {
                            "action_list": [
                                {
                                    "critical": false,
                                    "description": "string",
                                    "name": "string",
                                    "runbook": {
                                        "description": "string",
                                        "main_task_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "name": "string",
                                        "task_definition_list": [
                                            {
                                                "child_tasks_local_reference_list": [
                                                    {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    }
                                                ],
                                                "description": "string",
                                                "exec_target_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "inherit_target": true,
                                                "name": "string",
                                                "retries": "string",
                                                "target_any_local_reference": {
                                                    "categories": {
                                                        "property1": "string",
                                                        "property2": "string"
                                                    },
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                },
                                                "timeout_secs": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "variable_list": [
                                                    {
                                                        "data_type": "string",
                                                        "description": "string",
                                                        "is_hidden": true,
                                                        "is_mandatory": true,
                                                        "label": "string",
                                                        "library_reference": "string",
                                                        "name": "string",
                                                        "options": {
                                                            "choices": [
                                                                "string"
                                                            ],
                                                            "type": "string"
                                                        },
                                                        "regex": {
                                                            "should_validate": true,
                                                            "value": "string"
                                                        },
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                        "val_type": "string",
                                                        "value": "string"
                                                    }
                                                ]
                                            }
                                        ],
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "brownfield_instance_list": [
                                {
                                    "address": [
                                        "string"
                                    ],
                                    "instance_id": "string",
                                    "instance_name": "string",
                                    "nic_index": 0,
                                    "power_state": "string"
                                }
                            ],
                            "default_replicas": "string",
                            "depends_on_list": [
                                {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "fault_domain_scope": "string",
                            "max_replicas": "1",
                            "min_replicas": "1",
                            "name": "string",
                            "num_fault_tolerance": 0,
                            "package_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "percent_fault_tolerance": 0,
                            "published_service_local_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "substrate_local_reference": {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            },
                            "type": "GREENFIELD",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "description": "string",
                    "environment_reference_list": [
                        "string"
                    ],
                    "name": "string",
                    "patch_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "published_service_local_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "restore_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "snapshot_config_list": [
                        {
                            "attrs_list": [
                                {}
                            ],
                            "config_reference_list": [
                                {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                }
                            ],
                            "description": "string",
                            "is_system_generated": false,
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "variable_list": [
                                {
                                    "data_type": "string",
                                    "description": "string",
                                    "is_hidden": true,
                                    "is_mandatory": true,
                                    "label": "string",
                                    "library_reference": "string",
                                    "name": "string",
                                    "options": {
                                        "choices": [
                                            "string"
                                        ],
                                        "type": "string"
                                    },
                                    "regex": {
                                        "should_validate": true,
                                        "value": "string"
                                    },
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                    "val_type": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ],
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "default_credential_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "endpoint_definition_list": [
                {
                    "description": "string",
                    "name": "string",
                    "resources": {
                        "name": "string",
                        "provider_type": "string",
                        "tunnel_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "type": "string",
                        "value_type": "string"
                    }
                }
            ],
            "endpoints_mapping": {
                "property1": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                },
                "property2": {
                    "kind": "string",
                    "name": "string",
                    "uuid": "string"
                }
            },
            "package_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "name": "string",
                    "service_local_reference_list": [
                        {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ],
                    "version": "string"
                }
            ],
            "published_service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "type": "K8S_SERVICE",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "service_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "depends_on_list": [
                        {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "port_list": [
                        {
                            "endpoint_name": "string",
                            "exposed_address": "string",
                            "exposed_port": "string",
                            "protocol": "string",
                            "target_port": "string",
                            "type": "string"
                        }
                    ],
                    "singleton": false,
                    "tier": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "substrate_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "instance_address": "string",
                    "instance_id": "string",
                    "instance_name": "string",
                    "instance_power_state": "string",
                    "name": "string",
                    "os_type": "string",
                    "platform_data": "string",
                    "readiness_probe": {
                        "address": "string",
                        "connection_port": 22,
                        "connection_protocol": "string",
                        "connection_type": "string",
                        "delay_secs": "string",
                        "disable_readiness_probe": true,
                        "login_credential_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "retries": "5",
                        "timeout_secs": "string"
                    },
                    "recovery_point_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "tunnel_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "type": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

dm_groups

List the entities in the Nutanix Central

List the entities present in the NC, either from the NC models, IDF, or ElasticSearch(future proof)

Authorizations:
basicAuth

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/dm_groups1 \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Response samples

Content type
application/json
{
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Endpoints

Create endpoint

Creates an endpoint using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (endpoint Intent Spec with placement specified)

An intentful representation of a endpoint spec

api_version
required
string
required
object (endpoint metadata)

The endpoint kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/endpoints \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "name": "string",
            "provider_type": "string",
            "tunnel_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "type": "string",
            "value_type": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Delete endpoint

Deletes the specified endpoint.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/endpoints/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Download endpoint

Downloads the specified endpoint in JSON format with secrets encrypted.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Endpoint UUID to get

Request Body schema: multipart/form-data
passphrase
string

Passphrase to encrypt secrets

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/endpoints/{uuid}/export_file \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: multipart/form-data' \
    --data '{
    "passphrase": "string"
}'

Response samples

Content type
application/json
null

Download endpoint

Downloads the specified endpoint in JSON format.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Endpoint UUID to get

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/endpoints/{uuid}/export_file \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
null

Export endpoint

Retrieves the specified endpoint in JSON format.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Endpoint UUID to get

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/endpoints/{uuid}/export_json \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Get endpoint

Returns the specified endpoint.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/endpoints/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Import endpoint

Creates an endpoint using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (title endpoint upload kind)

title endpoint upload kind

api_version
required
string
required
object (endpoint metadata)

The endpoint kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/endpoints/import_json \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "description": "string",
        "name": "string",
        "resources": {
            "name": "string",
            "provider_type": "string",
            "tunnel_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "type": "string",
            "value_type": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "uuid": "string"
}

List endpoints

Retrieves the list of endpoints, applying filters provided (if any) in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "endpoint"

The kind name

object (Supported filters in endpoint list call)

Supported filters in endpoint list call

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/endpoints/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "advanced_filter": {
        "account_reference_list": [
            "string"
        ],
        "project_reference_list": [
            "string"
        ],
        "tunnel_reference_list": [
            "string"
        ]
    },
    "filter": "string",
    "kind": "endpoint",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Update endpoint

Updates the specified endpoint using data included in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
required
object (endpoint Intent Spec with placement specified)

An intentful representation of a endpoint spec

api_version
required
string
required
object (endpoint metadata)

The endpoint kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/endpoints/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "name": "string",
            "provider_type": "string",
            "tunnel_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "type": "string",
            "value_type": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Upload endpoint

Creates an endpoint from uploaded file.

Authorizations:
basicAuth
Request Body schema: application/octet-stream
required

Request body

object

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/endpoints/import_file \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/octet-stream' \

Response samples

Content type
application/json
{
  • "uuid": "string"
}

environments

Create Environment

Given a spec creates a Environment with associated metadata

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (environment Intent Spec with placement specified)

An intentful representation of a environment spec

required
object (environment metadata)

The environment kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/environments \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "infra_inclusion_list": [
                {
                    "account_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                }
            ],
            "substrate_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "instance_address": "string",
                    "instance_id": "string",
                    "instance_name": "string",
                    "instance_power_state": "string",
                    "name": "string",
                    "os_type": "string",
                    "platform_data": "string",
                    "readiness_probe": {
                        "address": "string",
                        "connection_port": 22,
                        "connection_protocol": "string",
                        "connection_type": "string",
                        "delay_secs": "string",
                        "disable_readiness_probe": true,
                        "login_credential_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "retries": "5",
                        "timeout_secs": "string"
                    },
                    "recovery_point_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "tunnel_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "variable_list": [
                {
                    "data_type": "string",
                    "description": "string",
                    "is_hidden": true,
                    "is_mandatory": true,
                    "label": "string",
                    "library_reference": "string",
                    "name": "string",
                    "options": {
                        "choices": [
                            "string"
                        ],
                        "type": "string"
                    },
                    "regex": {
                        "should_validate": true,
                        "value": "string"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "val_type": "string",
                    "value": "string"
                }
            ]
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Delete Environment

Delete a Environment given its UUID

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of the environment to be deleted

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/environments/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get Environment

Given a UUID, returns a Environment definition

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of Environment to get

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/environments/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List the Environment

List the Environment with associated metadata

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "environment"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/environments/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "environment",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Return the usage details for an environment

Return the environment usage details

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
object (Environment usage filter body)

Environment usage filter body

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/environments/{uuid}/usage \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": {
        "account_reference_list": [
            "string"
        ],
        "cluster_reference_list": [
            "string"
        ],
        "subnet_reference_list": [
            "string"
        ],
        "vpc_reference_list": [
            "string"
        ]
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string"
}

Update Environment

Given a spec and Environment UUID, update Environment

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of environment to be updated

Request Body schema: application/json
required
required
object (environment Intent Spec with placement specified)

An intentful representation of a environment spec

required
object (environment metadata)

The environment kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/environments/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "infra_inclusion_list": [
                {
                    "account_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                }
            ],
            "substrate_definition_list": [
                {
                    "action_list": [
                        {
                            "critical": false,
                            "description": "string",
                            "name": "string",
                            "runbook": {
                                "description": "string",
                                "main_task_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "task_definition_list": [
                                    {
                                        "child_tasks_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "exec_target_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "inherit_target": true,
                                        "name": "string",
                                        "retries": "string",
                                        "target_any_local_reference": {
                                            "categories": {
                                                "property1": "string",
                                                "property2": "string"
                                            },
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string",
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "timeout_secs": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        }
                    ],
                    "config_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "instance_address": "string",
                    "instance_id": "string",
                    "instance_name": "string",
                    "instance_power_state": "string",
                    "name": "string",
                    "os_type": "string",
                    "platform_data": "string",
                    "readiness_probe": {
                        "address": "string",
                        "connection_port": 22,
                        "connection_protocol": "string",
                        "connection_type": "string",
                        "delay_secs": "string",
                        "disable_readiness_probe": true,
                        "login_credential_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "retries": "5",
                        "timeout_secs": "string"
                    },
                    "recovery_point_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "tunnel_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "variable_list": [
                {
                    "data_type": "string",
                    "description": "string",
                    "is_hidden": true,
                    "is_mandatory": true,
                    "label": "string",
                    "library_reference": "string",
                    "name": "string",
                    "options": {
                        "choices": [
                            "string"
                        ],
                        "type": "string"
                    },
                    "regex": {
                        "should_validate": true,
                        "value": "string"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "val_type": "string",
                    "value": "string"
                }
            ]
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Features

Download Policy Engine VM status logs

Downloads the Policy Engine VM status logs

Authorizations:
basicAuth

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/features/policy/download_logs \
    --header 'Accept: application/octet-stream' \
    --header 'Authorization: Basic <basic_auth_token>' \

Get current behaviour for feature

Get current behaviour for feature

Authorizations:
basicAuth
path Parameters
name
required
string

Name of the feature to get

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/features/{name}/status \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get current behaviour for feature - Approval Policy

Get current behaviour for feature - Approval Policy

Authorizations:
basicAuth

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/features/approval_policy \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get current behaviour for feature - Policy Engine

Get current behaviour for feature - Policy Engine

Authorizations:
basicAuth

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/features/policy \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get current behaviour for feature - SAML Support

Get current behaviour for feature - SAML Support

Authorizations:
basicAuth

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/features/project_saml \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get current behaviour for feature - Self-Service Detected DR

Get current behaviour for feature - Self-Service Detected DR

Authorizations:
basicAuth

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/features/calm_detected_dr \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get current behaviour for feature - Self-Service Orchestrated DR

Get current behaviour for feature - Self-Service Orchestrated DR

Authorizations:
basicAuth

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/features/calm_orch_dr \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get logs for Policy Engine enablement

Get logs for Policy Engine enablement

Authorizations:
basicAuth

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/features/policy/output \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get precheck status for enablement of Policy Engine

Get precheck status for enablement of Policy Engine

Authorizations:
basicAuth

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/features/policy/prechecks \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": { },
  • "api_version": "3.1.0"
}

Set behaviour for feature - Approval Policy

Set behaviour for feature - Approval Policy

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object
required
object (calm_feature metadata)

The calm_feature kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/features/approval_policy \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "feature_status": {
            "is_enabled": true,
            "settings": {
                "email_settings": {
                    "approver_email_template": {
                        "body": {
                            "content": "string",
                            "content_type": "string"
                        },
                        "subject": "string"
                    },
                    "requester_email_template": {
                        "body": {
                            "content": "string",
                            "content_type": "string"
                        },
                        "subject": "string"
                    }
                },
                "expiry": {
                    "interval_type": "string",
                    "multiple": 0
                }
            },
            "ui_visibility": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Set behaviour for feature - Policy Engine

Set behaviour for feature - Policy Engine

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object
required
object (calm_feature metadata)

The calm_feature kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/features/policy \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "feature_status": {
            "is_enabled": true,
            "is_ignored": true
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Set behaviour for feature - SAML Support

Set behaviour for feature - SAML Support

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object
required
object (calm_feature metadata)

The calm_feature kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/features/project_saml \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "feature_status": {
            "ui_visibility": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Set behaviour for feature - Self-Service Detected DR

Set behaviour for feature - Self-Service Detected DR

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object
required
object (calm_feature metadata)

The calm_feature kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/features/calm_detected_dr \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "feature_status": {
            "ui_visibility": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Set behaviour for feature - Self-Service Orchestrated DR

Set behaviour for feature - Self-Service Orchestrated DR

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object
required
object (calm_feature metadata)

The calm_feature kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/features/calm_orch_dr \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "feature_status": {
            "is_enabled": true,
            "ui_visibility": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

gcp/disk_types

Get Google cloud disk types

List all disk types present in a zone. Supported filters are:

  • account_uuid
  • zone
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/gcp/v1/disk_types/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

gcp/firewalls

Get Google cloud firewalls

List all firewalls available for a project. Supported filters are:

  • account_uuid
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/gcp/v1/firewalls/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

gcp/images

Get Google cloud images

List all images available for a GCP account. Supported filters are:

  • account_uuid
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/gcp/v1/images/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

gcp/instances

Get gcp vm

Given a UUID, returns a gcp vm

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of gcp instance

account_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of account

zone_name
required
string

zone name for gcp account

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/gcp/v1/accounts/{account_uuid}/zone/{zone_name}/instances/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{ }

Get Google cloud vm instances

List all VM's present in a zone. Supported filters are:

  • account_uuid
  • zone
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/gcp/v1/instances/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

gcp/machine_types

Get Google cloud machine types

List all machine types present in a zone. Supported filters are:

  • account_uuid
  • zone
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/gcp/v1/machine_types/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

gcp/networks

Get Google cloud networks

List all network interfaces present in a zone. Supported filters are:

  • account_uuid
  • zone
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/gcp/v1/networks/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

gcp/persistent_disks

Get Google cloud persistent disks

List all persistent disks present in a zone. Supported filters are:

  • account_uuid
  • zone
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/gcp/v1/persistent_disks/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

gcp/regions

Get Google cloud regions

List all regions present available for a GCP account. Supported filters are:

  • account_uuid
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/gcp/v1/regions/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

gcp/snapshots

Get Google cloud snapshots

List all snapshots available for a GCP account. Supported filters are:

  • account_uuid
  • zone
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/gcp/v1/snapshots/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

gcp/subnetworks

Get Google cloud subnetworks

List all subnetworks available for a GCP account. Supported filters are:

  • account_uuid
  • zone
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/gcp/v1/subnetworks/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

gcp/zones

Get Google cloud zones

List all zones available for a GCP account. Supported filters are:

  • account_uuid
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/gcp/v1/zones/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

JobInstances

List job instances

Retrieves the list of job instances, applying filters provided (if any) in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
kind
string
Default: "job_instance"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1
Default: 20

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/jobs/{uuid}/instances \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "job_instance",
    "length": 20,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string",
  • "metadata": {
    }
}

Jobs

Create job

Creates an job using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

object (job spec)
api_version
required
string
required
object (job intent Enitity)

Restful represtation of the job

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/jobs \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "resources": {
        "description": "string",
        "executable": {
            "action": {
                "spec": {
                    "payload": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "type": "string"
            },
            "entity": {
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "uuid": "string"
        },
        "name": "string",
        "schedule_info": {
            "execution_time": "string",
            "expiry_time": "string",
            "schedule": "string",
            "start_time": "string",
            "time_zone": "string"
        },
        "skip_concurrent_execution": false,
        "type": "string"
    }
}'

Response samples

Content type
application/json
{
  • "resources": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Delete job

Delete the job matching the UUID.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/jobs/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "resources": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

List jobs

Retrieves the list of jobs, applying filters provided (if any) in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "job"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1
Default: 20

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/jobs/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "job",
    "length": 20,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string",
  • "metadata": {
    }
}

Update job

Updates the job using data included in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required

Request body

object (job spec)
api_version
required
string
required
object (job intent Enitity)

Restful represtation of the job

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/jobs/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "resources": {
        "description": "string",
        "executable": {
            "action": {
                "spec": {
                    "payload": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "type": "string"
            },
            "entity": {
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "uuid": "string"
        },
        "name": "string",
        "schedule_info": {
            "execution_time": "string",
            "expiry_time": "string",
            "schedule": "string",
            "start_time": "string",
            "time_zone": "string"
        },
        "skip_concurrent_execution": false,
        "type": "string"
    }
}'

Response samples

Content type
application/json
{
  • "resources": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

View job

View the job matching the UUID.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/jobs/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "resources": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

kubernetes/karbon_clusters

List Clusters in Karbon managed K8s cluster

Retrieves the list of all Karbon managed K8s cluster. Supported filters are:

  • account_uuid
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/kubernetes/v1/karbon/clusters/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

license

Get the Self-Service consumption for all the clusters

Gets the consumption for all the clusters

Authorizations:
basicAuth
query Parameters
limit
number
offset
number

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/license/consumption \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Response samples

Content type
application/json
{
  • "unique_active_vms": 0,
  • "active_vms": 0,
  • "existing_vms_consumption": {
    },
  • "required_packs": 0,
  • "unique_active_containers": 0,
  • "active_containers": 0,
  • "applied_packs": 0,
  • "account_wise_consumption": {
    },
  • "cluster_wise_consumption": {
    }
}

Marketplace Icons

Create app icon for marketplace

Creates an marketplace icon object using data included in the request and returns metadata of created image object.

Authorizations:
basicAuth
Request Body schema: multipart/form-data
required

icon file

any <binary>

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/icons/constant/marketplace/upload \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: multipart/form-data' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Marketplace Items

Create marketplace item

Creates a marketplace item using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
required
object (Marketplace item information)

Detailed spec for creation of an marketplace item

required
object (marketplace_item metadata)

The marketplace_item kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_marketplace_items \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "description": "string",
        "name": "string",
        "resources": {
            "app_attribute_list": [
                "string"
            ],
            "app_blueprint_template": {
                "spec": {
                    "availability_zone_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cluster_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "name": "string",
                    "resources": {
                        "app_profile_list": [
                            {
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "name": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "name": "string",
                                                    "retries": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "application_url": "string",
                                "deployment_create_list": [
                                    {
                                        "action_list": [
                                            {
                                                "critical": false,
                                                "description": "string",
                                                "name": "string",
                                                "runbook": {
                                                    "description": "string",
                                                    "main_task_local_reference": {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "name": "string",
                                                    "task_definition_list": [
                                                        {
                                                            "child_tasks_local_reference_list": [
                                                                {
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                                }
                                                            ],
                                                            "description": "string",
                                                            "exec_target_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "inherit_target": true,
                                                            "name": "string",
                                                            "retries": "string",
                                                            "target_any_local_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "timeout_secs": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "variable_list": [
                                                                {
                                                                    "data_type": "string",
                                                                    "description": "string",
                                                                    "is_hidden": true,
                                                                    "is_mandatory": true,
                                                                    "label": "string",
                                                                    "library_reference": "string",
                                                                    "name": "string",
                                                                    "options": {
                                                                        "choices": [
                                                                            "string"
                                                                        ],
                                                                        "type": "string"
                                                                    },
                                                                    "regex": {
                                                                        "should_validate": true,
                                                                        "value": "string"
                                                                    },
                                                                    "type": "string",
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                                    "val_type": "string",
                                                                    "value": "string"
                                                                }
                                                            ]
                                                        }
                                                    ],
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "brownfield_instance_list": [
                                            {
                                                "address": [
                                                    "string"
                                                ],
                                                "instance_id": "string",
                                                "instance_name": "string",
                                                "nic_index": 0,
                                                "power_state": "string"
                                            }
                                        ],
                                        "default_replicas": "string",
                                        "depends_on_list": [
                                            {
                                                "categories": {
                                                    "property1": "string",
                                                    "property2": "string"
                                                },
                                                "kind": "string",
                                                "name": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "fault_domain_scope": "string",
                                        "max_replicas": "1",
                                        "min_replicas": "1",
                                        "name": "string",
                                        "num_fault_tolerance": 0,
                                        "package_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "percent_fault_tolerance": 0,
                                        "published_service_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "substrate_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "type": "GREENFIELD",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "description": "string",
                                "environment_reference_list": [
                                    "string"
                                ],
                                "name": "string",
                                "patch_list": [
                                    {
                                        "attrs_list": [
                                            {}
                                        ],
                                        "config_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "is_system_generated": false,
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "name": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "name": "string",
                                                    "retries": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "published_service_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "restore_config_list": [
                                    {
                                        "attrs_list": [
                                            {}
                                        ],
                                        "config_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "is_system_generated": false,
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "name": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "name": "string",
                                                    "retries": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "snapshot_config_list": [
                                    {
                                        "attrs_list": [
                                            {}
                                        ],
                                        "config_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "is_system_generated": false,
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "name": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "name": "string",
                                                    "retries": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "credential_definition_list": [
                            {
                                "account_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "cred_class": "string",
                                "description": "string",
                                "exec_runbook_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "resource_type_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "type": "string",
                                "username": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "default_credential_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "endpoint_definition_list": [
                            {
                                "description": "string",
                                "name": "string",
                                "resources": {
                                    "name": "string",
                                    "provider_type": "string",
                                    "tunnel_reference": {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    },
                                    "type": "string",
                                    "value_type": "string"
                                }
                            }
                        ],
                        "endpoints_mapping": {
                            "property1": {
                                "kind": "string",
                                "name": "string",
                                "uuid": "string"
                            },
                            "property2": {
                                "kind": "string",
                                "name": "string",
                                "uuid": "string"
                            }
                        },
                        "package_definition_list": [
                            {
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "name": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "name": "string",
                                                    "retries": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "config_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "description": "string",
                                "name": "string",
                                "service_local_reference_list": [
                                    {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ],
                                "version": "string"
                            }
                        ],
                        "published_service_definition_list": [
                            {
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "name": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "name": "string",
                                                    "retries": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "config_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "depends_on_list": [
                                    {
                                        "categories": {
                                            "property1": "string",
                                            "property2": "string"
                                        },
                                        "kind": "string",
                                        "name": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "name": "string",
                                "port_list": [
                                    {
                                        "endpoint_name": "string",
                                        "exposed_address": "string",
                                        "exposed_port": "string",
                                        "protocol": "string",
                                        "target_port": "string",
                                        "type": "string"
                                    }
                                ],
                                "singleton": false,
                                "tier": "string",
                                "type": "K8S_SERVICE",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "service_definition_list": [
                            {
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "name": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "name": "string",
                                                    "retries": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "config_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "depends_on_list": [
                                    {
                                        "categories": {
                                            "property1": "string",
                                            "property2": "string"
                                        },
                                        "kind": "string",
                                        "name": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "name": "string",
                                "port_list": [
                                    {
                                        "endpoint_name": "string",
                                        "exposed_address": "string",
                                        "exposed_port": "string",
                                        "protocol": "string",
                                        "target_port": "string",
                                        "type": "string"
                                    }
                                ],
                                "singleton": false,
                                "tier": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "substrate_definition_list": [
                            {
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "name": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "name": "string",
                                                    "retries": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "config_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "description": "string",
                                "instance_address": "string",
                                "instance_id": "string",
                                "instance_name": "string",
                                "instance_power_state": "string",
                                "name": "string",
                                "os_type": "string",
                                "platform_data": "string",
                                "readiness_probe": {
                                    "address": "string",
                                    "connection_port": 22,
                                    "connection_protocol": "string",
                                    "connection_type": "string",
                                    "delay_secs": "string",
                                    "disable_readiness_probe": true,
                                    "login_credential_local_reference": {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    },
                                    "retries": "5",
                                    "timeout_secs": "string"
                                },
                                "recovery_point_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "tunnel_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "type": "string"
                    }
                },
                "status": {
                    "availability_zone_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cluster_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "message_list": [
                        {
                            "message": "string",
                            "reason": "string"
                        }
                    ],
                    "name": "string",
                    "resources": {
                        "app_profile_list": [
                            {
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "message_list": [
                                                {
                                                    "message": "string",
                                                    "reason": "string"
                                                }
                                            ],
                                            "name": "string",
                                            "state": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "retries": "string",
                                                    "state": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "state": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "application_url": "string",
                                "dependency_list": [
                                    {
                                        "action_name": "string",
                                        "action_resource_kind": "string",
                                        "action_resource_name": "string",
                                        "from_resource_kind": "string",
                                        "getter_resource_kind": "string",
                                        "getter_resource_name": "string",
                                        "setter_resource_attr": "string",
                                        "setter_resource_kind": "string",
                                        "setter_resource_name": "string"
                                    }
                                ],
                                "deployment_create_list": [
                                    {
                                        "action_list": [
                                            {
                                                "critical": false,
                                                "description": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "runbook": {
                                                    "description": "string",
                                                    "main_task_local_reference": {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "state": "string",
                                                    "task_definition_list": [
                                                        {
                                                            "child_tasks_local_reference_list": [
                                                                {
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                                }
                                                            ],
                                                            "description": "string",
                                                            "exec_target_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "inherit_target": true,
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "retries": "string",
                                                            "state": "string",
                                                            "target_any_local_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "timeout_secs": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "variable_list": [
                                                                {
                                                                    "data_type": "string",
                                                                    "description": "string",
                                                                    "is_hidden": true,
                                                                    "is_mandatory": true,
                                                                    "label": "string",
                                                                    "library_reference": "string",
                                                                    "message_list": [
                                                                        {
                                                                            "message": "string",
                                                                            "reason": "string"
                                                                        }
                                                                    ],
                                                                    "name": "string",
                                                                    "options": {
                                                                        "choices": [
                                                                            "string"
                                                                        ],
                                                                        "type": "string"
                                                                    },
                                                                    "regex": {
                                                                        "should_validate": true,
                                                                        "value": "string"
                                                                    },
                                                                    "state": "string",
                                                                    "type": "string",
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                                    "val_type": "string",
                                                                    "value": "string"
                                                                }
                                                            ]
                                                        }
                                                    ],
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "brownfield_instance_list": [
                                            {
                                                "address": [
                                                    "string"
                                                ],
                                                "instance_id": "string",
                                                "instance_name": "string",
                                                "nic_index": 0,
                                                "power_state": "string"
                                            }
                                        ],
                                        "default_replicas": "string",
                                        "depends_on_list": [
                                            {
                                                "categories": {
                                                    "property1": "string",
                                                    "property2": "string"
                                                },
                                                "kind": "string",
                                                "name": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "fault_domain_scope": "string",
                                        "max_replicas": "1",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "min_replicas": "1",
                                        "name": "string",
                                        "num_fault_tolerance": 0,
                                        "package_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "percent_fault_tolerance": 0,
                                        "published_service_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "state": "string",
                                        "substrate_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "type": "GREENFIELD",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "description": "string",
                                "environment_reference_list": [
                                    "string"
                                ],
                                "message_list": [
                                    {
                                        "message": "string",
                                        "reason": "string"
                                    }
                                ],
                                "name": "string",
                                "patch_list": [
                                    {
                                        "attrs_list": [
                                            {}
                                        ],
                                        "config_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "is_system_generated": false,
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "message_list": [
                                                {
                                                    "message": "string",
                                                    "reason": "string"
                                                }
                                            ],
                                            "name": "string",
                                            "state": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "retries": "string",
                                                    "state": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "state": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "published_service_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "restore_config_list": [
                                    {
                                        "attrs_list": [
                                            {}
                                        ],
                                        "config_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "is_system_generated": false,
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "message_list": [
                                                {
                                                    "message": "string",
                                                    "reason": "string"
                                                }
                                            ],
                                            "name": "string",
                                            "state": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "retries": "string",
                                                    "state": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "state": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "snapshot_config_list": [
                                    {
                                        "attrs_list": [
                                            {}
                                        ],
                                        "config_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "is_system_generated": false,
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "message_list": [
                                                {
                                                    "message": "string",
                                                    "reason": "string"
                                                }
                                            ],
                                            "name": "string",
                                            "state": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "retries": "string",
                                                    "state": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "state": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "state": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "credential_definition_list": [
                            {
                                "account_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "cred_class": "string",
                                "description": "string",
                                "exec_runbook_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "message_list": [
                                    {
                                        "message": "string",
                                        "reason": "string"
                                    }
                                ],
                                "name": "string",
                                "resource_type_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "state": "string",
                                "type": "string",
                                "username": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "default_credential_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "is_cloned": false,
                        "message_list": [
                            {
                                "message": "string",
                                "reason": "string"
                            }
                        ],
                        "package_definition_list": [
                            {
                                "account_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "message_list": [
                                                {
                                                    "message": "string",
                                                    "reason": "string"
                                                }
                                            ],
                                            "name": "string",
                                            "state": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "retries": "string",
                                                    "state": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "state": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "config_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "description": "string",
                                "element_list": [
                                    {
                                        "action_list": [
                                            {
                                                "critical": false,
                                                "description": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "runbook": {
                                                    "description": "string",
                                                    "main_task_local_reference": {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "state": "string",
                                                    "task_definition_list": [
                                                        {
                                                            "child_tasks_local_reference_list": [
                                                                {
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                                }
                                                            ],
                                                            "description": "string",
                                                            "exec_target_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "inherit_target": true,
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "retries": "string",
                                                            "state": "string",
                                                            "target_any_local_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "timeout_secs": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "variable_list": [
                                                                {
                                                                    "data_type": "string",
                                                                    "description": "string",
                                                                    "is_hidden": true,
                                                                    "is_mandatory": true,
                                                                    "label": "string",
                                                                    "library_reference": "string",
                                                                    "message_list": [
                                                                        {
                                                                            "message": "string",
                                                                            "reason": "string"
                                                                        }
                                                                    ],
                                                                    "name": "string",
                                                                    "options": {
                                                                        "choices": [
                                                                            "string"
                                                                        ],
                                                                        "type": "string"
                                                                    },
                                                                    "regex": {
                                                                        "should_validate": true,
                                                                        "value": "string"
                                                                    },
                                                                    "state": "string",
                                                                    "type": "string",
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                                    "val_type": "string",
                                                                    "value": "string"
                                                                }
                                                            ]
                                                        }
                                                    ],
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "service_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ],
                                        "version": "string"
                                    }
                                ],
                                "message_list": [
                                    {
                                        "message": "string",
                                        "reason": "string"
                                    }
                                ],
                                "name": "string",
                                "service_element_local_reference_list": [
                                    {
                                        "action_list": [
                                            {
                                                "critical": false,
                                                "description": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "runbook": {
                                                    "description": "string",
                                                    "main_task_local_reference": {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "state": "string",
                                                    "task_definition_list": [
                                                        {
                                                            "child_tasks_local_reference_list": [
                                                                {
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                                }
                                                            ],
                                                            "description": "string",
                                                            "exec_target_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "inherit_target": true,
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "retries": "string",
                                                            "state": "string",
                                                            "target_any_local_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "timeout_secs": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "variable_list": [
                                                                {
                                                                    "data_type": "string",
                                                                    "description": "string",
                                                                    "is_hidden": true,
                                                                    "is_mandatory": true,
                                                                    "label": "string",
                                                                    "library_reference": "string",
                                                                    "message_list": [
                                                                        {
                                                                            "message": "string",
                                                                            "reason": "string"
                                                                        }
                                                                    ],
                                                                    "name": "string",
                                                                    "options": {
                                                                        "choices": [
                                                                            "string"
                                                                        ],
                                                                        "type": "string"
                                                                    },
                                                                    "regex": {
                                                                        "should_validate": true,
                                                                        "value": "string"
                                                                    },
                                                                    "state": "string",
                                                                    "type": "string",
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                                    "val_type": "string",
                                                                    "value": "string"
                                                                }
                                                            ]
                                                        }
                                                    ],
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "depends_on_list": [
                                            {
                                                "categories": {
                                                    "property1": "string",
                                                    "property2": "string"
                                                },
                                                "kind": "string",
                                                "name": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "port_list": [
                                            {
                                                "endpoint_name": "string",
                                                "exposed_address": "string",
                                                "exposed_port": "string",
                                                "protocol": "string",
                                                "target_port": "string",
                                                "type": "string"
                                            }
                                        ],
                                        "singleton": false,
                                        "state": "string",
                                        "tier": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "service_local_reference_list": [
                                    {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "state": "string",
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ],
                                "version": "string"
                            }
                        ],
                        "published_service_definition_list": [
                            {
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "message_list": [
                                                {
                                                    "message": "string",
                                                    "reason": "string"
                                                }
                                            ],
                                            "name": "string",
                                            "state": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "retries": "string",
                                                    "state": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "state": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "config_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "depends_on_list": [
                                    {
                                        "categories": {
                                            "property1": "string",
                                            "property2": "string"
                                        },
                                        "kind": "string",
                                        "name": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "element_list": [
                                    {
                                        "action_list": [
                                            {
                                                "critical": false,
                                                "description": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "runbook": {
                                                    "description": "string",
                                                    "main_task_local_reference": {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "state": "string",
                                                    "task_definition_list": [
                                                        {
                                                            "child_tasks_local_reference_list": [
                                                                {
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                                }
                                                            ],
                                                            "description": "string",
                                                            "exec_target_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "inherit_target": true,
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "retries": "string",
                                                            "state": "string",
                                                            "target_any_local_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "timeout_secs": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "variable_list": [
                                                                {
                                                                    "data_type": "string",
                                                                    "description": "string",
                                                                    "is_hidden": true,
                                                                    "is_mandatory": true,
                                                                    "label": "string",
                                                                    "library_reference": "string",
                                                                    "message_list": [
                                                                        {
                                                                            "message": "string",
                                                                            "reason": "string"
                                                                        }
                                                                    ],
                                                                    "name": "string",
                                                                    "options": {
                                                                        "choices": [
                                                                            "string"
                                                                        ],
                                                                        "type": "string"
                                                                    },
                                                                    "regex": {
                                                                        "should_validate": true,
                                                                        "value": "string"
                                                                    },
                                                                    "state": "string",
                                                                    "type": "string",
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                                    "val_type": "string",
                                                                    "value": "string"
                                                                }
                                                            ]
                                                        }
                                                    ],
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "depends_on_list": [
                                            {
                                                "categories": {
                                                    "property1": "string",
                                                    "property2": "string"
                                                },
                                                "kind": "string",
                                                "name": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "port_list": [
                                            {
                                                "endpoint_name": "string",
                                                "exposed_address": "string",
                                                "exposed_port": "string",
                                                "protocol": "string",
                                                "target_port": "string",
                                                "type": "string"
                                            }
                                        ],
                                        "singleton": false,
                                        "state": "string",
                                        "tier": "string",
                                        "type": "K8S_SERVICE",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "message_list": [
                                    {
                                        "message": "string",
                                        "reason": "string"
                                    }
                                ],
                                "name": "string",
                                "port_list": [
                                    {
                                        "endpoint_name": "string",
                                        "exposed_address": "string",
                                        "exposed_port": "string",
                                        "protocol": "string",
                                        "target_port": "string",
                                        "type": "string"
                                    }
                                ],
                                "singleton": false,
                                "state": "string",
                                "tier": "string",
                                "type": "K8S_SERVICE",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "service_definition_list": [
                            {
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "message_list": [
                                                {
                                                    "message": "string",
                                                    "reason": "string"
                                                }
                                            ],
                                            "name": "string",
                                            "state": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "retries": "string",
                                                    "state": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "state": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "config_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "depends_on_list": [
                                    {
                                        "categories": {
                                            "property1": "string",
                                            "property2": "string"
                                        },
                                        "kind": "string",
                                        "name": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "element_list": [
                                    {
                                        "action_list": [
                                            {
                                                "critical": false,
                                                "description": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "runbook": {
                                                    "description": "string",
                                                    "main_task_local_reference": {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "state": "string",
                                                    "task_definition_list": [
                                                        {
                                                            "child_tasks_local_reference_list": [
                                                                {
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                                }
                                                            ],
                                                            "description": "string",
                                                            "exec_target_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "inherit_target": true,
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "retries": "string",
                                                            "state": "string",
                                                            "target_any_local_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "timeout_secs": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "variable_list": [
                                                                {
                                                                    "data_type": "string",
                                                                    "description": "string",
                                                                    "is_hidden": true,
                                                                    "is_mandatory": true,
                                                                    "label": "string",
                                                                    "library_reference": "string",
                                                                    "message_list": [
                                                                        {
                                                                            "message": "string",
                                                                            "reason": "string"
                                                                        }
                                                                    ],
                                                                    "name": "string",
                                                                    "options": {
                                                                        "choices": [
                                                                            "string"
                                                                        ],
                                                                        "type": "string"
                                                                    },
                                                                    "regex": {
                                                                        "should_validate": true,
                                                                        "value": "string"
                                                                    },
                                                                    "state": "string",
                                                                    "type": "string",
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                                    "val_type": "string",
                                                                    "value": "string"
                                                                }
                                                            ]
                                                        }
                                                    ],
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "depends_on_list": [
                                            {
                                                "categories": {
                                                    "property1": "string",
                                                    "property2": "string"
                                                },
                                                "kind": "string",
                                                "name": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "port_list": [
                                            {
                                                "endpoint_name": "string",
                                                "exposed_address": "string",
                                                "exposed_port": "string",
                                                "protocol": "string",
                                                "target_port": "string",
                                                "type": "string"
                                            }
                                        ],
                                        "singleton": false,
                                        "state": "string",
                                        "tier": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "message_list": [
                                    {
                                        "message": "string",
                                        "reason": "string"
                                    }
                                ],
                                "name": "string",
                                "port_list": [
                                    {
                                        "endpoint_name": "string",
                                        "exposed_address": "string",
                                        "exposed_port": "string",
                                        "protocol": "string",
                                        "target_port": "string",
                                        "type": "string"
                                    }
                                ],
                                "singleton": false,
                                "state": "string",
                                "tier": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "state": "string",
                        "substrate_definition_list": [
                            {
                                "account_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "message_list": [
                                                {
                                                    "message": "string",
                                                    "reason": "string"
                                                }
                                            ],
                                            "name": "string",
                                            "state": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "retries": "string",
                                                    "state": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "state": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "config_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "description": "string",
                                "element_list": [
                                    {
                                        "action_list": [
                                            {
                                                "critical": false,
                                                "description": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "runbook": {
                                                    "description": "string",
                                                    "main_task_local_reference": {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "state": "string",
                                                    "task_definition_list": [
                                                        {
                                                            "child_tasks_local_reference_list": [
                                                                {
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                                }
                                                            ],
                                                            "description": "string",
                                                            "exec_target_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "inherit_target": true,
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "retries": "string",
                                                            "state": "string",
                                                            "target_any_local_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "timeout_secs": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "variable_list": [
                                                                {
                                                                    "data_type": "string",
                                                                    "description": "string",
                                                                    "is_hidden": true,
                                                                    "is_mandatory": true,
                                                                    "label": "string",
                                                                    "library_reference": "string",
                                                                    "message_list": [
                                                                        {
                                                                            "message": "string",
                                                                            "reason": "string"
                                                                        }
                                                                    ],
                                                                    "name": "string",
                                                                    "options": {
                                                                        "choices": [
                                                                            "string"
                                                                        ],
                                                                        "type": "string"
                                                                    },
                                                                    "regex": {
                                                                        "should_validate": true,
                                                                        "value": "string"
                                                                    },
                                                                    "state": "string",
                                                                    "type": "string",
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                                    "val_type": "string",
                                                                    "value": "string"
                                                                }
                                                            ]
                                                        }
                                                    ],
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "instance_address": "string",
                                        "instance_id": "string",
                                        "instance_name": "string",
                                        "instance_power_state": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "os_type": "string",
                                        "platform_data": "string",
                                        "readiness_probe": {
                                            "address": "string",
                                            "connection_port": 22,
                                            "connection_protocol": "string",
                                            "connection_type": "string",
                                            "delay_secs": "string",
                                            "disable_readiness_probe": true,
                                            "login_credential_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "retries": "5",
                                            "timeout_secs": "string"
                                        },
                                        "recovery_point_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "state": "string",
                                        "tunnel_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "instance_address": "string",
                                "instance_id": "string",
                                "instance_name": "string",
                                "instance_power_state": "string",
                                "message_list": [
                                    {
                                        "message": "string",
                                        "reason": "string"
                                    }
                                ],
                                "name": "string",
                                "os_type": "string",
                                "platform_data": "string",
                                "readiness_probe": {
                                    "address": "string",
                                    "connection_port": 22,
                                    "connection_protocol": "string",
                                    "connection_type": "string",
                                    "delay_secs": "string",
                                    "disable_readiness_probe": true,
                                    "login_credential_local_reference": {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    },
                                    "retries": "5",
                                    "timeout_secs": "string"
                                },
                                "recovery_point_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "state": "string",
                                "tunnel_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "type": "string"
                    },
                    "state": "string"
                }
            },
            "app_group_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
            "app_source": "LOCAL",
            "app_state": "PENDING",
            "author": "string",
            "change_log": "string",
            "deprecation_reason": "string",
            "icon_reference_list": [
                {
                    "icon_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "icon_type": "string"
                }
            ],
            "project_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "runbook_template_info": {
                "is_published_with_endpoints": false,
                "is_published_with_secrets": false,
                "source_runbook_reference": {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            },
            "substrate_types": [
                "string"
            ],
            "support_status": "SUPPORTED",
            "type": "blueprint",
            "version": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Delete marketplace item

Deletes the specified marketplace item.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_marketplace_items/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get dynamic variable values

Initiates execution of escript/http request configured for the specific variable and returns the final value.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

variable_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Variable UUID

Request Body schema: application/json
required
trlId
string

trl ID of the initiated execution

overridden_field
string

will be used to override several field for http request or eScript value

requestId
string

Request ID

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_marketplace_items/{uuid}/variables/{variable_uuid}/values \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "overridden_field": "string",
    "requestId": "string",
    "trlId": "string"
}'

Response samples

Content type
application/json
{
  • "trl_id": "string",
  • "state": "string",
  • "run_id": "string",
  • "values": [
    ],
  • "request_id": "string"
}

Get dynamic variable values

Initiates execution of escript/http request configured for the specific variable and returns the final value.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

marketplace_item UUID to get

variable_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of variable whose value needs to be fetched

query Parameters
trlId
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

trl ID of the initiated execution

requestId
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Request ID

overridden_field
string

will be used to override several field for http request or eScript value

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_marketplace_items/{uuid}/variables/{variable_uuid}/values \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "trl_id": "string",
  • "state": "string",
  • "run_id": "string",
  • "values": [
    ],
  • "request_id": "string"
}

Get marketplace item

Returns the specified marketplace item.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_marketplace_items/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List marketplace items

Retrieves a list of marketplace items using filters provided.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "marketplace_item"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_marketplace_items/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "marketplace_item",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List the apps launched from a marketplace item

Lists the marketplace items launched from the specific marketplace-item.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "marketplace_item"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_marketplace_items/apps/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "marketplace_item",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Update marketplace item

Updates the specified marketplace item using data included in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
required
object (Marketplace item information)

Detailed spec for creation of an marketplace item

required
object (marketplace_item metadata)

The marketplace_item kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_marketplace_items/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "description": "string",
        "name": "string",
        "resources": {
            "app_attribute_list": [
                "string"
            ],
            "app_blueprint_template": {
                "spec": {
                    "availability_zone_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cluster_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "name": "string",
                    "resources": {
                        "app_profile_list": [
                            {
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "name": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "name": "string",
                                                    "retries": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "application_url": "string",
                                "deployment_create_list": [
                                    {
                                        "action_list": [
                                            {
                                                "critical": false,
                                                "description": "string",
                                                "name": "string",
                                                "runbook": {
                                                    "description": "string",
                                                    "main_task_local_reference": {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "name": "string",
                                                    "task_definition_list": [
                                                        {
                                                            "child_tasks_local_reference_list": [
                                                                {
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                                }
                                                            ],
                                                            "description": "string",
                                                            "exec_target_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "inherit_target": true,
                                                            "name": "string",
                                                            "retries": "string",
                                                            "target_any_local_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "timeout_secs": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "variable_list": [
                                                                {
                                                                    "data_type": "string",
                                                                    "description": "string",
                                                                    "is_hidden": true,
                                                                    "is_mandatory": true,
                                                                    "label": "string",
                                                                    "library_reference": "string",
                                                                    "name": "string",
                                                                    "options": {
                                                                        "choices": [
                                                                            "string"
                                                                        ],
                                                                        "type": "string"
                                                                    },
                                                                    "regex": {
                                                                        "should_validate": true,
                                                                        "value": "string"
                                                                    },
                                                                    "type": "string",
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                                    "val_type": "string",
                                                                    "value": "string"
                                                                }
                                                            ]
                                                        }
                                                    ],
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "brownfield_instance_list": [
                                            {
                                                "address": [
                                                    "string"
                                                ],
                                                "instance_id": "string",
                                                "instance_name": "string",
                                                "nic_index": 0,
                                                "power_state": "string"
                                            }
                                        ],
                                        "default_replicas": "string",
                                        "depends_on_list": [
                                            {
                                                "categories": {
                                                    "property1": "string",
                                                    "property2": "string"
                                                },
                                                "kind": "string",
                                                "name": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "fault_domain_scope": "string",
                                        "max_replicas": "1",
                                        "min_replicas": "1",
                                        "name": "string",
                                        "num_fault_tolerance": 0,
                                        "package_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "percent_fault_tolerance": 0,
                                        "published_service_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "substrate_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "type": "GREENFIELD",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "description": "string",
                                "environment_reference_list": [
                                    "string"
                                ],
                                "name": "string",
                                "patch_list": [
                                    {
                                        "attrs_list": [
                                            {}
                                        ],
                                        "config_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "is_system_generated": false,
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "name": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "name": "string",
                                                    "retries": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "published_service_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "restore_config_list": [
                                    {
                                        "attrs_list": [
                                            {}
                                        ],
                                        "config_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "is_system_generated": false,
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "name": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "name": "string",
                                                    "retries": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "snapshot_config_list": [
                                    {
                                        "attrs_list": [
                                            {}
                                        ],
                                        "config_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "is_system_generated": false,
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "name": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "name": "string",
                                                    "retries": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "credential_definition_list": [
                            {
                                "account_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "cred_class": "string",
                                "description": "string",
                                "exec_runbook_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "name": "string",
                                "resource_type_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "type": "string",
                                "username": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "default_credential_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "endpoint_definition_list": [
                            {
                                "description": "string",
                                "name": "string",
                                "resources": {
                                    "name": "string",
                                    "provider_type": "string",
                                    "tunnel_reference": {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    },
                                    "type": "string",
                                    "value_type": "string"
                                }
                            }
                        ],
                        "endpoints_mapping": {
                            "property1": {
                                "kind": "string",
                                "name": "string",
                                "uuid": "string"
                            },
                            "property2": {
                                "kind": "string",
                                "name": "string",
                                "uuid": "string"
                            }
                        },
                        "package_definition_list": [
                            {
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "name": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "name": "string",
                                                    "retries": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "config_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "description": "string",
                                "name": "string",
                                "service_local_reference_list": [
                                    {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ],
                                "version": "string"
                            }
                        ],
                        "published_service_definition_list": [
                            {
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "name": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "name": "string",
                                                    "retries": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "config_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "depends_on_list": [
                                    {
                                        "categories": {
                                            "property1": "string",
                                            "property2": "string"
                                        },
                                        "kind": "string",
                                        "name": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "name": "string",
                                "port_list": [
                                    {
                                        "endpoint_name": "string",
                                        "exposed_address": "string",
                                        "exposed_port": "string",
                                        "protocol": "string",
                                        "target_port": "string",
                                        "type": "string"
                                    }
                                ],
                                "singleton": false,
                                "tier": "string",
                                "type": "K8S_SERVICE",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "service_definition_list": [
                            {
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "name": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "name": "string",
                                                    "retries": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "config_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "depends_on_list": [
                                    {
                                        "categories": {
                                            "property1": "string",
                                            "property2": "string"
                                        },
                                        "kind": "string",
                                        "name": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "name": "string",
                                "port_list": [
                                    {
                                        "endpoint_name": "string",
                                        "exposed_address": "string",
                                        "exposed_port": "string",
                                        "protocol": "string",
                                        "target_port": "string",
                                        "type": "string"
                                    }
                                ],
                                "singleton": false,
                                "tier": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "substrate_definition_list": [
                            {
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "name": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "name": "string",
                                                    "retries": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "config_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "description": "string",
                                "instance_address": "string",
                                "instance_id": "string",
                                "instance_name": "string",
                                "instance_power_state": "string",
                                "name": "string",
                                "os_type": "string",
                                "platform_data": "string",
                                "readiness_probe": {
                                    "address": "string",
                                    "connection_port": 22,
                                    "connection_protocol": "string",
                                    "connection_type": "string",
                                    "delay_secs": "string",
                                    "disable_readiness_probe": true,
                                    "login_credential_local_reference": {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    },
                                    "retries": "5",
                                    "timeout_secs": "string"
                                },
                                "recovery_point_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "tunnel_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "type": "string"
                    }
                },
                "status": {
                    "availability_zone_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cluster_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "description": "string",
                    "message_list": [
                        {
                            "message": "string",
                            "reason": "string"
                        }
                    ],
                    "name": "string",
                    "resources": {
                        "app_profile_list": [
                            {
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "message_list": [
                                                {
                                                    "message": "string",
                                                    "reason": "string"
                                                }
                                            ],
                                            "name": "string",
                                            "state": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "retries": "string",
                                                    "state": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "state": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "application_url": "string",
                                "dependency_list": [
                                    {
                                        "action_name": "string",
                                        "action_resource_kind": "string",
                                        "action_resource_name": "string",
                                        "from_resource_kind": "string",
                                        "getter_resource_kind": "string",
                                        "getter_resource_name": "string",
                                        "setter_resource_attr": "string",
                                        "setter_resource_kind": "string",
                                        "setter_resource_name": "string"
                                    }
                                ],
                                "deployment_create_list": [
                                    {
                                        "action_list": [
                                            {
                                                "critical": false,
                                                "description": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "runbook": {
                                                    "description": "string",
                                                    "main_task_local_reference": {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "state": "string",
                                                    "task_definition_list": [
                                                        {
                                                            "child_tasks_local_reference_list": [
                                                                {
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                                }
                                                            ],
                                                            "description": "string",
                                                            "exec_target_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "inherit_target": true,
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "retries": "string",
                                                            "state": "string",
                                                            "target_any_local_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "timeout_secs": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "variable_list": [
                                                                {
                                                                    "data_type": "string",
                                                                    "description": "string",
                                                                    "is_hidden": true,
                                                                    "is_mandatory": true,
                                                                    "label": "string",
                                                                    "library_reference": "string",
                                                                    "message_list": [
                                                                        {
                                                                            "message": "string",
                                                                            "reason": "string"
                                                                        }
                                                                    ],
                                                                    "name": "string",
                                                                    "options": {
                                                                        "choices": [
                                                                            "string"
                                                                        ],
                                                                        "type": "string"
                                                                    },
                                                                    "regex": {
                                                                        "should_validate": true,
                                                                        "value": "string"
                                                                    },
                                                                    "state": "string",
                                                                    "type": "string",
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                                    "val_type": "string",
                                                                    "value": "string"
                                                                }
                                                            ]
                                                        }
                                                    ],
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "brownfield_instance_list": [
                                            {
                                                "address": [
                                                    "string"
                                                ],
                                                "instance_id": "string",
                                                "instance_name": "string",
                                                "nic_index": 0,
                                                "power_state": "string"
                                            }
                                        ],
                                        "default_replicas": "string",
                                        "depends_on_list": [
                                            {
                                                "categories": {
                                                    "property1": "string",
                                                    "property2": "string"
                                                },
                                                "kind": "string",
                                                "name": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "fault_domain_scope": "string",
                                        "max_replicas": "1",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "min_replicas": "1",
                                        "name": "string",
                                        "num_fault_tolerance": 0,
                                        "package_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "percent_fault_tolerance": 0,
                                        "published_service_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "state": "string",
                                        "substrate_local_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "type": "GREENFIELD",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "description": "string",
                                "environment_reference_list": [
                                    "string"
                                ],
                                "message_list": [
                                    {
                                        "message": "string",
                                        "reason": "string"
                                    }
                                ],
                                "name": "string",
                                "patch_list": [
                                    {
                                        "attrs_list": [
                                            {}
                                        ],
                                        "config_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "is_system_generated": false,
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "message_list": [
                                                {
                                                    "message": "string",
                                                    "reason": "string"
                                                }
                                            ],
                                            "name": "string",
                                            "state": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "retries": "string",
                                                    "state": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "state": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "published_service_local_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "restore_config_list": [
                                    {
                                        "attrs_list": [
                                            {}
                                        ],
                                        "config_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "is_system_generated": false,
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "message_list": [
                                                {
                                                    "message": "string",
                                                    "reason": "string"
                                                }
                                            ],
                                            "name": "string",
                                            "state": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "retries": "string",
                                                    "state": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "state": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "snapshot_config_list": [
                                    {
                                        "attrs_list": [
                                            {}
                                        ],
                                        "config_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "is_system_generated": false,
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "message_list": [
                                                {
                                                    "message": "string",
                                                    "reason": "string"
                                                }
                                            ],
                                            "name": "string",
                                            "state": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "retries": "string",
                                                    "state": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "state": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "state": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "credential_definition_list": [
                            {
                                "account_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "cred_class": "string",
                                "description": "string",
                                "exec_runbook_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "message_list": [
                                    {
                                        "message": "string",
                                        "reason": "string"
                                    }
                                ],
                                "name": "string",
                                "resource_type_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "state": "string",
                                "type": "string",
                                "username": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "default_credential_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "is_cloned": false,
                        "message_list": [
                            {
                                "message": "string",
                                "reason": "string"
                            }
                        ],
                        "package_definition_list": [
                            {
                                "account_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "message_list": [
                                                {
                                                    "message": "string",
                                                    "reason": "string"
                                                }
                                            ],
                                            "name": "string",
                                            "state": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "retries": "string",
                                                    "state": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "state": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "config_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "description": "string",
                                "element_list": [
                                    {
                                        "action_list": [
                                            {
                                                "critical": false,
                                                "description": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "runbook": {
                                                    "description": "string",
                                                    "main_task_local_reference": {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "state": "string",
                                                    "task_definition_list": [
                                                        {
                                                            "child_tasks_local_reference_list": [
                                                                {
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                                }
                                                            ],
                                                            "description": "string",
                                                            "exec_target_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "inherit_target": true,
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "retries": "string",
                                                            "state": "string",
                                                            "target_any_local_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "timeout_secs": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "variable_list": [
                                                                {
                                                                    "data_type": "string",
                                                                    "description": "string",
                                                                    "is_hidden": true,
                                                                    "is_mandatory": true,
                                                                    "label": "string",
                                                                    "library_reference": "string",
                                                                    "message_list": [
                                                                        {
                                                                            "message": "string",
                                                                            "reason": "string"
                                                                        }
                                                                    ],
                                                                    "name": "string",
                                                                    "options": {
                                                                        "choices": [
                                                                            "string"
                                                                        ],
                                                                        "type": "string"
                                                                    },
                                                                    "regex": {
                                                                        "should_validate": true,
                                                                        "value": "string"
                                                                    },
                                                                    "state": "string",
                                                                    "type": "string",
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                                    "val_type": "string",
                                                                    "value": "string"
                                                                }
                                                            ]
                                                        }
                                                    ],
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "service_local_reference_list": [
                                            {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ],
                                        "version": "string"
                                    }
                                ],
                                "message_list": [
                                    {
                                        "message": "string",
                                        "reason": "string"
                                    }
                                ],
                                "name": "string",
                                "service_element_local_reference_list": [
                                    {
                                        "action_list": [
                                            {
                                                "critical": false,
                                                "description": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "runbook": {
                                                    "description": "string",
                                                    "main_task_local_reference": {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "state": "string",
                                                    "task_definition_list": [
                                                        {
                                                            "child_tasks_local_reference_list": [
                                                                {
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                                }
                                                            ],
                                                            "description": "string",
                                                            "exec_target_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "inherit_target": true,
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "retries": "string",
                                                            "state": "string",
                                                            "target_any_local_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "timeout_secs": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "variable_list": [
                                                                {
                                                                    "data_type": "string",
                                                                    "description": "string",
                                                                    "is_hidden": true,
                                                                    "is_mandatory": true,
                                                                    "label": "string",
                                                                    "library_reference": "string",
                                                                    "message_list": [
                                                                        {
                                                                            "message": "string",
                                                                            "reason": "string"
                                                                        }
                                                                    ],
                                                                    "name": "string",
                                                                    "options": {
                                                                        "choices": [
                                                                            "string"
                                                                        ],
                                                                        "type": "string"
                                                                    },
                                                                    "regex": {
                                                                        "should_validate": true,
                                                                        "value": "string"
                                                                    },
                                                                    "state": "string",
                                                                    "type": "string",
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                                    "val_type": "string",
                                                                    "value": "string"
                                                                }
                                                            ]
                                                        }
                                                    ],
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "depends_on_list": [
                                            {
                                                "categories": {
                                                    "property1": "string",
                                                    "property2": "string"
                                                },
                                                "kind": "string",
                                                "name": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "port_list": [
                                            {
                                                "endpoint_name": "string",
                                                "exposed_address": "string",
                                                "exposed_port": "string",
                                                "protocol": "string",
                                                "target_port": "string",
                                                "type": "string"
                                            }
                                        ],
                                        "singleton": false,
                                        "state": "string",
                                        "tier": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "service_local_reference_list": [
                                    {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "state": "string",
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ],
                                "version": "string"
                            }
                        ],
                        "published_service_definition_list": [
                            {
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "message_list": [
                                                {
                                                    "message": "string",
                                                    "reason": "string"
                                                }
                                            ],
                                            "name": "string",
                                            "state": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "retries": "string",
                                                    "state": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "state": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "config_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "depends_on_list": [
                                    {
                                        "categories": {
                                            "property1": "string",
                                            "property2": "string"
                                        },
                                        "kind": "string",
                                        "name": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "element_list": [
                                    {
                                        "action_list": [
                                            {
                                                "critical": false,
                                                "description": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "runbook": {
                                                    "description": "string",
                                                    "main_task_local_reference": {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "state": "string",
                                                    "task_definition_list": [
                                                        {
                                                            "child_tasks_local_reference_list": [
                                                                {
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                                }
                                                            ],
                                                            "description": "string",
                                                            "exec_target_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "inherit_target": true,
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "retries": "string",
                                                            "state": "string",
                                                            "target_any_local_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "timeout_secs": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "variable_list": [
                                                                {
                                                                    "data_type": "string",
                                                                    "description": "string",
                                                                    "is_hidden": true,
                                                                    "is_mandatory": true,
                                                                    "label": "string",
                                                                    "library_reference": "string",
                                                                    "message_list": [
                                                                        {
                                                                            "message": "string",
                                                                            "reason": "string"
                                                                        }
                                                                    ],
                                                                    "name": "string",
                                                                    "options": {
                                                                        "choices": [
                                                                            "string"
                                                                        ],
                                                                        "type": "string"
                                                                    },
                                                                    "regex": {
                                                                        "should_validate": true,
                                                                        "value": "string"
                                                                    },
                                                                    "state": "string",
                                                                    "type": "string",
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                                    "val_type": "string",
                                                                    "value": "string"
                                                                }
                                                            ]
                                                        }
                                                    ],
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "depends_on_list": [
                                            {
                                                "categories": {
                                                    "property1": "string",
                                                    "property2": "string"
                                                },
                                                "kind": "string",
                                                "name": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "port_list": [
                                            {
                                                "endpoint_name": "string",
                                                "exposed_address": "string",
                                                "exposed_port": "string",
                                                "protocol": "string",
                                                "target_port": "string",
                                                "type": "string"
                                            }
                                        ],
                                        "singleton": false,
                                        "state": "string",
                                        "tier": "string",
                                        "type": "K8S_SERVICE",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "message_list": [
                                    {
                                        "message": "string",
                                        "reason": "string"
                                    }
                                ],
                                "name": "string",
                                "port_list": [
                                    {
                                        "endpoint_name": "string",
                                        "exposed_address": "string",
                                        "exposed_port": "string",
                                        "protocol": "string",
                                        "target_port": "string",
                                        "type": "string"
                                    }
                                ],
                                "singleton": false,
                                "state": "string",
                                "tier": "string",
                                "type": "K8S_SERVICE",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "service_definition_list": [
                            {
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "message_list": [
                                                {
                                                    "message": "string",
                                                    "reason": "string"
                                                }
                                            ],
                                            "name": "string",
                                            "state": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "retries": "string",
                                                    "state": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "state": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "config_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "depends_on_list": [
                                    {
                                        "categories": {
                                            "property1": "string",
                                            "property2": "string"
                                        },
                                        "kind": "string",
                                        "name": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "element_list": [
                                    {
                                        "action_list": [
                                            {
                                                "critical": false,
                                                "description": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "runbook": {
                                                    "description": "string",
                                                    "main_task_local_reference": {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "state": "string",
                                                    "task_definition_list": [
                                                        {
                                                            "child_tasks_local_reference_list": [
                                                                {
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                                }
                                                            ],
                                                            "description": "string",
                                                            "exec_target_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "inherit_target": true,
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "retries": "string",
                                                            "state": "string",
                                                            "target_any_local_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "timeout_secs": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "variable_list": [
                                                                {
                                                                    "data_type": "string",
                                                                    "description": "string",
                                                                    "is_hidden": true,
                                                                    "is_mandatory": true,
                                                                    "label": "string",
                                                                    "library_reference": "string",
                                                                    "message_list": [
                                                                        {
                                                                            "message": "string",
                                                                            "reason": "string"
                                                                        }
                                                                    ],
                                                                    "name": "string",
                                                                    "options": {
                                                                        "choices": [
                                                                            "string"
                                                                        ],
                                                                        "type": "string"
                                                                    },
                                                                    "regex": {
                                                                        "should_validate": true,
                                                                        "value": "string"
                                                                    },
                                                                    "state": "string",
                                                                    "type": "string",
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                                    "val_type": "string",
                                                                    "value": "string"
                                                                }
                                                            ]
                                                        }
                                                    ],
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "depends_on_list": [
                                            {
                                                "categories": {
                                                    "property1": "string",
                                                    "property2": "string"
                                                },
                                                "kind": "string",
                                                "name": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "port_list": [
                                            {
                                                "endpoint_name": "string",
                                                "exposed_address": "string",
                                                "exposed_port": "string",
                                                "protocol": "string",
                                                "target_port": "string",
                                                "type": "string"
                                            }
                                        ],
                                        "singleton": false,
                                        "state": "string",
                                        "tier": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "message_list": [
                                    {
                                        "message": "string",
                                        "reason": "string"
                                    }
                                ],
                                "name": "string",
                                "port_list": [
                                    {
                                        "endpoint_name": "string",
                                        "exposed_address": "string",
                                        "exposed_port": "string",
                                        "protocol": "string",
                                        "target_port": "string",
                                        "type": "string"
                                    }
                                ],
                                "singleton": false,
                                "state": "string",
                                "tier": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "state": "string",
                        "substrate_definition_list": [
                            {
                                "account_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "action_list": [
                                    {
                                        "critical": false,
                                        "description": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "runbook": {
                                            "description": "string",
                                            "main_task_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "message_list": [
                                                {
                                                    "message": "string",
                                                    "reason": "string"
                                                }
                                            ],
                                            "name": "string",
                                            "state": "string",
                                            "task_definition_list": [
                                                {
                                                    "child_tasks_local_reference_list": [
                                                        {
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                        }
                                                    ],
                                                    "description": "string",
                                                    "exec_target_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "inherit_target": true,
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "retries": "string",
                                                    "state": "string",
                                                    "target_any_local_reference": {
                                                        "categories": {
                                                            "property1": "string",
                                                            "property2": "string"
                                                        },
                                                        "kind": "string",
                                                        "name": "string",
                                                        "type": "string",
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "timeout_secs": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                }
                                            ],
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                            "variable_list": [
                                                {
                                                    "data_type": "string",
                                                    "description": "string",
                                                    "is_hidden": true,
                                                    "is_mandatory": true,
                                                    "label": "string",
                                                    "library_reference": "string",
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "options": {
                                                        "choices": [
                                                            "string"
                                                        ],
                                                        "type": "string"
                                                    },
                                                    "regex": {
                                                        "should_validate": true,
                                                        "value": "string"
                                                    },
                                                    "state": "string",
                                                    "type": "string",
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "val_type": "string",
                                                    "value": "string"
                                                }
                                            ]
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "config_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "description": "string",
                                "element_list": [
                                    {
                                        "action_list": [
                                            {
                                                "critical": false,
                                                "description": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "runbook": {
                                                    "description": "string",
                                                    "main_task_local_reference": {
                                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                    },
                                                    "message_list": [
                                                        {
                                                            "message": "string",
                                                            "reason": "string"
                                                        }
                                                    ],
                                                    "name": "string",
                                                    "state": "string",
                                                    "task_definition_list": [
                                                        {
                                                            "child_tasks_local_reference_list": [
                                                                {
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                                }
                                                            ],
                                                            "description": "string",
                                                            "exec_target_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "inherit_target": true,
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "retries": "string",
                                                            "state": "string",
                                                            "target_any_local_reference": {
                                                                "categories": {
                                                                    "property1": "string",
                                                                    "property2": "string"
                                                                },
                                                                "kind": "string",
                                                                "name": "string",
                                                                "type": "string",
                                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                                            },
                                                            "timeout_secs": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "variable_list": [
                                                                {
                                                                    "data_type": "string",
                                                                    "description": "string",
                                                                    "is_hidden": true,
                                                                    "is_mandatory": true,
                                                                    "label": "string",
                                                                    "library_reference": "string",
                                                                    "message_list": [
                                                                        {
                                                                            "message": "string",
                                                                            "reason": "string"
                                                                        }
                                                                    ],
                                                                    "name": "string",
                                                                    "options": {
                                                                        "choices": [
                                                                            "string"
                                                                        ],
                                                                        "type": "string"
                                                                    },
                                                                    "regex": {
                                                                        "should_validate": true,
                                                                        "value": "string"
                                                                    },
                                                                    "state": "string",
                                                                    "type": "string",
                                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                                    "val_type": "string",
                                                                    "value": "string"
                                                                }
                                                            ]
                                                        }
                                                    ],
                                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                    "variable_list": [
                                                        {
                                                            "data_type": "string",
                                                            "description": "string",
                                                            "is_hidden": true,
                                                            "is_mandatory": true,
                                                            "label": "string",
                                                            "library_reference": "string",
                                                            "message_list": [
                                                                {
                                                                    "message": "string",
                                                                    "reason": "string"
                                                                }
                                                            ],
                                                            "name": "string",
                                                            "options": {
                                                                "choices": [
                                                                    "string"
                                                                ],
                                                                "type": "string"
                                                            },
                                                            "regex": {
                                                                "should_validate": true,
                                                                "value": "string"
                                                            },
                                                            "state": "string",
                                                            "type": "string",
                                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                            "val_type": "string",
                                                            "value": "string"
                                                        }
                                                    ]
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            }
                                        ],
                                        "description": "string",
                                        "instance_address": "string",
                                        "instance_id": "string",
                                        "instance_name": "string",
                                        "instance_power_state": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "os_type": "string",
                                        "platform_data": "string",
                                        "readiness_probe": {
                                            "address": "string",
                                            "connection_port": 22,
                                            "connection_protocol": "string",
                                            "connection_type": "string",
                                            "delay_secs": "string",
                                            "disable_readiness_probe": true,
                                            "login_credential_local_reference": {
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                            },
                                            "retries": "5",
                                            "timeout_secs": "string"
                                        },
                                        "recovery_point_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "state": "string",
                                        "tunnel_reference": {
                                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "variable_list": [
                                            {
                                                "data_type": "string",
                                                "description": "string",
                                                "is_hidden": true,
                                                "is_mandatory": true,
                                                "label": "string",
                                                "library_reference": "string",
                                                "message_list": [
                                                    {
                                                        "message": "string",
                                                        "reason": "string"
                                                    }
                                                ],
                                                "name": "string",
                                                "options": {
                                                    "choices": [
                                                        "string"
                                                    ],
                                                    "type": "string"
                                                },
                                                "regex": {
                                                    "should_validate": true,
                                                    "value": "string"
                                                },
                                                "state": "string",
                                                "type": "string",
                                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                                "val_type": "string",
                                                "value": "string"
                                            }
                                        ]
                                    }
                                ],
                                "instance_address": "string",
                                "instance_id": "string",
                                "instance_name": "string",
                                "instance_power_state": "string",
                                "message_list": [
                                    {
                                        "message": "string",
                                        "reason": "string"
                                    }
                                ],
                                "name": "string",
                                "os_type": "string",
                                "platform_data": "string",
                                "readiness_probe": {
                                    "address": "string",
                                    "connection_port": 22,
                                    "connection_protocol": "string",
                                    "connection_type": "string",
                                    "delay_secs": "string",
                                    "disable_readiness_probe": true,
                                    "login_credential_local_reference": {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    },
                                    "retries": "5",
                                    "timeout_secs": "string"
                                },
                                "recovery_point_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "state": "string",
                                "tunnel_reference": {
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "message_list": [
                                            {
                                                "message": "string",
                                                "reason": "string"
                                            }
                                        ],
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "state": "string",
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "type": "string"
                    },
                    "state": "string"
                }
            },
            "app_group_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
            "app_source": "LOCAL",
            "app_state": "PENDING",
            "author": "string",
            "change_log": "string",
            "deprecation_reason": "string",
            "icon_reference_list": [
                {
                    "icon_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "icon_type": "string"
                }
            ],
            "project_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "runbook_template_info": {
                "is_published_with_endpoints": false,
                "is_published_with_secrets": false,
                "source_runbook_reference": {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            },
            "substrate_types": [
                "string"
            ],
            "support_status": "SUPPORTED",
            "type": "blueprint",
            "version": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Validate marketplace item patching

Validate if the specified app profiles in the marketplace item can be patched with the specified environments.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
required
object (Spec for marketplace item patch validation.)

Spec for marketplace item patch validation.

api_version
required
string
required
object (marketplace_item metadata)

The marketplace_item kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_marketplace_items/{uuid}/patch_with_environment/validate \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "environment_profile_pairs": [
            {
                "app_profile": {
                    "categories": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "kind": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "environment": {
                    "categories": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "kind": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            }
        ]
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Meter

Filter API to get cumulative stats at application level for given project

Filter API to get cumulative stats at Project and Cluster level

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string
length
number
offset
number

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/meter/applications/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": null,
    "offset": null
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "message_list": [
    ],
  • "metadata": {
    }
}

Filter API to get cumulative stats at Project and Cluster level

Filter API to get cumulative stats at Project and Cluster level

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string
length
number
offset
number

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/meter/clusters/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": null,
    "offset": null
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "message_list": [
    ],
  • "metadata": {
    }
}

Filter API to get cumulative stats at Project level

Filter API to get cumulative stats at Project level

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string
length
number
offset
number

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/meter/projects/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": null,
    "offset": null
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "message_list": [
    ],
  • "metadata": {
    }
}

Filter API to iterate over metered entries

Filter API to iterate over metered entries.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string
length
number
offset
number

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/meter/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": null,
    "offset": null
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "message_list": [
    ],
  • "metadata": {
    }
}

network_groups

Create Network Group

Creates a Network Group entity using data included in the request

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (network_group Intent Spec with placement specified)

An intentful representation of a network_group spec

required
object (network_group metadata)

The network_group kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/network_groups \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "description": "string",
        "name": "string",
        "resources": {
            "account_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "created_by": "string",
            "name": "string",
            "platform_subnet_uuid_list": [
                "string"
            ],
            "platform_vpc_uuid_list": [
                "string"
            ],
            "tunnel_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "type": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Create Network Group and its tunnel

Creates a Network Group entity and its tunnel using data included in the request

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (network_group_tunnel Intent Spec with placement specified)

An intentful representation of a network_group_tunnel spec

required
object (network_group_tunnel metadata)

The network_group_tunnel kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/network_groups/tunnels \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "description": "string",
        "name": "string",
        "resources": {
            "account_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "created_by": "string",
            "name": "string",
            "platform_subnet_uuid_list": [
                "string"
            ],
            "platform_vpc_uuid_list": [
                "string"
            ],
            "tunnel_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "tunnel_vm_spec": null,
            "type": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Delete Network Group

Deletes the specified Network Group

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Network Group UUID to be deleted

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/network_groups/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Fetch Network Group configuration

Retrieves the specified Network Group configuration

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/network_groups/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List Network Groups

Retrieves a list of all Network Groups. Supported filters are:

  • account_uuid
Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "network_group"

The kind name

nested_attributes
Array of strings

Nested attributes to return for each list item

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/network_groups/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "network_group",
    "length": 1,
    "nested_attributes": [
        "string"
    ],
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Verify Network Group configuration

Verify Network Group configuration

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/network_groups/{uuid}/verify \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

nutanix/categories

Get a list of Nutanix categories.

List all categories according to the filter.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "category"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/nutanix/v1/categories/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "category",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

nutanix/clusters

Get a list of Nutanix clusters.

List all clusters according to the filter.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "cluster"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/nutanix/v1/clusters/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "cluster",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

nutanix/groups

Get Entities.

Get entities from entity db.

Authorizations:
basicAuth
Request Body schema: application/json
required
number_of_intervals_for_latest_data
integer <int32>

When retrieving latest values, how far back to look as a multiple of the downsampling interval for the metric.

group_sort_attribute
string

The name of the attribute that will be used to sort groups.

number_of_buckets
integer <int32>

For grouping, how many groups to return.

entity_ids
Array of strings

A set of entities that the request will be scoped to.

Array of objects (Entities Request Attribute)
group_member_sort_attribute
string

The name of the attribute that will be used to sort group members.

bucket_boundary
integer <int32>

For grouping, the boundary to snap to when grouping.

group_offset
integer <int64>

The offset into the total set of groups to return.

downsampling_interval
integer <int32>

Downsampling interval to apply to query if override is desired.

interval_start_ms
integer <int64>
Default: 0

For a time-series query, the start of the interval since the epoch in ms. Default is latest value only.

entity_type
required
string

The entity type that will be requested.

group_member_offset
integer <int64>

The offset into the total member set to return per group.

grouping_attribute
string

Attribute that will be used to perform a group-by if needed.

group_member_sort_downsampling_function
string (Entities Request Downsampling Function)

Downsampling function to take time series data and resolve to one value for sorting purposes.

group_sort_order
string (Entities Request Sort Order)

Sort order for entities and entity groups.

group_sort_downsample_function
string (Entities Request Downsampling Function)

Downsampling function to take time series data and resolve to one value for sorting purposes.

filter_criteria
string

FIQL filter criteria that will be used to filter the returned data.

availability_zone_scope
string
Default: "LOCAL"

The scope of availability zones from which to fetch the data.

group_count
integer <int64>

The maximum number of groups to return in the result.

Array of objects (Entities Request Attribute)
interval_end_ms
integer <int64>
Default: 0

For a time-series query, the end of the interval since the epoch in ms. Default is latest value only.

grouping_attribute_type
string (Attribute Type)

The type of an attribute being used for grouping - may be continuous or discrete.

group_member_count
integer <int64>

The maximum number of members to return per group.

group_member_sort_order
string (Entities Request Sort Order)

Sort order for entities and entity groups.

query_name
string

A custom name to use for tagging the query when debugging.

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/nutanix/v1/groups/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "availability_zone_scope": "LOCAL",
    "bucket_boundary": 0,
    "downsampling_interval": 0,
    "entity_ids": [
        "string"
    ],
    "entity_type": "string",
    "filter_criteria": "string",
    "group_attributes": [
        {
            "ancestor_entity_type": "string",
            "attribute": "string",
            "operation": "string"
        }
    ],
    "group_count": 0,
    "group_member_attributes": [
        {
            "ancestor_entity_type": "string",
            "attribute": "string",
            "operation": "string"
        }
    ],
    "group_member_count": 0,
    "group_member_offset": 0,
    "group_member_sort_attribute": "string",
    "group_member_sort_downsampling_function": "string",
    "group_member_sort_order": "string",
    "group_offset": 0,
    "group_sort_attribute": "string",
    "group_sort_downsample_function": "string",
    "group_sort_order": "string",
    "grouping_attribute": "string",
    "grouping_attribute_type": "string",
    "interval_end_ms": 0,
    "interval_start_ms": 0,
    "number_of_buckets": 0,
    "number_of_intervals_for_latest_data": 0,
    "query_name": "string"
}'

Response samples

Content type
application/json
{
  • "entity_type": "string",
  • "filtered_group_count": 0,
  • "total_entity_count": 0,
  • "filtered_entity_count": 0,
  • "group_results": [
    ],
  • "total_group_count": 0
}

nutanix/hosts

Get a list of Nutanix hosts.

List all hosts according to the filter.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "host"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/nutanix/v1/hosts/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "host",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

nutanix/images

Get a list of Nutanix images.

List all the images according to the filters

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "image"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/nutanix/v1/images/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "image",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

nutanix/subnets

Get a list of Nutanix subnets.

List all the subnets according to the filter

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "subnet"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/nutanix/v1/subnets/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "subnet",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

nutanix/vm_recovery_points

Get Nutanix vm recovery points.

List nutanix vm recovery points with filter.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "vm_recovery_point"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/nutanix/v1/vm_recovery_points/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "vm_recovery_point",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

nutanix/vms

Get a list of Nutanix VMs.

List all VMs according to the filter.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "vm"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/nutanix/v1/vms/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "vm",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

nutanix/vpcs

Get Nutanix vpcs.

List nutanix vpcs with filter.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "vpc"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/nutanix/v1/vpcs/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "vpc",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

policies

Clone Policy

Clones the specified Policy.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Policy UUID to be cloned

Request Body schema: application/json
required
policy_name
required
string <= 64 characters
required
object (policy_clone_metadata)

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/policies/{uuid}/clone \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "kind": "string",
        "policy_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "policy_name": "string"
}'

Response samples

Content type
application/json
{
  • "policy_uuid": "string"
}

Create Policy

Creates a policy and/or policy-action using data included in the request

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (policy Intent Spec with placement specified)

An intentful representation of a policy spec

required
object (policy metadata)

The policy kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/policies \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "action_list": [
                {
                    "action_type_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                }
            ],
            "action_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "condition_list": [
                {
                    "attribute_name": "string",
                    "criteria_list": [
                        {}
                    ],
                    "name": "string"
                }
            ],
            "enabled": false,
            "event_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "priority": 0
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Delete Policy

Deletes the specified policy

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/policies/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get Policy

Retrieves the specified policy

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/policies/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get Policy's execution

Retrieves the specified policy's execution

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/policies/{uuid}/executions/{exec_uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List Policies

Retrieves the list of policies, applying filters provided (if any) in the request

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "policy"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/policies/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "policy",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List Policy's execution history

Retrieves the list of policy's executions, applying filters provided (if any) in the request

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "policy"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/policies/{uuid}/executions/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "policy",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Update Policy

Updates the specified policy using data included in the request

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
required
object (policy Intent Spec with placement specified)

An intentful representation of a policy spec

required
object (policy metadata)

The policy kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/policies/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "action_list": [
                {
                    "action_type_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                }
            ],
            "action_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "condition_list": [
                {
                    "attribute_name": "string",
                    "criteria_list": [
                        {}
                    ],
                    "name": "string"
                }
            ],
            "enabled": false,
            "event_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "priority": 0
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Policy Attributes

Get policy attributes information

Retrieves schema information for attributes supported in policy.

Authorizations:
basicAuth

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/policy_attributes/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Response samples

Content type
application/json
{
  • "events": [
    ]
}

PolicyActionTypes

List action_types

Retrieves the list of policy_action_types, applying filters provided (if any) in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "policy_action_type"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/policy_action_types/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "policy_action_type",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

PolicyEvents

List events

Retrieves the list of events, applying filters provided (if any) in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "policy_event"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/policy_events/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "policy_event",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

project

Create a new project

This operation submits a request to create a new project based on the input parameters.

Authorizations:
basicAuth
Request Body schema: application/json
required

The entity to create or modify a project.

required
object (Project details, combined with Users and ACPs)

A Project resource, combined with Users and ACPs

required
object (project metadata)

The project kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/projects_internal \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "access_control_policy_list": [
            {}
        ],
        "project_detail": {
            "description": "string",
            "name": "string",
            "resources": {
                "account_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "cluster_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "default_environment_reference": {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "default_subnet_reference": {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "directory_reference_list": [
                    {
                        "kind": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "enable_directory_and_identity_provider_shortlist": true,
                "environment_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "external_network_list": [
                    {
                        "name": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "external_user_group_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "identity_providers_reference_list": [
                    {
                        "kind": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "resource_domain": {
                    "resources": [
                        {
                            "limit": 0,
                            "resource_type": "string"
                        }
                    ]
                },
                "subnet_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "tunnel_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "user_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "vpc_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ]
            }
        },
        "user_group_list": [
            {}
        ],
        "user_list": [
            {}
        ]
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get a existing project

This operation gets a existing project.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/projects_internal/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Update a existing project

This operation submits a request to update a existing project based on the input parameters.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required

The entity used to create or modify a project.

required
object (Project details, combined with Users and ACPs)

A Project resource, combined with Users and ACPs

required
object (project metadata)

The project kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/projects_internal/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "access_control_policy_list": [
            {}
        ],
        "project_detail": {
            "description": "string",
            "name": "string",
            "resources": {
                "account_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "cluster_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "default_environment_reference": {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "default_subnet_reference": {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "directory_reference_list": [
                    {
                        "kind": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "enable_directory_and_identity_provider_shortlist": true,
                "environment_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "external_network_list": [
                    {
                        "name": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "external_user_group_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "identity_providers_reference_list": [
                    {
                        "kind": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "resource_domain": {
                    "resources": [
                        {
                            "limit": 0,
                            "resource_type": "string"
                        }
                    ]
                },
                "subnet_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "tunnel_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "user_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "vpc_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ]
            }
        },
        "user_group_list": [
            {}
        ],
        "user_list": [
            {}
        ]
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

projects

Create a new project

This operation submits a request to create a new project based on the input parameters.

Authorizations:
basicAuth
Request Body schema: application/json
required

The entity to create or modify a project.

required
object (Project resource spec)

A Project resource.

required
object (project metadata)

The project kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/projects \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "description": "string",
        "name": "string",
        "resources": {
            "account_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "cluster_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "default_environment_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "default_subnet_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "directory_reference_list": [
                {
                    "kind": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "enable_directory_and_identity_provider_shortlist": true,
            "environment_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "external_network_list": [
                {
                    "name": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "external_user_group_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "identity_providers_reference_list": [
                {
                    "kind": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "resource_domain": {
                "resources": [
                    {
                        "limit": 0,
                        "resource_type": "string"
                    }
                ]
            },
            "subnet_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "tunnel_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "user_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "vpc_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ]
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Delete a existing project

This operation submits a request to delete a existing project.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/projects/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get a existing project

This operation gets a existing project.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/projects/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get a list of existing Projects

This operation gets a list of Projects, allowing for sorting and pagination. Note: Entities that have not been created successfully are not listed.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "project"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/projects/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "project",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get Pending tasks details

Retrieves the current status of the task

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

task_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Ergon task uuid

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/projects/{uuid}/pending_tasks/{task_uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Return the stats for a project

Return the stats for a projects

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
count
boolean
entity_type
string
fields
Array of strings
sort_by
string
filter
string
group_by
Array of strings
limit
integer
offset
integer
sort_field
string

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/projects/{uuid}/stats \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "count": true,
    "entity_type": "string",
    "fields": [
        "string"
    ],
    "filter": "string",
    "group_by": [
        "string"
    ],
    "limit": 0,
    "offset": 0,
    "sort_by": "string",
    "sort_field": "string"
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string"
}

Return the usage details of project

Return the project usage details

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
object (Project usage filter body)

Project usage filter body

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/projects/{uuid}/usage \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": {
        "account_reference_list": [
            "string"
        ],
        "cluster_reference_list": [
            "string"
        ],
        "environment_reference_list": [
            "string"
        ],
        "subnet_reference_list": [
            "string"
        ],
        "user_reference_list": [
            "string"
        ],
        "vpc_reference_list": [
            "string"
        ]
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string"
}

Update a existing project

This operation submits a request to update a existing project based on the input parameters.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required

The entity used to create or modify a project.

required
object (Project resource spec)

A Project resource.

required
object (project metadata)

The project kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/projects/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "description": "string",
        "name": "string",
        "resources": {
            "account_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "cluster_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "default_environment_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "default_subnet_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "directory_reference_list": [
                {
                    "kind": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "enable_directory_and_identity_provider_shortlist": true,
            "environment_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "external_network_list": [
                {
                    "name": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "external_user_group_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "identity_providers_reference_list": [
                {
                    "kind": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "resource_domain": {
                "resources": [
                    {
                        "limit": 0,
                        "resource_type": "string"
                    }
                ]
            },
            "subnet_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "tunnel_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "user_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "vpc_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ]
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Projects

Delete a existing Project

This operation submits a request to delete a existing Project.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_projects/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Does the post delete operations on Self-Service Entities

Does the post upgrade operations on Self-Service Entities

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Project UUID to be validated

Request Body schema: application/json
required
environment_reference_list
Array of strings

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_projects/{uuid}/post_delete \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "environment_reference_list": [
        "string"
    ]
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Does the post upgrade operations on Self-Service Entities

Does the post upgrade operations on Self-Service Entities

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Project UUID to be validated

Request Body schema: application/json
required
required
object (Project resource spec)

A Project resource.

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_projects/{uuid}/post_update \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "spec": {
        "description": "string",
        "name": "string",
        "resources": {
            "account_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "cluster_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "default_environment_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "default_subnet_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "directory_reference_list": [
                {
                    "kind": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "enable_directory_and_identity_provider_shortlist": true,
            "environment_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "external_network_list": [
                {
                    "name": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "external_user_group_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "identity_providers_reference_list": [
                {
                    "kind": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "resource_domain": {
                "resources": [
                    {
                        "limit": 0,
                        "resource_type": "string"
                    }
                ]
            },
            "subnet_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "tunnel_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "user_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "vpc_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ]
        }
    }
}'

Response samples

Content type
application/json
{
  • "spec": {
    }
}

Get Pending tasks details

Retrieves the current status of the task

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

task_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Ergon task uuid

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_projects/{uuid}/pending_tasks/{task_uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

List the consumption for the given project uuids

List the consumption for the given project uuids.

Authorizations:
basicAuth
query Parameters
limit
number
offset
number
Request Body schema: application/json
required
group_by
string

Group by attribute

time_unit
required
string

Grannularity of consumption data

object

Filter consumption data

object

Time range for cunsumption data

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/projects/consumption_list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filters": {
        "cluster_ids": [
            "string"
        ],
        "entity_ids": [
            "string"
        ],
        "entity_names": [
            "string"
        ],
        "entity_tags": {},
        "entity_types": [
            "string"
        ],
        "providers": [
            "string"
        ]
    },
    "group_by": "string",
    "time_range": {
        "end_time": 0,
        "start_time": 0,
        "time_delta": 0
    },
    "time_unit": "string"
}'

Response samples

Content type
application/json
{
  • "total_spend": 0,
  • "data_available_till": 0,
  • "entries": [
    ],
  • "next": "string",
  • "currency": "string"
}

Return the stats for a project

Return the stats for a projects

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
count
boolean
entity_type
string
fields
Array of strings
sort_by
string
filter
string
group_by
Array of strings
limit
integer
offset
integer
sort_field
string

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_projects/{uuid}/stats \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "count": true,
    "entity_type": "string",
    "fields": [
        "string"
    ],
    "filter": "string",
    "group_by": [
        "string"
    ],
    "limit": 0,
    "offset": 0,
    "sort_by": "string",
    "sort_field": "string"
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string"
}

Return the stats for all projects

Return the stats for all projects

Authorizations:
basicAuth
Request Body schema: application/json
required
metrics
Array of strings
project_ids
Array of strings

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_projects/stats \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metrics": [
        "string"
    ],
    "project_ids": [
        "string"
    ]
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string"
}

Return the stats for all projects

Return the stats for all projects

Authorizations:
basicAuth
Request Body schema: application/json
required
metrics
Array of strings
project_ids
Array of strings

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/projects/stats \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metrics": [
        "string"
    ],
    "project_ids": [
        "string"
    ]
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string"
}

Return the stats for this Self-Service instance

Return the stats for this Self-Service instance

Authorizations:
basicAuth
Request Body schema: application/json
required
group_by
string
filters
string
object

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/consumption_stats \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filters": "string",
    "group_by": "string",
    "time_range": {
        "end_time": 0,
        "start_time": 0,
        "time_delta": 0
    }
}'

Response samples

Content type
application/json
{
  • "data_available_till": 0,
  • "data": {
    },
  • "currency": "string"
}

Return the usage details of project

Return the project usage details

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
object (Project usage filter body)

Project usage filter body

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_projects/{uuid}/usage \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": {
        "account_reference_list": [
            "string"
        ],
        "cluster_reference_list": [
            "string"
        ],
        "environment_reference_list": [
            "string"
        ],
        "subnet_reference_list": [
            "string"
        ],
        "user_reference_list": [
            "string"
        ],
        "vpc_reference_list": [
            "string"
        ]
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string"
}

Update a existing Project

This operation submits a request to update a existing Project based on the input parameters.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required

The entity used to create or modify a project.

required
object (Project details, combined with Users and ACPs)

A Project resource, combined with Users and ACPs

required
object (project metadata)

The project kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_projects/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "access_control_policy_list": [
            {}
        ],
        "project_detail": {
            "description": "string",
            "name": "string",
            "resources": {
                "account_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "cluster_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "default_environment_reference": {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "default_subnet_reference": {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "directory_reference_list": [
                    {
                        "kind": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "enable_directory_and_identity_provider_shortlist": true,
                "environment_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "external_network_list": [
                    {
                        "name": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "external_user_group_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "identity_providers_reference_list": [
                    {
                        "kind": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "resource_domain": {
                    "resources": [
                        {
                            "limit": 0,
                            "resource_type": "string"
                        }
                    ]
                },
                "subnet_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "tunnel_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "user_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ],
                "vpc_reference_list": [
                    {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                ]
            }
        },
        "user_group_list": [
            {}
        ],
        "user_list": [
            {}
        ]
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Validates the project with respect to Self-Service entities

Validates the project with respect to Self-Service entities

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Project UUID to be validated

Request Body schema: application/json
required
vpc_uuids
Array of strings
cluster_uuids
Array of strings
account_uuids
Array of strings
subnet_uuids
Array of strings

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_projects/{uuid}/validate \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "account_uuids": [
        "string"
    ],
    "cluster_uuids": [
        "string"
    ],
    "subnet_uuids": [
        "string"
    ],
    "vpc_uuids": [
        "string"
    ]
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Validates the project with respect to Self-Service entities

Validates the project with respect to Self-Service entities

Authorizations:
basicAuth
Request Body schema: application/json
required
vpc_uuids
Array of strings
cluster_uuids
Array of strings
account_uuids
Array of strings
subnet_uuids
Array of strings

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_projects/validate \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "account_uuids": [
        "string"
    ],
    "cluster_uuids": [
        "string"
    ],
    "subnet_uuids": [
        "string"
    ],
    "vpc_uuids": [
        "string"
    ]
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

providers

Create provider

Given a spec creates a provider with associated metadata

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (provider Intent Spec with placement specified)

An intentful representation of a provider spec

required
object (provider metadata)

The provider kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/providers \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "account_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "action_list": [
                {
                    "critical": false,
                    "description": "string",
                    "name": "string",
                    "runbook": {
                        "description": "string",
                        "main_task_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "name": "string",
                        "task_definition_list": [
                            {
                                "child_tasks_local_reference_list": [
                                    {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "exec_target_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "inherit_target": true,
                                "name": "string",
                                "retries": "string",
                                "target_any_local_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "timeout_secs": "string",
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "auth_schema_list": [
                {
                    "data_type": "string",
                    "description": "string",
                    "is_hidden": true,
                    "is_mandatory": true,
                    "label": "string",
                    "library_reference": "string",
                    "name": "string",
                    "options": {
                        "choices": [
                            "string"
                        ],
                        "type": "string"
                    },
                    "regex": {
                        "should_validate": true,
                        "value": "string"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "val_type": "string",
                    "value": "string"
                }
            ],
            "description": "string",
            "infra_type": "string",
            "name": "string",
            "parent_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "resource_type_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "type": "string",
            "use_parent_auth": false,
            "variable_list": [
                {
                    "data_type": "string",
                    "description": "string",
                    "is_hidden": true,
                    "is_mandatory": true,
                    "label": "string",
                    "library_reference": "string",
                    "name": "string",
                    "options": {
                        "choices": [
                            "string"
                        ],
                        "type": "string"
                    },
                    "regex": {
                        "should_validate": true,
                        "value": "string"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "val_type": "string",
                    "value": "string"
                }
            ]
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Delete provider

Delete a provider given its UUID

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of the provider to be deleted

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/providers/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get provider

Given a UUID, returns a provider definition

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of provider to get

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/providers/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List the provider

List the provider with associated metadata

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "provider"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/providers/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "provider",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Update provider

Given a spec and provider UUID, update provider

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of provider to be updated

Request Body schema: application/json
required
required
object (provider Intent Spec with placement specified)

An intentful representation of a provider spec

required
object (provider metadata)

The provider kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/providers/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "account_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "action_list": [
                {
                    "critical": false,
                    "description": "string",
                    "name": "string",
                    "runbook": {
                        "description": "string",
                        "main_task_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "name": "string",
                        "task_definition_list": [
                            {
                                "child_tasks_local_reference_list": [
                                    {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "exec_target_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "inherit_target": true,
                                "name": "string",
                                "retries": "string",
                                "target_any_local_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "timeout_secs": "string",
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "auth_schema_list": [
                {
                    "data_type": "string",
                    "description": "string",
                    "is_hidden": true,
                    "is_mandatory": true,
                    "label": "string",
                    "library_reference": "string",
                    "name": "string",
                    "options": {
                        "choices": [
                            "string"
                        ],
                        "type": "string"
                    },
                    "regex": {
                        "should_validate": true,
                        "value": "string"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "val_type": "string",
                    "value": "string"
                }
            ],
            "description": "string",
            "infra_type": "string",
            "name": "string",
            "parent_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "resource_type_reference_list": [
                {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "type": "string",
            "use_parent_auth": false,
            "variable_list": [
                {
                    "data_type": "string",
                    "description": "string",
                    "is_hidden": true,
                    "is_mandatory": true,
                    "label": "string",
                    "library_reference": "string",
                    "name": "string",
                    "options": {
                        "choices": [
                            "string"
                        ],
                        "type": "string"
                    },
                    "regex": {
                        "should_validate": true,
                        "value": "string"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "val_type": "string",
                    "value": "string"
                }
            ]
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Proxy Login

Proxy Login for given username

Only Super Admin can use this API to proxy login for the provided username

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

proxy_for_username
required
string

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/proxy_login \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "proxy_for_username": "string"
}'

Response samples

Content type
application/json
{
  • "expires": "string",
  • "ntnx_igw_session": "string"
}

Quota

Bulk updates quota state

Bulk updates quota state for a list of entities.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

object (Response Kind)

The status of a REST API call. Only used when there is a failure to report.

object (Quota create request spec)
object (quota metadata)

The quota kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/quotas/update/state \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "resources": {
            "data": {
                "property1": -1,
                "property2": -1
            },
            "entities": {
                "property1": "string",
                "property2": "string"
            },
            "entity_type": "string",
            "metadata": {},
            "state": "string",
            "uuid": "string"
        }
    },
    "status": {}
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "metadata": {
    }
}

Create Quota

Creates quota entries for a given list of entities.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

object (Quota create request spec)
object (quota metadata)

The quota kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/quotas \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "resources": {
            "data": {
                "property1": -1,
                "property2": -1
            },
            "entities": {
                "property1": "string",
                "property2": "string"
            },
            "entity_type": "string",
            "metadata": {},
            "state": "string",
            "uuid": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "metadata": {
    }
}

Delete Quota

Delete quota for a given uuid.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Quota UUID to delete

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/quotas/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "metadata": {
    }
}

Gets the Quota state of the list of entities

Gets the Quota state of the list of entities.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string
length
number
offset
number

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/quotas/state/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": null,
    "offset": null
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "metadata": {
    }
}

List Quota

List quota entries for a given filter.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string
length
number
offset
number

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/quotas/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": null,
    "offset": null
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "message_list": [
    ],
  • "metadata": {
    }
}

Update Quota

Update quota for a given list of entities.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

UUID of the Quota entry to fetch

Request Body schema: application/json
required

Request body

object (Quota create request spec)
object (quota metadata)

The quota kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/quotas/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "resources": {
            "data": {
                "property1": -1,
                "property2": -1
            },
            "entities": {
                "property1": "string",
                "property2": "string"
            },
            "entity_type": "string",
            "metadata": {},
            "state": "string",
            "uuid": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "metadata": {
    }
}

ReplicationConnections

Create replication_connection

Creates an replication_connection using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (replication_connection Intent Spec with placement specified)

An intentful representation of a replication_connection spec

required
object (replication_connection metadata)

The replication_connection kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/replication_connections \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "account_pair_detail": {
                "first_account_reference": {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "second_account_reference": {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            }
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Delete replication_connection

Deletes the specified replication_connection.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/replication_connections/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get replication_connection

Retrieves the specified replication_connection.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/replication_connections/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List replication_connections

Retrieves the list of replication_connections, applying filters provided (if any) in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "replication_connection"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/replication_connections/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "replication_connection",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Update replication_connection

Updates the specified replication_connection using data included in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
required
object (replication_connection Intent Spec with placement specified)

An intentful representation of a replication_connection spec

required
object (replication_connection metadata)

The replication_connection kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/replication_connections/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "account_pair_detail": {
                "first_account_reference": {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "second_account_reference": {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            }
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Verify replication_connection

Verifies link between 2 accounts of replication_connection.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/replication_connections/{uuid}/verify \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "kind": "replication_connection",
  • "code": 0,
  • "message_list": [
    ],
  • "state": "string",
  • "api_version": "3.1.0"
}

resource_types

Create resource_type

Given a spec creates a resource_type with associated metadata

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (resource_type Intent Spec with placement specified)

An intentful representation of a resource_type spec

required
object (resource_type metadata)

The resource_type kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/resource_types \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "action_list": [
                {
                    "critical": false,
                    "description": "string",
                    "name": "string",
                    "runbook": {
                        "description": "string",
                        "main_task_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "name": "string",
                        "task_definition_list": [
                            {
                                "child_tasks_local_reference_list": [
                                    {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "exec_target_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "inherit_target": true,
                                "name": "string",
                                "retries": "string",
                                "target_any_local_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "timeout_secs": "string",
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "description": "string",
            "name": "string",
            "provider_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "schema_list": [
                {
                    "data_type": "string",
                    "description": "string",
                    "is_hidden": true,
                    "is_mandatory": true,
                    "label": "string",
                    "library_reference": "string",
                    "name": "string",
                    "options": {
                        "choices": [
                            "string"
                        ],
                        "type": "string"
                    },
                    "regex": {
                        "should_validate": true,
                        "value": "string"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "val_type": "string",
                    "value": "string"
                }
            ],
            "tags": [
                "string"
            ],
            "target_type": "substrate",
            "type": "string",
            "variable_list": [
                {
                    "data_type": "string",
                    "description": "string",
                    "is_hidden": true,
                    "is_mandatory": true,
                    "label": "string",
                    "library_reference": "string",
                    "name": "string",
                    "options": {
                        "choices": [
                            "string"
                        ],
                        "type": "string"
                    },
                    "regex": {
                        "should_validate": true,
                        "value": "string"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "val_type": "string",
                    "value": "string"
                }
            ]
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Delete resource_type

Delete a resource_type given its UUID

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of the resource_type to be deleted

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/resource_types/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get i/o parameters of a resource_type action

Given an resource_type action UUID, returns the input & output parameters corresponding to the action

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of the resource_type

action_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of resource_type action to fetch

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/resource_types/{uuid}/actions/{action_uuid}/parameters \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "output_parameters": [
    ],
  • "input_parameters": [
    ]
}

Get resource_type

Given a UUID, returns a resource_type definition

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of resource_type to get

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/resource_types/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

List cloud resources of the specified resource_type

List all cloud resources of a specified resource_type with associated metadata

Authorizations:
basicAuth
Request Body schema: application/json
required
resource_type_name
string

Name of the resource_type whose resources are to be fetched

Array of objects

List of input variables

outargs
Array of strings

output variables required in response

account_uuid
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of the account to fetch resources from

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/resource_types/platform_list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "account_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
    "args": [
        {}
    ],
    "outargs": [
        "string"
    ],
    "resource_type_name": "string"
}'

Response samples

Content type
application/json
{
  • "resources": { }
}

List cloud resources of the specified resource_type

List all cloud resources of a specified resource_type with associated metadata

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of resource_type to fetch

Request Body schema: application/json
required
Array of objects

List of input variables

outargs
Array of strings

output variables required in response

account_uuid
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of the account to fetch resources from

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/resource_types/{uuid}/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "account_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
    "args": [
        {}
    ],
    "outargs": [
        "string"
    ]
}'

Response samples

Content type
application/json
{
  • "resources": { }
}

List tags associated with resource_type

List all the tags associated with resource type

Authorizations:
basicAuth

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/resource_types/tags/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Response samples

Content type
application/json
{
  • "entities": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

List the resource_type

List the resource_type with associated metadata

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "resource_type"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/resource_types/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "resource_type",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Returns UI schema

returns UI schema for specific resource type action

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of the resource_type

action_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of resource_type action to fetch

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/resource_types/{uuid}/actions/{action_uuid}/custom_ui \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "entities": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Test Runbook of this Resource Type's action

Test Runbook of this Resource Type's action

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required

Request body for Test Runbook

object

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/resource_types/{uuid}/test_runbook/{action_uuid}/run \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "spec": {
        "args": [
            {
                "data_type": "string",
                "description": "string",
                "is_hidden": true,
                "is_mandatory": true,
                "label": "string",
                "library_reference": "string",
                "name": "string",
                "options": {
                    "choices": [
                        "string"
                    ],
                    "type": "string"
                },
                "regex": {
                    "should_validate": true,
                    "value": "string"
                },
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                "val_type": "string",
                "value": "string"
            }
        ],
        "default_target_reference": {
            "categories": {
                "property1": "string",
                "property2": "string"
            },
            "kind": "string",
            "name": "string",
            "type": "string",
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Update resource_type

Given a spec and resource_type UUID, update resource_type

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of resource_type to be updated

Request Body schema: application/json
required
required
object (resource_type Intent Spec with placement specified)

An intentful representation of a resource_type spec

required
object (resource_type metadata)

The resource_type kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/resource_types/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "action_list": [
                {
                    "critical": false,
                    "description": "string",
                    "name": "string",
                    "runbook": {
                        "description": "string",
                        "main_task_local_reference": {
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "name": "string",
                        "task_definition_list": [
                            {
                                "child_tasks_local_reference_list": [
                                    {
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                    }
                                ],
                                "description": "string",
                                "exec_target_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "inherit_target": true,
                                "name": "string",
                                "retries": "string",
                                "target_any_local_reference": {
                                    "categories": {
                                        "property1": "string",
                                        "property2": "string"
                                    },
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string",
                                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                                },
                                "timeout_secs": "string",
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "variable_list": [
                                    {
                                        "data_type": "string",
                                        "description": "string",
                                        "is_hidden": true,
                                        "is_mandatory": true,
                                        "label": "string",
                                        "library_reference": "string",
                                        "name": "string",
                                        "options": {
                                            "choices": [
                                                "string"
                                            ],
                                            "type": "string"
                                        },
                                        "regex": {
                                            "should_validate": true,
                                            "value": "string"
                                        },
                                        "type": "string",
                                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                        "val_type": "string",
                                        "value": "string"
                                    }
                                ]
                            }
                        ],
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                }
            ],
            "description": "string",
            "name": "string",
            "provider_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "schema_list": [
                {
                    "data_type": "string",
                    "description": "string",
                    "is_hidden": true,
                    "is_mandatory": true,
                    "label": "string",
                    "library_reference": "string",
                    "name": "string",
                    "options": {
                        "choices": [
                            "string"
                        ],
                        "type": "string"
                    },
                    "regex": {
                        "should_validate": true,
                        "value": "string"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "val_type": "string",
                    "value": "string"
                }
            ],
            "tags": [
                "string"
            ],
            "target_type": "substrate",
            "type": "string",
            "variable_list": [
                {
                    "data_type": "string",
                    "description": "string",
                    "is_hidden": true,
                    "is_mandatory": true,
                    "label": "string",
                    "library_reference": "string",
                    "name": "string",
                    "options": {
                        "choices": [
                            "string"
                        ],
                        "type": "string"
                    },
                    "regex": {
                        "should_validate": true,
                        "value": "string"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "val_type": "string",
                    "value": "string"
                }
            ]
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Runbooks

Abort execution

Aborts the specified runbook runlog.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/runlogs/{uuid}/abort \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Abort script

Aborts the specified script run request using data provided in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Runbook UUID to get

runid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

run id of the script

trlid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

trl UUID of the script

Request Body schema: application/json
required
required
object (abort script input spec)

abort script input spec

api_version
string

api version

object (runbook metadata)

The runbook kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/{uuid}/run_script/abort/{runid}/{trlid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {}
}'

Response samples

Content type
application/json
{ }

Create runbook

Creates a runbook using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (runbook Intent Spec with placement specified)

An intentful representation of a runbook spec

api_version
required
string
required
object (runbook metadata)

The runbook kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "default_credential_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "default_target_reference": {
                "categories": {
                    "property1": "string",
                    "property2": "string"
                },
                "kind": "string",
                "name": "string",
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "endpoint_definition_list": [
                {
                    "name": "string",
                    "provider_type": "string",
                    "tunnel_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "value_type": "string"
                }
            ],
            "endpoints_information": [
                {
                    "description": "string",
                    "endpoint_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                }
            ],
            "runbook": {
                "description": "string",
                "main_task_local_reference": {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "name": "string",
                "output_variables": [
                    "string"
                ],
                "task_definition_list": [
                    {
                        "child_tasks_local_reference_list": [
                            {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            }
                        ],
                        "description": "string",
                        "exec_target_reference": {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "inherit_target": true,
                        "name": "string",
                        "retries": "string",
                        "target_any_local_reference": {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "timeout_secs": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    }
                ],
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                "variable_list": [
                    {
                        "data_type": "string",
                        "description": "string",
                        "is_hidden": true,
                        "is_mandatory": true,
                        "label": "string",
                        "library_reference": "string",
                        "name": "string",
                        "options": {
                            "choices": [
                                "string"
                            ],
                            "type": "string"
                        },
                        "regex": {
                            "should_validate": true,
                            "value": "string"
                        },
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "val_type": "string",
                        "value": "string"
                    }
                ]
            }
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Delete runbook

Deletes the specified runbook.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Download runbook

Downloads the specified runbook in JSON format with secrets encrypted.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Runbook UUID to get

Request Body schema: multipart/form-data
passphrase
string

Passphrase to encrypt secrets

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/{uuid}/export_file \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: multipart/form-data' \
    --data '{
    "passphrase": "string"
}'

Response samples

Content type
application/json
null

Download runbook

Downloads the specified runbook in JSON format.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Action UUID to get

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/{uuid}/export_file \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
null

Download runlog output file

Downloads the output file of the specified runbook runlog.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/runlogs/{uuid}/output/download \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
"string"

Download task runlog output file

Downloads the output file of the specified task runlog.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

children_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Uuid of child runlog

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/runlogs/{uuid}/children/{children_uuid}/output/download \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
"string"

Execute runbook marketplace item

Execute the runbook marketplace item using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
required
object (Spec for Runbook clone from Marketplace.)

Spec for Runbook clone from Marketplace.

api_version
required
string
required
object (runbook metadata)

The runbook kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/marketplace_clone \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "name": "string",
        "resources": {
            "marketplace_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            }
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Execute runbook marketplace item

Execute the runbook marketplace item using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
required
object (Spec for Runbook execute.)

Spec for Runbook execute.

api_version
required
string
required
object (runbook metadata)

The runbook kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/marketplace_execute \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "resources": {
            "args": [
                {
                    "name": "string",
                    "task_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "value": "string"
                }
            ],
            "default_target_reference": {
                "categories": {
                    "property1": "string",
                    "property2": "string"
                },
                "kind": "string",
                "name": "string",
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "marketplace_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "modified_credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ]
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Execute/Run runbook

Execute/Run the specified runbook.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json

Request body for runbook run.

object

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/{uuid}/run \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "spec": {
        "args": [
            {
                "data_type": "string",
                "description": "string",
                "is_hidden": true,
                "is_mandatory": true,
                "label": "string",
                "library_reference": "string",
                "name": "string",
                "options": {
                    "choices": [
                        "string"
                    ],
                    "type": "string"
                },
                "regex": {
                    "should_validate": true,
                    "value": "string"
                },
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                "val_type": "string",
                "value": "string"
            }
        ],
        "default_target_reference": {
            "categories": {
                "property1": "string",
                "property2": "string"
            },
            "kind": "string",
            "name": "string",
            "type": "string",
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Execute/Run runbook

Execute/Run the specified runbook.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json

Request body for runbook run.

object

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/{uuid}/execute \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "spec": {
        "args": [
            {
                "data_type": "string",
                "description": "string",
                "is_hidden": true,
                "is_mandatory": true,
                "label": "string",
                "library_reference": "string",
                "name": "string",
                "options": {
                    "choices": [
                        "string"
                    ],
                    "type": "string"
                },
                "regex": {
                    "should_validate": true,
                    "value": "string"
                },
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                "val_type": "string",
                "value": "string"
            }
        ],
        "default_target_reference": {
            "categories": {
                "property1": "string",
                "property2": "string"
            },
            "kind": "string",
            "name": "string",
            "type": "string",
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Export runbook

Retrieves the specified runbook in JSON format.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Action UUID to get

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/{uuid}/export_json \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Get dynamic variable values

Initiates execution of escript/http request configured for the specific variable and returns the final value.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

variable_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Variable UUID

Request Body schema: application/json
required
trlId
string

trl ID of the initiated execution

overridden_field
string

will be used to override several field for http request or eScript value

requestId
string

Request ID

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/{uuid}/variables/{variable_uuid}/values \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "overridden_field": "string",
    "requestId": "string",
    "trlId": "string"
}'

Response samples

Content type
application/json
{
  • "trl_id": "string",
  • "state": "string",
  • "run_id": "string",
  • "values": [
    ],
  • "request_id": "string"
}

Get dynamic variable values

Initiates execution of escript/http request configured for the specific variable and returns the final value.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

runbook UUID to get

variable_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of variable whose value needs to be fetched

query Parameters
trlId
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

trl ID of the initiated execution

requestId
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Request ID

overridden_field
string

will be used to override several field for http request or eScript value

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/{uuid}/variables/{variable_uuid}/values \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "trl_id": "string",
  • "state": "string",
  • "run_id": "string",
  • "values": [
    ],
  • "request_id": "string"
}

Get runbook

Returns the specified runbook.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get runbook runlog

Retrieves the specified runbook runlog information.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/runlogs/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Get runlog output

Returns last ten lines of output of the specified task runlog.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

children_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Uuid of child runlog

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/runlogs/{uuid}/children/{children_uuid}/output \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Get script output

Retrives the output for the script run with data included in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Runbook UUID to get

trlid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

trl UUID of the script

ergon_task_id
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Ergont task UUID

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/{uuid}/run_script/output/{trlid}/{ergon_task_id} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "output": "string",
  • "state": "string"
}

Import runbook

Creates a runbook using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (Runbook upload kind)

Runbook upload kind

api_version
required
string
required
object (runbook metadata)

The runbook kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/import_json \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "default_credential_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "default_target_reference": {
                "categories": {
                    "property1": "string",
                    "property2": "string"
                },
                "kind": "string",
                "name": "string",
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "endpoint_definition_list": [
                {
                    "name": "string",
                    "provider_type": "string",
                    "tunnel_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "value_type": "string"
                }
            ],
            "endpoints_information": [
                {
                    "description": "string",
                    "endpoint_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                }
            ],
            "runbook": {
                "description": "string",
                "main_task_local_reference": {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "name": "string",
                "output_variables": [
                    "string"
                ],
                "task_definition_list": [
                    {
                        "child_tasks_local_reference_list": [
                            {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            }
                        ],
                        "description": "string",
                        "exec_target_reference": {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "inherit_target": true,
                        "name": "string",
                        "retries": "string",
                        "target_any_local_reference": {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "timeout_secs": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    }
                ],
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                "variable_list": [
                    {
                        "data_type": "string",
                        "description": "string",
                        "is_hidden": true,
                        "is_mandatory": true,
                        "label": "string",
                        "library_reference": "string",
                        "name": "string",
                        "options": {
                            "choices": [
                                "string"
                            ],
                            "type": "string"
                        },
                        "regex": {
                            "should_validate": true,
                            "value": "string"
                        },
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "val_type": "string",
                        "value": "string"
                    }
                ]
            }
        }
    }
}'

Response samples

Content type
application/json
{
  • "uuid": "string"
}

List all runbook runlogs

Retrieves the list of all runbook runlogs, applying filter provided (if any) in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "runbook_runlog"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/runlogs/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "runbook_runlog",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string",
  • "metadata": {
    }
}

List all runlogs for given execution

Retrieves the list of runlogs associated with the runbook execution, applying filter provided (if any) in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
kind
string
Default: "runbook_runlog"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/runlogs/{uuid}/children/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "runbook_runlog",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string",
  • "metadata": {
    }
}

List runbooks

Retrieves the list of runbooks, applying filters provided (if any) in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "runbook"

The kind name

object (Supported filters in runbook list call)

Supported filters in runbook list call

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "advanced_filter": {
        "account_reference_list": [
            "string"
        ],
        "project_reference_list": [
            "string"
        ],
        "tunnel_reference_list": [
            "string"
        ]
    },
    "filter": "string",
    "kind": "runbook",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Pause runbook runlog

Pauses the specified running runbook runlog.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Runlog UUID to pause

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/runlogs/{uuid}/pause \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Play runbook runlog

Plays the specified paused runbook runlog.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID'> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Runlog UUID to play

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/runlogs/{uuid}/play \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Rerun runbook runlog

Reruns the specified failed runbook runlog.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Runlog UUID to rerun

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/runlogs/{uuid}/rerun \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Resume task runlog

Resumes the specified task runlog in CONFIRM/INPUT state.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

children_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Uuid of task to resume

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/runlogs/{uuid}/children/{children_uuid}/resume \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Run script

Runs the script with data included in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Runbook UUID to get

Request Body schema: application/json
required
required
object (script input spec)

script input spec

api_version
string

api version

object (runbook metadata)

The runbook kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/{uuid}/run_script \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "machine": "string",
        "port": "string",
        "provider_operation_payload": "string",
        "runid": "string"
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "metadata": {
    }
}

Update runbook

Updates the specified runbook using data included in the request.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
required
object (runbook Intent Spec with placement specified)

An intentful representation of a runbook spec

api_version
required
string
required
object (runbook metadata)

The runbook kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "default_credential_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "default_target_reference": {
                "categories": {
                    "property1": "string",
                    "property2": "string"
                },
                "kind": "string",
                "name": "string",
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "endpoint_definition_list": [
                {
                    "name": "string",
                    "provider_type": "string",
                    "tunnel_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "value_type": "string"
                }
            ],
            "endpoints_information": [
                {
                    "description": "string",
                    "endpoint_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                }
            ],
            "runbook": {
                "description": "string",
                "main_task_local_reference": {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "name": "string",
                "output_variables": [
                    "string"
                ],
                "task_definition_list": [
                    {
                        "child_tasks_local_reference_list": [
                            {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            }
                        ],
                        "description": "string",
                        "exec_target_reference": {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "inherit_target": true,
                        "name": "string",
                        "retries": "string",
                        "target_any_local_reference": {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "timeout_secs": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    }
                ],
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                "variable_list": [
                    {
                        "data_type": "string",
                        "description": "string",
                        "is_hidden": true,
                        "is_mandatory": true,
                        "label": "string",
                        "library_reference": "string",
                        "name": "string",
                        "options": {
                            "choices": [
                                "string"
                            ],
                            "type": "string"
                        },
                        "regex": {
                            "should_validate": true,
                            "value": "string"
                        },
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "val_type": "string",
                        "value": "string"
                    }
                ]
            }
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Update runbook

Updates the specified runbook using named based request payload.

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Runbook uuid to update

Request Body schema: application/json
required

Request body

required
object (Runbook upload kind)

Runbook upload kind

api_version
required
string
required
object (runbook metadata)

The runbook kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/{uuid}/update \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "api_version": "string",
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "credential_definition_list": [
                {
                    "account_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "cred_class": "string",
                    "description": "string",
                    "exec_runbook_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "name": "string",
                    "resource_type_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "username": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "variable_list": [
                        {
                            "data_type": "string",
                            "description": "string",
                            "is_hidden": true,
                            "is_mandatory": true,
                            "label": "string",
                            "library_reference": "string",
                            "name": "string",
                            "options": {
                                "choices": [
                                    "string"
                                ],
                                "type": "string"
                            },
                            "regex": {
                                "should_validate": true,
                                "value": "string"
                            },
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                            "val_type": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "default_credential_local_reference": {
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "default_target_reference": {
                "categories": {
                    "property1": "string",
                    "property2": "string"
                },
                "kind": "string",
                "name": "string",
                "type": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
            },
            "endpoint_definition_list": [
                {
                    "name": "string",
                    "provider_type": "string",
                    "tunnel_reference": {
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    },
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                    "value_type": "string"
                }
            ],
            "endpoints_information": [
                {
                    "description": "string",
                    "endpoint_reference": {
                        "categories": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "kind": "string",
                        "name": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                    }
                }
            ],
            "runbook": {
                "description": "string",
                "main_task_local_reference": {
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "name": "string",
                "output_variables": [
                    "string"
                ],
                "task_definition_list": [
                    {
                        "child_tasks_local_reference_list": [
                            {
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                            }
                        ],
                        "description": "string",
                        "exec_target_reference": {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "inherit_target": true,
                        "name": "string",
                        "retries": "string",
                        "target_any_local_reference": {
                            "categories": {
                                "property1": "string",
                                "property2": "string"
                            },
                            "kind": "string",
                            "name": "string",
                            "type": "string",
                            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                        },
                        "timeout_secs": "string",
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "variable_list": [
                            {
                                "data_type": "string",
                                "description": "string",
                                "is_hidden": true,
                                "is_mandatory": true,
                                "label": "string",
                                "library_reference": "string",
                                "name": "string",
                                "options": {
                                    "choices": [
                                        "string"
                                    ],
                                    "type": "string"
                                },
                                "regex": {
                                    "should_validate": true,
                                    "value": "string"
                                },
                                "type": "string",
                                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                                "val_type": "string",
                                "value": "string"
                            }
                        ]
                    }
                ],
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                "variable_list": [
                    {
                        "data_type": "string",
                        "description": "string",
                        "is_hidden": true,
                        "is_mandatory": true,
                        "label": "string",
                        "library_reference": "string",
                        "name": "string",
                        "options": {
                            "choices": [
                                "string"
                            ],
                            "type": "string"
                        },
                        "regex": {
                            "should_validate": true,
                            "value": "string"
                        },
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "val_type": "string",
                        "value": "string"
                    }
                ]
            }
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Upload runbook

Creates a runbook from uploaded file.

Authorizations:
basicAuth
Request Body schema: application/octet-stream
required

runbook_file

object

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/runbooks/import_file \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/octet-stream' \

Response samples

Content type
application/json
{
  • "uuid": "string"
}

SaaS Consumption

Delete consumption entries for given time range

Delete consumption entries for given time range

Authorizations:
basicAuth

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/saas_consumption \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

List consumption entries for given time range

List consumption entries for given time range

Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "app_saas_consumption"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/saas_consumption/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "app_saas_consumption",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

system preference

Get System Preference

Returns a system preference

Authorizations:
basicAuth

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/system_preference \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "preferences": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Update system preference

Given a spec and system, update system preference

Authorizations:
basicAuth
Request Body schema: application/json
required
object (system_preferences)

System Preference.

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/system_preference \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "preferences": {
        "project_user": {
            "landing_page": {
                "app_id": "string",
                "last_viewed": "string",
                "type": "string",
                "url": "string"
            }
        }
    }
}'

Response samples

Content type
application/json
{
  • "preferences": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

tunnels

Create Tunnel

Creates a tunnel entity using data included in the request

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

required
object (tunnel Intent Spec with placement specified)

An intentful representation of a tunnel spec

required
object (tunnel metadata)

The tunnel kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/tunnels \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "created_by": "string",
            "credential": {
                "account_reference": {
                    "categories": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "kind": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "cred_class": "string",
                "description": "string",
                "exec_runbook_reference": {
                    "categories": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "kind": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "name": "string",
                "resource_type_reference": {
                    "categories": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "kind": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "type": "string",
                "username": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                "variable_list": [
                    {
                        "data_type": "string",
                        "description": "string",
                        "is_hidden": true,
                        "is_mandatory": true,
                        "label": "string",
                        "library_reference": "string",
                        "name": "string",
                        "options": {
                            "choices": [
                                "string"
                            ],
                            "type": "string"
                        },
                        "regex": {
                            "should_validate": true,
                            "value": "string"
                        },
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "val_type": "string",
                        "value": "string"
                    }
                ]
            },
            "type": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Creates tunnel entity for Network Group

Creates tunnel entity for Network Group

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required

Request body

required
object (network_group_tunnel_vm Intent Spec with placement specified)

An intentful representation of a network_group_tunnel_vm spec

required
object (network_group_tunnel_vm metadata)

The network_group_tunnel_vm kind metadata

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/network_groups/{uuid}/tunnels \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "description": "string",
        "name": "string",
        "resources": {
            "cluster_uuid": "string",
            "subnet_uuid": "string",
            "type": "string",
            "vm_name": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Delete Tunnel

Deletes the specified tunnel

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/tunnels/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "kind": "tunnel",
  • "code": 0,
  • "message_list": [
    ],
  • "state": "string",
  • "api_version": "3.1.0"
}

Deletes the Tunnel associated with Network Group

Deletes the Tunnel associated with Network Group

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Network Group UUID

tunnel_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

Tunnel UUID to be deleted

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/network_groups/{uuid}/tunnels/{tunnel_uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Get CNAME of the tunnel server for this cluster

Get CNAME of the tunnel server for this cluster

Authorizations:
basicAuth

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/tunnels/server \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "kind": "tunnel",
  • "code": 0,
  • "message_list": [
    ],
  • "state": "string",
  • "api_version": "3.1.0"
}

Get new config file for tunnel creation

Returns new config file for tunnel

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/x-www-form-urlencoded
passphrase
string

Passphrase to encrypt secrets

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/tunnels/{uuid}/config_file \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "passphrase": "string"
}'

Response samples

Content type
application/json
null

Get Tunnel

Retrieves the specified Tunnel

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/tunnels/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Gets the entities in which the tunnel is referenced

Returns entity references

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/tunnels/{uuid}/entity_references \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "blueprint": [
    ],
  • "project": [
    ],
  • "app": [
    ],
  • "account": [
    ]
}

List Tunnels

Retrieves a list of all tunnels. Supported filters are:

  • name
Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "tunnel"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/tunnels/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "tunnel",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Update Tunnel

Updates the specified Tunnel using data included in the request

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Request Body schema: application/json
required
required
object (tunnel Intent Spec with placement specified)

An intentful representation of a tunnel spec

required
object (tunnel metadata)

The tunnel kind metadata

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/tunnels/{uuid} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "metadata": {
        "categories": {
            "property1": "string",
            "property2": "string"
        },
        "categories_mapping": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "owner_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "project_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "should_force_translate": true,
        "spec_hash": "string",
        "spec_version": 0,
        "use_categories_mapping": false,
        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
    },
    "spec": {
        "availability_zone_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "cluster_reference": {
            "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
        },
        "description": "string",
        "name": "string",
        "resources": {
            "created_by": "string",
            "credential": {
                "account_reference": {
                    "categories": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "kind": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "cred_class": "string",
                "description": "string",
                "exec_runbook_reference": {
                    "categories": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "kind": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "name": "string",
                "resource_type_reference": {
                    "categories": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "kind": "string",
                    "name": "string",
                    "type": "string",
                    "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb"
                },
                "type": "string",
                "username": "string",
                "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                "variable_list": [
                    {
                        "data_type": "string",
                        "description": "string",
                        "is_hidden": true,
                        "is_mandatory": true,
                        "label": "string",
                        "library_reference": "string",
                        "name": "string",
                        "options": {
                            "choices": [
                                "string"
                            ],
                            "type": "string"
                        },
                        "regex": {
                            "should_validate": true,
                            "value": "string"
                        },
                        "type": "string",
                        "uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
                        "val_type": "string",
                        "value": "string"
                    }
                ]
            },
            "type": "string"
        }
    }
}'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "spec": {
    },
  • "api_version": "3.1.0",
  • "metadata": {
    }
}

Validate Tunnel

Validates the tunnel endpoint & port

Authorizations:
basicAuth
path Parameters
uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...
Example: 0e09cf83-ac68-4f28-af70-6df9a43df4f0

The UUID of the entity.

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/tunnels/{uuid}/validate \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "kind": "tunnel",
  • "code": 0,
  • "message_list": [
    ],
  • "state": "string",
  • "api_version": "3.1.0"
}

user preference

Create User Preference

Creates a user preference using data included in the request.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

object (user_preferences)

User Preference.

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/user_preference \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "preferences": {
        "global": {
            "landing_page": {
                "app_id": "string",
                "last_viewed": "string",
                "type": "string",
                "url": "string"
            }
        }
    }
}'

Response samples

Content type
application/json
{
  • "username": "string",
  • "preferences": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Get User Preference

Returns a user preference

Authorizations:
basicAuth

Responses

Request samples 

curl --request GET \
    --url https://pc-host-ip:9440/api/nutanix/v3/user_preference \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "username": "string",
  • "preferences": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

Update user preference

Given a spec and user, update user preference

Authorizations:
basicAuth
Request Body schema: application/json
required
object (user_preferences)

User Preference.

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/user_preference \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "preferences": {
        "global": {
            "landing_page": {
                "app_id": "string",
                "last_viewed": "string",
                "type": "string",
                "url": "string"
            }
        }
    }
}'

Response samples

Content type
application/json
{
  • "username": "string",
  • "preferences": {
    },
  • "api_version": "string",
  • "metadata": {
    }
}

users

Create API Key

Creates an API key using data included in the request

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

should_grant_admin_access
boolean
Default: false

Flag to determine whether to provide admin access or not

name
required
string

Name of the key

Array of objects (project_role_mapping)

Roles associated with given key

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/api_keys \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "name": "string",
    "roles": [
        {}
    ],
    "should_grant_admin_access": false
}'

Response samples

Content type
application/json
null

Delete API Key

Deletes the specified API Key

Authorizations:
basicAuth
path Parameters
name
required
string

Key name to delete

Responses

Request samples 

curl --request DELETE \
    --url https://pc-host-ip:9440/api/nutanix/v3/api_keys/{name} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \

Response samples

Content type
application/json
{
  • "kind": "project",
  • "code": 0,
  • "message_list": [
    ],
  • "state": "string",
  • "api_version": "3.1.0"
}

Enable/Disable API key

Enable/Disable access to the API key. Used for temporarily disabling accesses

Authorizations:
basicAuth
path Parameters
name
required
string

Key name to disable accesses to

Request Body schema: application/json
required

Request body for enabling/disabling API key

state
string

Intended state of the key

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/api_keys/{name} \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Response samples

Content type
application/json
{
  • "kind": "project",
  • "code": 0,
  • "message_list": [
    ],
  • "state": "string",
  • "api_version": "3.1.0"
}

List all API keys

Retrieves a list of all API keys. Supported filters are:

  • name
Authorizations:
basicAuth
Request Body schema: application/json
required
kind
string
Default: "project"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/api_keys/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "project",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "total_matches": 0,
  • "entities": [
    ]
}

Reset API token

Reset API token for the specified key

Authorizations:
basicAuth
path Parameters
name
required
string

Key name to delete

Responses

Request samples 

curl --request PUT \
    --url https://pc-host-ip:9440/api/nutanix/v3/api_keys/{name}/reset \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \

Response samples

Content type
application/json
null

Users

User search by pattern

Search for usernames that match the pattern in the Database or Active Directory.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

query
required
string <= 64 characters

Pattern to search for user in directory_service or idf

is_wildcard_search
boolean
Default: true

The attribute that tells if the query is a wildcard match or exact match query.

user_type
required
string <= 64 characters

Type of user - AD, IdP or PC

provider_uuid
required
string <UUID> <= 64 characters

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/calm_users/search \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "is_wildcard_search": true,
    "provider_uuid": "b4d15375-1097-4c96-a4c4-4cb5809b05bb",
    "query": "string",
    "user_type": "string"
}'

Response samples

Content type
application/json
{
  • "users_search_metadata": {
    },
  • "search_result_list": [
    ],
  • "api_version": "string"
}

vmware

List tags

List all tags requested in the filter. Supported filters are:

  • account_uuid
  • tag_ids
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/tags/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

List VM categories

List all categories available in account whose tags are attachable to VM

  • account_uuid
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/vm_categories/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

vmware/cluster

List all clusters

List all clusters in a datacenter. Supported filters are:

  • account_uuid
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/cluster/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

vmware/customization

Get vmware guest customization

Given a Acccount UUID, returns vmware guest customization

Authorizations:
basicAuth
path Parameters
account_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of account

Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/accounts/{account_uuid}/customization/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

List predefined windows guest customization

List all predefined guest customization in a Vcenter. Supported filters are:

  • account_uuid
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/customization/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

vmware/datacenter

List datacenters

List all datatcenters in a vcenter account. Supported filters are:

  • account_uuid
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/datacenter/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

vmware/datastore

List datastores

List all datastores in a host. Supported filters are:

  • account_uuid
  • hostname
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/datastore/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

vmware/file_path

List file paths from datastore

List all file paths from a datastore. Supported filters are:

  • account_uuid
  • datastore_url
  • file_extension
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/file_paths/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

vmware/host

List all hosts

List all hosts in a datacenter. Supported filters are:

  • account_uuid
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/host/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

vmware/library

List all content libraries

List all content libraries

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/library/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string"
}

vmware/library_items

List all items from content libraries

List all items in content libraries. Supported filters are:

  • library_id
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/library_items/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "api_version": "string"
}

vmware/network

List all networks

List all networks types supported by the host. Supported filters are:

  • account_uuid
  • hostname
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/network/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

vmware/network_adapter

List all network adapters supported

List all network adapter supported by vmware.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/network_adapter/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

vmware/storage_pod

List all storage_pods

List all storage_pods in a datacenter. Supported filters are:

  • account_uuid
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/storage_pod/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

vmware/template

Get vmware template list

Given a Acccount UUID, returns vmware template list

Authorizations:
basicAuth
path Parameters
account_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of account

Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/accounts/{account_uuid}/templates/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

List vm templates

List all vm templates in a datacenter. Supported filters are:

  • account_uuid
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/template/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

vmware/timezone

List all timezones

List all timezones supported by the guest os. Supported filters are:

  • account_uuid
  • guest_os
Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/timezone/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

vmware/vm

Get vmware vm given account id

Given a UUID, returns a vmware list of vm

Authorizations:
basicAuth
path Parameters
account_uuid
required
string <UUID> ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

uuid of account

Request Body schema: application/json
required

Request body

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/vmware/v6/accounts/{account_uuid}/vms/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "length": 1,
    "offset": 0
}'

Response samples

Content type
application/json
{ }

xi/categories

Get Xi cloud categories

List all categories according to the filter.

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

kind
string
Default: "xi"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/xi/v1/categories/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "xi",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entity_type": "string",
  • "filtered_group_count": 0,
  • "total_entity_count": 0,
  • "filtered_entity_count": 0,
  • "group_results": [
    ],
  • "total_group_count": 0
}

xi/images

Get Xi cloud images

List all the images according to the filters

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

kind
string
Default: "xi"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/xi/v1/images/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "xi",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ]
}

xi/subnets

Get Xi cloud subnets

List all the subnets according to the filter

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

kind
string
Default: "xi"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/xi/v1/subnets/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "xi",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ]
}

xi/vpcs

Get Xi cloud VPCs

List all the virtual networks according to the filter

Authorizations:
basicAuth
Request Body schema: application/json
required

Request body

kind
string
Default: "xi"

The kind name

sort_attribute
string

The attribute to perform sort on

filter
string

The filter in FIQL syntax used for the results.

length
integer <int32> >= 1

The number of records to retrieve relative to the offset

sort_order
any (Sort order)

The sort order in which results are returned

offset
integer <int32> >= 0

Offset from the start of the entity list

Responses

Request samples 

curl --request POST \
    --url https://pc-host-ip:9440/api/nutanix/v3/xi/v1/vpcs/list \
    --header 'Accept: application/json' \
    --header 'Authorization: Basic <basic_auth_token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "filter": "string",
    "kind": "xi",
    "length": 1,
    "offset": 0,
    "sort_attribute": "string",
    "sort_order": "string"
}'

Response samples

Content type
application/json
{
  • "entities": [
    ]
}