--- updatedAt: 2026-06-15T13:51:20.000Z agentTools: siteIndex: https://developer.jamf.com/llms.txt projectIndex: https://developer.jamf.com/jamf-pro/llms.txt --- # Retrieve Managed Software Update Plans for a Group Retrieves Managed Software Update Plans for a Group > 📋 **Required privileges:** > - Read Managed Software Updates > - Read Computers > - Read Smart Computer Groups > - Read Static Computer Groups > - Read Mobile Devices > - Read Smart Mobile Device Groups > - Read Static Mobile Device Groups # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Jamf Pro API", "termsOfService": "https://www.jamf.com/developer-resources/api-license-agreement", "version": "11.33.0" }, "servers": [ { "url": "https://yourServer.jamfcloud.com/api" } ], "x-readme": { "samples-languages": [ "curl", "swift", "ruby", "python" ], "explorer-enabled": false }, "security": [ { "Bearer": [] }, { "ApiClient": [] }, { "BasicAuth": [ "/v1/auth/token" ] } ], "paths": { "/v1/managed-software-updates/plans/group/{id}": { "get": { "tags": [ "managed-software-updates" ], "summary": "Retrieve Managed Software Update Plans for a Group", "description": "Retrieves Managed Software Update Plans for a Group\n\n\n> 📋 **Required privileges:**\n> - Read Managed Software Updates\n> - Read Computers\n> - Read Smart Computer Groups\n> - Read Static Computer Groups\n> - Read Mobile Devices\n> - Read Smart Mobile Device Groups\n> - Read Static Mobile Device Groups", "parameters": [ { "name": "id", "in": "path", "description": "Managed Software Update Group Id", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "group-type", "in": "query", "description": "Managed Software Update Group Type, Available options are \"COMPUTER_GROUP\" or \"MOBILE_DEVICE_GROUP\"", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "enum": [ "COMPUTER_GROUP", "MOBILE_DEVICE_GROUP" ] }, "example": "COMPUTER_GROUP" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSoftwareUpdatePlans" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Group with that id does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-privileges": [ "Read Managed Software Updates", "Read Computers", "Read Smart Computer Groups", "Read Static Computer Groups", "Read Mobile Devices", "Read Smart Mobile Device Groups", "Read Static Mobile Device Groups" ] } } }, "components": { "schemas": { "ApiError": { "type": "object", "properties": { "httpStatus": { "type": "integer", "description": "HTTP status of the response", "example": 400 }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorCause" } } } }, "ApiErrorCause": { "required": [ "field" ], "type": "object", "properties": { "code": { "type": "string", "description": "Error-specific code that can be used to identify localization string, etc.", "example": "8675309" }, "field": { "type": "string", "description": "Name of the field that caused the error.", "example": "Name" }, "description": { "type": "string", "description": "A general description of error for troubleshooting/debugging. Generally this text should not be displayed to a user; instead refer to errorCode and it's localized text", "example": "I've just picked up a fault in the AE35 unit. It's going to go 100% failure in 72 hours" }, "id": { "type": "string", "description": "id of object with error. Optional.", "nullable": true, "example": "3" } } }, "ManagedSoftwareUpdatePlan": { "required": [ "device", "maxDeferrals", "planUuid", "status", "updateAction", "versionType" ], "type": "object", "properties": { "planUuid": { "minLength": 1, "type": "string", "readOnly": true, "example": "6E47EF55-5318-494F-A09E-70F613E0AFD1" }, "device": { "$ref": "#/components/schemas/PlanDevice" }, "updateAction": { "type": "string", "nullable": false, "readOnly": true, "example": "DOWNLOAD_INSTALL", "enum": [ "DOWNLOAD_ONLY", "DOWNLOAD_INSTALL", "DOWNLOAD_INSTALL_ALLOW_DEFERRAL", "DOWNLOAD_INSTALL_RESTART", "DOWNLOAD_INSTALL_SCHEDULE", "UNKNOWN" ] }, "versionType": { "type": "string", "nullable": false, "readOnly": true, "example": "SPECIFIC_VERSION", "enum": [ "LATEST_MAJOR", "LATEST_MINOR", "LATEST_ANY", "SPECIFIC_VERSION", "CUSTOM_VERSION", "UNKNOWN" ] }, "specificVersion": { "type": "string", "description": "Optional. Indicates the specific version to update to. Only available when the version type is set to specific version or custom version, otherwise defaults to NO_SPECIFIC_VERSION.", "readOnly": true, "example": "12.6.1", "default": "NO_SPECIFIC_VERSION" }, "buildVersion": { "type": "string", "description": "Optional. Indicates the build version to update to. Only available when the version type is set to custom version.", "nullable": true, "readOnly": true, "example": "21F79" }, "maxDeferrals": { "minimum": 0, "type": "integer", "description": "Not applicable to all managed software update plans", "readOnly": true, "example": 5 }, "forceInstallLocalDateTime": { "type": "string", "description": "Optional. Indicates the local date and time of the device to force update by.", "nullable": true, "example": "2023-12-25T21:09:31" }, "recipeId": { "type": "string", "description": "The id of the recipe that was used to generate the plan.", "readOnly": true, "example": "1", "default": "-1" }, "status": { "$ref": "#/components/schemas/PlanStatus" } } }, "ManagedSoftwareUpdatePlans": { "type": "object", "properties": { "totalCount": { "minimum": 0, "type": "integer", "example": 1 }, "results": { "minItems": 0, "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/ManagedSoftwareUpdatePlan" } } } }, "PlanDevice": { "type": "object", "properties": { "deviceId": { "minLength": 1, "type": "string", "readOnly": true, "example": "1" }, "objectType": { "type": "string", "nullable": false, "readOnly": true, "example": "COMPUTER", "enum": [ "COMPUTER", "MOBILE_DEVICE", "APPLE_TV" ] }, "href": { "type": "string", "nullable": false, "readOnly": true, "example": "/v1/computers-inventory/1" } } }, "PlanStatus": { "type": "object", "properties": { "state": { "type": "string", "nullable": false, "readOnly": true, "example": "SchedulingScanForOSUpdates", "enum": [ "Init", "PendingPlanValidation", "AcceptingPlan", "RejectingPlan", "ProcessingPlanType", "ProcessingPlanTypeMdm", "StartingPlan", "PlanFailed", "SchedulingScanForOSUpdates", "ProcessingScheduleOSUpdateScanResponse", "WaitingForScheduledOSUpdateScanToComplete", "CollectingAvailableOSUpdates", "ProcessingAvailableOSUpdatesResponse", "ProcessingSchedulingType", "SchedulingDDM", "DDMPlanScheduled", "WaitingToStartDDMUpdate", "ProcessingDDMStatusResponse", "CollectingDDMStatus", "SchedulingMDM", "MDMPlanScheduled", "SchedulingOSUpdate", "ProcessingScheduleOSUpdateResponse", "CollectingOSUpdateStatus", "ProcessingOSUpdateStatusResponse", "WaitingToCollectOSUpdateStatus", "VerifyingInstallation", "ProcessingInstallationVerification", "PlanCompleted", "PlanCanceled", "PlanException", "Unknown" ] }, "errorReasons": { "type": "array", "nullable": true, "readOnly": true, "example": [ "NO_UPDATES_AVAILABLE", "NOT_SUPERVISED" ], "items": { "type": "string", "enum": [ "APPLE_SILICON_NO_ESCROW_KEY", "NOT_SUPERVISED", "NOT_MANAGED", "NO_DISK_SPACE", "NO_UPDATES_AVAILABLE", "SPECIFIC_VERSION_UNAVAILABLE", "SPECIFIC_VERSION_UNAVAILABLE_FOR_DEVICE_MODEL", "ACTION_NOT_SUPPORTED_FOR_DEVICE_TYPE", "DECLARATIVE_DEVICE_MANAGEMENT_SOFTWARE_UPDATES_NOT_SUPPORTED_FOR_DEVICE_OS_VERSION", "DECLARATIVE_DEVICE_MANAGEMENT_SOFTWARE_UPDATES_NOT_SUPPORTED_FOR_DEVICE_TYPE", "PLAN_NOT_FOUND", "APPLE_SOFTWARE_LOOKUP_SERVICE_ERROR", "EXISTING_PLAN_FOR_DEVICE_IN_PROGRESS", "DOWNGRADE_NOT_SUPPORTED", "DECLARATIVE_SERVICE_ERROR", "UNABLE_TO_FIND_UPDATES_AND_OUT_OF_RETRIES", "DATA_INTEGRITY_VIOLATION_EXCEPTION", "ILLEGAL_ARGUMENT_EXCEPTION", "MDM_EXCEPTION", "INSTALL_REASON_UNKNOWN", "ACCEPT_PLAN_FAILURE", "SCHEDULE_PLAN_FAILURE", "REJECT_PLAN_FAILURE", "START_PLAN_FAILURE", "QUEUE_SCHEDULED_OS_UPDATE_SCAN_FAILURE", "SCAN_WAIT_FINISHED_FAILURE", "QUEUE_AVAILABLE_OS_UPDATE_COMMAND_FAILURE", "MDM_CLIENT_EXCEPTION", "QUEUE_SCHEDULE_OS_UPDATE_FAILURE", "QUEUE_OS_UPDATE_STATUS_COMMAND_FAILURE", "STILL_IN_PROGRESS_FAILURE", "WAIT_TO_COLLECT_OS_UPDATE_STATUS_FAILURE", "IS_DOWNLOADED_AND_NEEDS_INSTALL_FAILURE", "IS_INSTALLED_FAILURE", "IS_DOWNLOAD_ONLY_AND_DOWNLOADED_FAILURE", "VERIFY_INSTALLATION_FAILURE", "IS_MAC_OS_UPDATE_FAILURE", "IS_LATEST_FAILURE", "IS_SPECIFIC_VERSION_FAILURE", "HANDLE_COMMAND_QUEUE_FAILURE", "INVALID_CONFIGURATION_DECLARATION", "DECLARATIVE_DEVICE_MANAGEMENT_STATUS_RESPONSE_FAILURE_REASON_RECEIVED", "NO_DEVICE_STATUS_BY_GRACE_PERIOD", "UNKNOWN" ] } } } } }, "securitySchemes": { "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" }, "BasicAuth": { "type": "http", "description": "Basic auth is used only for obtaining bearer tokens from the /v1/auth/token endpoint", "scheme": "basic" }, "ApiClient": { "type": "oauth2", "description": "Jamf Pro API Roles and Clients provide a client ID and secret for obtaining access tokens using the OAuth2 client_credentials grant type", "flows": { "clientCredentials": { "tokenUrl": "/api/v1/oauth/token", "scopes": {} } } } } } } ```