Custom Patch Metadata

Custom Patch Metadata allows to manage metadata for a specific patches.

Base URL

        https://<ConsoleFQDN>:<Port>/st/console/api/v1.0/custompatch/metadata

Supported Requests

Method URL Input Return

DELETE

https://<consoleFQDN:port>/st/console/api/v1.0/ custompatch/metadata/{patchUId}

 

Success or failure code

GET

https://<consoleFQDN:port>/st/console/api/v1.0/custompatch/ metadata/{patchUId}

 

CustomMetada[]

PUT

https://<consoleFQDN:port>/st/console/api/v1.0/custompatch metadata/{patchUId}

Custom Patch Metadata

Success or failure code

POST

https://<consoleFQDN:port>/st/console/api/v1.0/custompatch/ metadata

Request Body

patch ID and the associated metadata array

Input Models

Name Type Description
patchUid String The unique ID (GUID) of the patch
Name Type Description
Key String The metadata key.
Value String The metadata value

Example with Sample Response

To retrieve all custom metadata associated with a specific patch

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/custompatch/metadata/{patchUid}

Sample Response

Copy 
{
        "patchUid": "0c8cc79e-8551-4100-8882-e4b1b0f6a688",
        "metadata": [
        {
        "key": "patchinstallationdoc",
        "value": "https://help.ivanti.com/iv/help/en_US/isec/API/Topics/Agent-Deployments.htm"
        }
        ],
        "links": {
        "self": {
        "href": "https://localhost:3121/st/console/api/v1.0/custompatch/metadata/0c8cc79e-8551-4100-8882-e4b1b0f6a688"
        }
        }
}

Other Request Examples

POST Request

https://<consoleFQDN:port>/st/console/api/v1.0/custompatch/metadata

Copy 
{
    "patchUid": "0c8cc79e-8551-4100-8882-e4b1b0f6a688",
    "metadata": [
    {
    "key": "patchinstallationdoc",
    "value": "https://help.ivanti.com/iv/help/en_US/isec/API/Topics/Agent-Deployments.htm"
    }
    ]
}

PUT Request

https://<consoleFQDN:port>/st/console/api/v1.0/custompatch/metadata/{patchUid}

Copy 
{
        "key": "patchuninstallsteps",
        "value": "https://help.ivanti.com/iv/help/en_US/isec/API/Topics/Agent-Deployments.htm"
}

DELETE Request

https://<consoleFQDN:port>/st/console/api/v1.0/custompatch/metadata/{patchUid}