Distribution
The following lists the HTTP methods, to add a new distribution to an app and update the existing distribution.
HTTP Method - POST
Adds a new distribution to the app.
HTTP Method - PUT
Updates the existing distribution. You can add or remove the targets.
HTTP Method - GET
Gets all the distributions of an app.
-
Request without target data:GET /distribution/external/{packageId}
-
Request with target data: GET /distribution/external/{packageId}?useDeviceName=true
POST Method
Request URI
Enter the specific landscape (only used by RapidApi) to get the requests.
Example request uri: rapidapi.com
Adds a new distribution to the app.
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. |
Request Body Parameters
| Name | Type | Description |
|---|---|---|
| api-version |
String |
The current API version number. |
Response Output Example
{
"distributionId": "string",
"distributionName": "string",
"packageId": "string",
"revision": 0,
"platform": "string",
"priority": 0,
"enabled": true,
"type": "UserDefined",
"created": "2024-08-27T11:54:31.659Z",
"createdById": "string",
"createdByName": "string",
"lastModified": "2024-08-27T11:54:31.659Z",
"lastModifiedById": "string",
"lastModifiedByName": "string",
"installOptions_AppConfigurationId": "string",
"installOptions_AppConfigurationName": "string",
"scheduledTime": "string",
"scheduledTimeIsUtc": true,
"targets": {
"devices": [
{
"agentId": "string",
"discoveryId": "string",
"displayName": "string",
"domain": "string",
"platform": "string",
"os": "string",
"deviceType": "string",
"addedDate": "2024-08-27T11:54:31.659Z",
"addedUser": "string",
"addedUserId": "string",
"addedUserName": "string"
}
],
"deviceGroups": [
{
"groupId": "string",
"displayName": "string",
"addedDate": "2024-08-27T11:54:31.659Z",
"addedUser": "string",
"addedUserId": "string",
"addedUserName": "string"
}
],
"ldapGroups": [
{
"groupName": "string",
"groupDomain": "string",
"distinguishedName": "string",
"ldapGroupType": "UserGroup",
"groupSourceType": "Inventory",
"addedDate": "2024-08-27T11:54:31.659Z",
"addedUser": "string",
"addedUserId": "string",
"addedUserName": "string"
}
]
}
}PUT Method
Request URI
Enter the specific landscape (only used by RapidApi) to edit the requests.
Example request uri: rapidapi.com
PUT /distribution/external/{distributionId}
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. |
Request Body Parameters
| Name | Type | Description |
|---|---|---|
| distributionId |
String |
Use this to call the distribution ID. |
| api-version |
String |
The current API version number. |
Example Response
{
"distributionId": "string",
"distributionName": "string",
"packageId": "string",
"revision": 0,
"platform": "string",
"priority": 0,
"enabled": true,
"type": "UserDefined",
"created": "2024-08-28T05:46:41.481Z",
"createdById": "string",
"createdByName": "string",
"lastModified": "2024-08-28T05:46:41.481Z",
"lastModifiedById": "string",
"lastModifiedByName": "string",
"installOptions_AppConfigurationId": "string",
"installOptions_AppConfigurationName": "string",
"scheduledTime": "string",
"scheduledTimeIsUtc": true,
"targets": {
"devices": [
{
"agentId": "string",
"discoveryId": "string",
"displayName": "string",
"domain": "string",
"platform": "string",
"os": "string",
"deviceType": "string",
"addedDate": "2024-08-28T05:46:41.481Z",
"addedUser": "string",
"addedUserId": "string",
"addedUserName": "string"
}
],
"deviceGroups": [
{
"groupId": "string",
"displayName": "string",
"addedDate": "2024-08-28T05:46:41.481Z",
"addedUser": "string",
"addedUserId": "string",
"addedUserName": "string"
}
],
"ldapGroups": [
{
"groupName": "string",
"groupDomain": "string",
"distinguishedName": "string",
"ldapGroupType": "UserGroup",
"groupSourceType": "Inventory",
"addedDate": "2024-08-28T05:46:41.481Z",
"addedUser": "string",
"addedUserId": "string",
"addedUserName": "string"
}
]
}
}
GET Method
Request URI
Enter the specific landscape (only used by RapidApi) to get the requests.
Example request uri: rapidapi.com
GET /distribution/external/{packageId}
Calls all the distributions of an app.
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. |
Request Body Parameters
| Name | Type | Description |
|---|---|---|
|
packageId |
String |
Use it to call the Package ID details. |
|
api-version |
String |
The current API version number. |