CatalogData

The following lists the HTTP methods, you to access the data from the catalog.

HTTP Method - POST

Returns an action and creates a new resource (ID set by service).

POST /catalog/external

HTTP Method - PATCH

Edits the catalog record.

PATCH /catalog/external/{packageId}

HTTP Method - DELETE

Deletes the catalog record for the specified packageId, along with all associated Package revisions, Distributions, and Deployment Status records related to this app.

DELETE /catalog/external/{packageId}

HTTP Method - GET

Returns a resource and resource collection.

Returns the package revisions in the application's user interface.

GET /catalog/external/{packageId}

POST Method

Request URI

Enter the specific landscape (only used by RapidApi) to get the requests.

Example request uri: rapidapi.com

POST /catalog/external

Returns the packageId of the newly created item.

Header Parameters

Name	Type	Description
X-Landscape-Url	String	Directs the request to the specified landscape (only used by RapidApi)
X-RapidAPI-Key	ENUM	The key that applications and developers need to invoke the API.
X-RapidAPI-Host	String	The name that identifies which API will be used. For example: my-api-name.ivanti.rapidapi.com.

Request Body Parameters

Name	Type	Description
api-version	String	The current API version number.

Example Response

{
  "botDefinitionId": "642d4d01091245ad5c98c90c",
  "agentIds": [
    "agent-1",
    "agent-2"
  ],
  "inputs": [
    {
      "inputId": "acd5ac4a-15cc-4cf8-b79e-57bcfa01a5b4",
      "inputValue": "Microsoft Defender"
    }
  ]
}
                                            

PATCH Method

Request URI

Enter the specific landscape (only used by RapidApi) to edit the requests.

Example request uri: rapidapi.com

PATCH /catalog/external/{packageId}

This request edits all the catalogs.

Header Parameters

Name	Type	Description
Authorization	String	Use the Bearer <access-token> value determined during the Authenticate to the Patch Management API process.
X-Landscape-Url	String	Directs the request to the specified landscape (only used by RapidApi)
X-RapidAPI-Key	Enum	The key that applications and developers need to invoke the API.
X-RapidAPI-Host	String	The name that identifies which API will be used. For example: my-api-name.ivanti.rapidapi.com.
packageId	String	Gets the package details for the particular package ID.

Request Body Parameters

Name	Type	Description
api-version	String	The current API version number.

Example Response

{
  "packageId": "string",
  "packageName": "string",
  "packageNameForSorting": "string",
  "platform": "Windows",
  "created": "2024-08-12T07:33:28.890Z",
  "createdById": "string",
  "createdByName": "string",
  "lastModified": "2024-08-12T07:33:28.890Z",
  "lastModifiedById": "string",
  "lastModifiedByName": "string",
  "notes": "string",
  "showInAnalystView": false,
  "packageExists": true,
  "compliantCount": 0,
  "notCompliantCount": 0,
  "notApplicableCount": 0,
  "unknownCount": 0,
  "tags": [
    "string"
  ],
  "version": "string",
  "publisher": "string"
}
                                            

DELETE Method

Request URI

Enter the specific landscape (only used by RapidApi) to delete the requests using the IDs.

Example request uri: rapidapi.com

DELETE /catalog/external/{packageId}

This request deletes the catalog records.

Header Parameters

Name	Type	Description
Authorization	String	Use the Bearer <access-token> value determined during the Authenticate to the Patch Management API process.
X-Landscape-Url	String	Directs the request to the specified landscape (only used by RapidApi)
X-RapidAPI-Key	Enum	The key that applications and developers need to invoke the API.
X-RapidAPI-Host	String	The name that identifies which API will be used. For example: my-api-name.ivanti.rapidapi.com.
packageid	String	Gets the package details for the particular package ID.

Request Body Parameters

Name	Type	Description
api-version	String	The current API version number.

Example Response

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "additionalProp1": "string",
  "additionalProp2": "string",
  "additionalProp3": "string"
}
                                            

GET Method

Request URI

Enter the specific landscape (only used by RapidApi) to get the requests.

Example request uri: rapidapi.com

GET /catalog/external/{packageId}

This request gets all the catalogs.

Header Parameters

Name	Type	Description
Authorization	String	Use the Bearer <access-token> value determined during the Authenticate to the Patch Management API process.
X-Landscape-Url	String	Directs the request to the specified landscape (only used by RapidApi)
X-RapidAPI-Key	Enum	The key that applications and developers need to invoke the API.
X-RapidAPI-Host	String	The name that identifies which API will be used. For example: my-api-name.ivanti.rapidapi.com.
packageid	String	Gets the package details for the particular package ID.

Request Body Parameters

Name	Type	Description
api-version	String	The current API version number.

Example Response

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "additionalProp1": "string",
  "additionalProp2": "string",
  "additionalProp3": "string"
}
                                            