--- updatedAt: 2026-06-15T13:51:20.000Z agentTools: siteIndex: https://developer.jamf.com/llms.txt projectIndex: https://developer.jamf.com/jamf-pro/llms.txt --- # Return paginated Computer Inventory records Return paginated Computer Inventory records > 📋 **Required privilege:** Read Computers # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Jamf Pro API", "termsOfService": "https://www.jamf.com/developer-resources/api-license-agreement", "version": "11.32.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": { "/v2/computers-inventory": { "get": { "tags": [ "computer-inventory" ], "summary": "Return paginated Computer Inventory records", "description": "Return paginated Computer Inventory records\n\n> 📋 **Required privilege:** Read Computers", "parameters": [ { "name": "section", "in": "query", "description": "section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&section=HARDWARE", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "example": [ "GENERAL" ], "items": { "$ref": "#/components/schemas/ComputerSectionV2" }, "default": [ "GENERAL" ] } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/page-size" }, { "name": "sort", "in": "query", "description": "Sorting criteria in the format: `property:asc/desc`. Default sort\nis `general.name:asc`. Multiple sort criteria are supported and must be separated with\na comma.\n\nFields allowed in the sort: `general.name`, `udid`, `id`, `general.assetTag`,\n`general.jamfBinaryVersion`, `general.lastContactTime`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`,\n`general.reportDate`,\n`general.mdmCertificateExpiration`, `general.platform`, `general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`,\n`general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`,\n`general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`,\n`hardware.make`, `hardware.model`,\n`operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`,\n`userAndLocation.realname`,\n`purchasing.lifeExpectancy`, `purchasing.warrantyDate`\n\nExample: `sort=udid:desc,general.name:asc`.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" }, "default": [ "general.name:asc" ] } }, { "name": "filter", "in": "query", "description": "Query in the RSQL format, allowing to filter computer inventory collection.\nDefault filter is empty query - returning all results for the requested page.\n\nFields allowed in the query: `general.name`, `udid`, `id`, `general.assetTag`, `general.barcode1`, `general.barcode2`,\n`general.enrolledViaAutomatedDeviceEnrollment`, `general.lastIpAddress`, `general.itunesStoreAccountActive`,\n`general.jamfBinaryVersion`, `general.lastContactTime`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`,\n`general.reportDate`, `general.lastReportedIp`, `general.lastReportedIpV4`, `general.lastReportedIpV6`, `general.managementId`, `general.remoteManagement.managed`,\n`general.mdmCapable.capable`, `general.mdmCertificateExpiration`, `general.platform`, `general.supervised`, `general.userApprovedMdm`, `general.declarativeDeviceManagementEnabled`, \n`general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`,\n`general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`,\n`general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`,\n`hardware.bleCapable`, `hardware.macAddress`, `hardware.make`, `hardware.model`, `hardware.modelIdentifier`, `hardware.serialNumber`,\n`hardware.supportsIosAppInstalls`,`hardware.appleSilicon`, `operatingSystem.activeDirectoryStatus`, `operatingSystem.fileVault2Status`,\n`operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`, `security.activationLockEnabled`,\n`security.recoveryLockEnabled`,`security.firewallEnabled`,`userAndLocation.buildingId`, `userAndLocation.departmentId`, `userAndLocation.email`, `userAndLocation.realname`,\n`userAndLocation.phone`, `userAndLocation.position`,`userAndLocation.room`, `userAndLocation.username`, `diskEncryption.fileVault2Enabled`,\n`purchasing.appleCareId`, `purchasing.lifeExpectancy`, `purchasing.purchased`, `purchasing.leased`, `purchasing.vendor`, `purchasing.warrantyDate`,\n\nThis param can be combined with paging and sorting.\nExample: `filter=general.name==\"Orchard\"`\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputerInventorySearchResultsV2" } } } } }, "deprecated": true, "x-deprecation-date": "2025-11-06", "x-required-privileges": [ "Read Computers" ] } } }, "components": { "schemas": { "ComputerApplication": { "type": "object", "properties": { "name": { "type": "string", "example": "Microsoft Word" }, "path": { "type": "string", "example": "/usr/local/app" }, "version": { "type": "string", "example": "1.0.0" }, "macAppStore": { "type": "boolean", "example": true }, "sizeMegabytes": { "type": "integer", "example": 25 }, "bundleId": { "type": "string", "example": "1" }, "updateAvailable": { "type": "boolean", "example": false }, "externalVersionId": { "type": "string", "description": "The app's external version ID. It can be used in the iTunes Search API to decide if the app needs to be updated", "example": "1" } } }, "ComputerAttachment": { "type": "object", "properties": { "id": { "type": "string", "example": "1" }, "name": { "type": "string", "example": "Attachment.pdf" }, "fileType": { "type": "string", "example": "application/pdf" }, "sizeBytes": { "type": "integer", "description": "File size in bytes", "format": "int64", "example": 1024 } } }, "ComputerCertificate": { "type": "object", "properties": { "commonName": { "type": "string", "example": "jamf.com" }, "identity": { "type": "boolean", "example": true }, "expirationDate": { "type": "string", "format": "date-time", "example": "2030-10-31T18:04:13Z" }, "username": { "type": "string", "example": "test" }, "lifecycleStatus": { "type": "string", "example": "ACTIVE", "enum": [ "ACTIVE", "INACTIVE" ] }, "certificateStatus": { "type": "string", "example": "ISSUED", "enum": [ "EXPIRING", "EXPIRED", "REVOKED", "PENDING_REVOKE", "ISSUED" ] }, "subjectName": { "type": "string", "example": "CN=jamf.com" }, "serialNumber": { "type": "string", "example": "40f3d9fb" }, "sha1Fingerprint": { "type": "string", "example": "ed361458724d06082b2314acdb82e1f586f085f5" }, "issuedDate": { "type": "string", "example": "2022-05-23T14:54:10Z" } } }, "ComputerConfigurationProfile": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "example": "1" }, "username": { "type": "string", "readOnly": true, "example": "username" }, "lastInstalled": { "type": "string", "format": "date-time", "example": "2018-10-31T18:04:13Z" }, "removable": { "type": "boolean", "readOnly": true, "example": true }, "displayName": { "type": "string", "readOnly": true, "example": "Displayed profile" }, "profileIdentifier": { "type": "string", "readOnly": true, "example": "0ae590fe-9b30-11ea-bb37-0242ac130002" }, "uuid": { "type": "string", "nullable": true, "readOnly": true, "example": "0ae590fe-9b30-11ea-bb37-0242ac130002" } } }, "ComputerContentCaching": { "type": "object", "properties": { "computerContentCachingInformationId": { "type": "string", "readOnly": true, "example": "1" }, "parents": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/ComputerContentCachingParent" } }, "alerts": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/ComputerContentCachingAlert" } }, "activated": { "type": "boolean", "readOnly": true, "example": false }, "active": { "type": "boolean", "readOnly": true, "example": false }, "actualCacheBytesUsed": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "cacheDetails": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/ComputerContentCachingCacheDetail" } }, "cacheBytesFree": { "type": "integer", "format": "int64", "readOnly": true, "example": 23353884672 }, "cacheBytesLimit": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "cacheStatus": { "type": "string", "readOnly": true, "example": "OK" }, "cacheBytesUsed": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "dataMigrationCompleted": { "type": "boolean", "readOnly": true, "example": false }, "dataMigrationProgressPercentage": { "type": "integer", "readOnly": true, "example": 0 }, "dataMigrationError": { "$ref": "#/components/schemas/ComputerContentCachingDataMigrationError" }, "maxCachePressureLast1HourPercentage": { "type": "integer", "readOnly": true, "example": 0 }, "personalCacheBytesFree": { "type": "integer", "format": "int64", "readOnly": true, "example": 23353884672 }, "personalCacheBytesLimit": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "personalCacheBytesUsed": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "port": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "publicAddress": { "type": "string", "readOnly": true, "example": "SomeAddress" }, "registrationError": { "type": "string", "readOnly": true, "example": "NOT_ACTIVATED" }, "registrationResponseCode": { "type": "integer", "format": "int64", "readOnly": true, "example": 403 }, "registrationStarted": { "type": "string", "format": "date-time", "readOnly": true, "example": "2018-10-31T18:04:13Z" }, "registrationStatus": { "type": "string", "readOnly": true, "example": "CONTENT_CACHING_FAILED", "enum": [ "CONTENT_CACHING_FAILED", "CONTENT_CACHING_PENDING", "CONTENT_CACHING_SUCCEEDED" ] }, "restrictedMedia": { "type": "boolean", "readOnly": true, "example": false }, "serverGuid": { "type": "string", "readOnly": true, "example": "CD1E1291-4AF9-4468-B5D5-0F780C13DB2F" }, "startupStatus": { "type": "string", "readOnly": true, "example": "FAILED" }, "tetheratorStatus": { "type": "string", "readOnly": true, "example": "CONTENT_CACHING_DISABLED", "enum": [ "CONTENT_CACHING_UNKNOWN", "CONTENT_CACHING_DISABLED", "CONTENT_CACHING_ENABLED" ] }, "totalBytesAreSince": { "type": "string", "format": "date-time", "readOnly": true, "example": "2018-10-31T18:04:13Z" }, "totalBytesDropped": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "totalBytesImported": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "totalBytesReturnedToChildren": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "totalBytesReturnedToClients": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "totalBytesReturnedToPeers": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "totalBytesStoredFromOrigin": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "totalBytesStoredFromParents": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "totalBytesStoredFromPeers": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 } } }, "ComputerContentCachingAlert": { "type": "object", "properties": { "cacheBytesLimit": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "className": { "type": "string", "readOnly": true, "example": "SomeClass" }, "pathPreventingAccess": { "type": "string", "readOnly": true, "example": "/some/path" }, "postDate": { "type": "string", "format": "date-time", "readOnly": true, "example": "2018-10-31T18:04:13Z" }, "reservedVolumeBytes": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "resource": { "type": "string", "readOnly": true, "example": "SomeResource" } } }, "ComputerContentCachingCacheDetail": { "type": "object", "properties": { "computerContentCachingCacheDetailsId": { "type": "string", "readOnly": true, "example": "1" }, "categoryName": { "type": "string", "readOnly": true, "example": "SomeCategory" }, "diskSpaceBytesUsed": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 } } }, "ComputerContentCachingDataMigrationError": { "type": "object", "properties": { "code": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "domain": { "type": "string", "readOnly": true, "example": "SomeDomain" }, "userInfo": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/ComputerContentCachingDataMigrationErrorUserInfo" } } } }, "ComputerContentCachingDataMigrationErrorUserInfo": { "type": "object", "properties": { "key": { "type": "string", "readOnly": true, "example": "foo" }, "value": { "type": "string", "readOnly": true, "example": "bar" } } }, "ComputerContentCachingParent": { "type": "object", "properties": { "contentCachingParentId": { "type": "string", "readOnly": true, "example": "1" }, "address": { "type": "string", "readOnly": true, "example": "SomeAddress" }, "alerts": { "$ref": "#/components/schemas/ComputerContentCachingParentAlert" }, "details": { "$ref": "#/components/schemas/ComputerContentCachingParentDetails" }, "guid": { "type": "string", "readOnly": true, "example": "CD1E1291-4AF9-4468-B5D5-0F780C13DB2F" }, "healthy": { "type": "boolean", "readOnly": true, "example": true }, "port": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "version": { "type": "string", "readOnly": true, "example": "1" } } }, "ComputerContentCachingParentAlert": { "type": "object", "properties": { "contentCachingParentAlertId": { "type": "string", "readOnly": true, "example": "1" }, "addresses": { "type": "array", "readOnly": true, "example": [], "items": { "type": "string" } }, "className": { "type": "string", "readOnly": true, "example": "SomeClass" }, "postDate": { "type": "string", "format": "date-time", "readOnly": true, "example": "2018-10-31T18:04:13Z" } } }, "ComputerContentCachingParentCapabilities": { "type": "object", "properties": { "contentCachingParentCapabilitiesId": { "type": "string", "readOnly": true, "example": "1" }, "imports": { "type": "boolean", "readOnly": true, "example": true }, "namespaces": { "type": "boolean", "readOnly": true, "example": true }, "personalContent": { "type": "boolean", "readOnly": true, "example": true }, "queryParameters": { "type": "boolean", "readOnly": true, "example": true }, "sharedContent": { "type": "boolean", "readOnly": true, "example": true }, "prioritization": { "type": "boolean", "readOnly": true, "example": true } } }, "ComputerContentCachingParentDetails": { "type": "object", "properties": { "contentCachingParentDetailsId": { "type": "string", "readOnly": true, "example": "1" }, "acPower": { "type": "boolean", "readOnly": true, "example": true }, "cacheSizeBytes": { "type": "integer", "format": "int64", "readOnly": true, "example": 0 }, "capabilities": { "$ref": "#/components/schemas/ComputerContentCachingParentCapabilities" }, "portable": { "type": "boolean", "readOnly": true, "example": true }, "localNetwork": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerContentCachingParentLocalNetwork" } } } }, "ComputerContentCachingParentLocalNetwork": { "type": "object", "properties": { "contentCachingParentLocalNetworkId": { "type": "string", "readOnly": true, "example": "1" }, "speed": { "type": "integer", "format": "int64", "readOnly": true, "example": 5000 }, "wired": { "type": "boolean", "readOnly": true, "example": true } } }, "ComputerDisk": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "example": "170" }, "device": { "type": "string", "readOnly": true, "example": "disk0" }, "model": { "type": "string", "readOnly": true, "example": "APPLE HDD TOSHIBA MK5065GSXF" }, "revision": { "type": "string", "readOnly": true, "example": "5" }, "serialNumber": { "type": "string", "readOnly": true, "example": "a8598f013366" }, "sizeMegabytes": { "type": "integer", "description": "Disk Size in MB.", "format": "int64", "readOnly": true, "example": 262144 }, "smartStatus": { "type": "string", "description": "S.M.A.R.T Status", "readOnly": true, "example": "OK" }, "type": { "type": "string", "description": "Connection type attribute.", "readOnly": true, "example": "false" }, "partitions": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerPartition" } } } }, "ComputerDiskEncryption": { "type": "object", "properties": { "bootPartitionEncryptionDetails": { "$ref": "#/components/schemas/ComputerPartitionEncryption" }, "individualRecoveryKeyValidityStatus": { "type": "string", "example": "VALID", "enum": [ "VALID", "INVALID", "UNKNOWN", "NOT_APPLICABLE" ] }, "institutionalRecoveryKeyPresent": { "type": "boolean", "example": true }, "diskEncryptionConfigurationName": { "type": "string", "example": "Test configuration" }, "fileVault2Enabled": { "type": "boolean", "readOnly": true, "example": true }, "fileVault2EnabledUserNames": { "type": "array", "example": [ "admin" ], "items": { "type": "string" } }, "fileVault2EligibilityMessage": { "type": "string", "example": "Not a boot partition" } } }, "ComputerExtensionAttribute": { "type": "object", "properties": { "definitionId": { "type": "string", "description": "An identifier of extension attribute definition.", "nullable": false, "example": "23" }, "name": { "type": "string", "description": "A human-readable name by which attribute can be referred to.", "nullable": false, "readOnly": true, "example": "Some Attribute" }, "description": { "type": "string", "description": "An additional explanation of exact attribute meaning, possible values, etc.", "nullable": true, "readOnly": true, "example": "Some Attribute defines how much Foo impacts Bar." }, "enabled": { "type": "boolean", "nullable": false, "readOnly": true, "example": true }, "multiValue": { "type": "boolean", "nullable": false, "readOnly": true, "example": true }, "values": { "type": "array", "description": "A value of extension attribute, in some rare cases there may be multiple values present, hence the array.\n", "nullable": true, "readOnly": false, "example": [ "foo", "bar" ], "items": { "type": "string" } }, "dataType": { "type": "string", "description": "A data type of extension attribute.", "nullable": true, "readOnly": true, "example": "STRING", "enum": [ "STRING", "INTEGER", "DATE_TIME" ] }, "options": { "type": "array", "description": "A closed list of possible values (applies to `popup` input type).\n", "nullable": true, "readOnly": true, "example": [ "foo", "bar" ], "items": { "type": "string" } }, "inputType": { "type": "string", "description": "The input method. `text` is most common and means simply free text, `popup` i a closed list of values from\nwhich one or many can be selected and `script` value is calculated and can never be set directly.\n", "nullable": true, "readOnly": true, "example": "TEXT", "enum": [ "TEXT", "POPUP", "SCRIPT", "LDAP" ] } } }, "ComputerGeneral": { "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "example": "Boalime" }, "lastIpAddress": { "type": "string", "example": "247.185.82.186" }, "lastReportedIp": { "type": "string", "description": "Last reported IPv4 address (Deprecated. Use lastReportedIpV4 instead.)", "example": "247.185.82.186", "deprecated": true }, "lastReportedIpV4": { "type": "string", "description": "Last reported IPv4 address", "example": "247.185.82.186" }, "lastReportedIpV6": { "type": "string", "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7335" }, "jamfBinaryVersion": { "type": "string", "example": "9.27" }, "platform": { "type": "string", "example": "Mac" }, "barcode1": { "type": "string", "example": "5 12345 678900" }, "barcode2": { "type": "string", "example": "5 12345 678900" }, "assetTag": { "type": "string", "example": "304822" }, "remoteManagement": { "$ref": "#/components/schemas/ComputerRemoteManagement" }, "supervised": { "type": "boolean", "example": true }, "mdmCapable": { "$ref": "#/components/schemas/ComputerMdmCapability" }, "reportDate": { "type": "string", "format": "date-time", "example": "2018-10-31T18:04:13Z" }, "lastContactTime": { "type": "string", "format": "date-time", "example": "2018-10-31T18:04:13Z" }, "lastCloudBackupDate": { "type": "string", "format": "date-time", "example": "2018-10-31T18:04:13Z" }, "lastEnrolledDate": { "type": "string", "format": "date-time", "example": "2018-10-31T18:04:13Z" }, "mdmProfileExpiration": { "type": "string", "format": "date-time", "example": "2018-10-31T18:04:13Z" }, "initialEntryDate": { "type": "string", "format": "date", "example": "2018-10-31" }, "distributionPoint": { "type": "string", "example": "distribution point name" }, "enrollmentMethod": { "$ref": "#/components/schemas/EnrollmentMethod" }, "site": { "$ref": "#/components/schemas/ComputerSite" }, "itunesStoreAccountActive": { "type": "boolean", "example": true }, "enrolledViaAutomatedDeviceEnrollment": { "type": "boolean", "example": true }, "userApprovedMdm": { "type": "boolean", "example": true }, "declarativeDeviceManagementEnabled": { "type": "boolean", "example": true }, "appleEnrollmentType": { "type": "string", "description": "The enrollment type reported by Apple.", "example": "supervised", "enum": [ "none", "supervised", "device", "user", "unknown" ] }, "awaitingConfiguration": { "type": "boolean", "description": "Whether the device is awaiting configuration.", "example": false }, "extensionAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerExtensionAttribute" } }, "managementId": { "type": "string", "readOnly": true, "example": "73226fb6-61df-4c10-9552-eb9bc353d507" }, "lastLoggedInUsernameSelfService": { "type": "string", "nullable": true, "example": "admin" }, "lastLoggedInUsernameSelfServiceTimestamp": { "type": "string", "format": "date-time", "nullable": true, "example": "2018-10-31T18:04:13Z" }, "lastLoggedInUsernameBinary": { "type": "string", "nullable": true, "example": "admin" }, "lastLoggedInUsernameBinaryTimestamp": { "type": "string", "format": "date-time", "nullable": true, "example": "2018-10-31T18:04:13Z" }, "lastLoggedInUsernameMdm": { "type": "string", "nullable": true, "example": "admin" }, "lastLoggedInUsernameMdmTimestamp": { "type": "string", "format": "date-time", "nullable": true, "example": "2018-10-31T18:04:13Z" } } }, "ComputerHardware": { "type": "object", "properties": { "make": { "type": "string", "readOnly": true, "example": "Apple" }, "model": { "type": "string", "readOnly": true, "example": "13-inch MacBook Pro (Mid 2012)" }, "modelIdentifier": { "type": "string", "readOnly": true, "example": "MacBookPro9,2" }, "serialNumber": { "type": "string", "readOnly": true, "example": "C02ZC2QYLVDL" }, "processorSpeedMhz": { "type": "integer", "description": "Processor Speed in MHz.", "format": "int64", "readOnly": true, "example": 2100 }, "processorCount": { "type": "integer", "readOnly": true, "example": 2 }, "coreCount": { "type": "integer", "readOnly": true, "example": 2 }, "processorType": { "type": "string", "readOnly": true, "example": "Intel Core i5" }, "processorArchitecture": { "type": "string", "readOnly": true, "example": "i386" }, "busSpeedMhz": { "type": "integer", "format": "int64", "readOnly": true, "example": 2133 }, "cacheSizeKilobytes": { "type": "integer", "description": "Cache Size in KB.", "format": "int64", "readOnly": true, "example": 3072 }, "networkAdapterType": { "type": "string", "example": "Foo" }, "macAddress": { "type": "string", "example": "6A:2C:4B:B7:65:B5" }, "altNetworkAdapterType": { "type": "string", "example": "Bar" }, "altMacAddress": { "type": "string", "example": "82:45:58:44:dc:01" }, "totalRamMegabytes": { "type": "integer", "description": "Total RAM Size in MB.", "format": "int64", "readOnly": true, "example": 4096 }, "openRamSlots": { "type": "integer", "description": "Available RAM slots.", "readOnly": true, "example": 0 }, "batteryCapacityPercent": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Remaining percentage of battery power.", "readOnly": true, "example": 85 }, "batteryHealth": { "type": "string", "description": "- NON_GENUINE: The battery isn’t a genuine Apple battery.\n- NORMAL: The battery is operating normally.\n- SERVICE_RECOMMENDED: The system recommends battery service.\n- UNKNOWN: The system couldn’t determine battery health information.\n- UNSUPPORTED: The device doesn’t support battery health reporting.\n", "readOnly": true, "enum": [ "NON_GENUINE", "NORMAL", "SERVICE_RECOMMENDED", "UNKNOWN", "UNSUPPORTED" ], "default": "UNKNOWN" }, "smcVersion": { "type": "string", "readOnly": true, "example": "2.2f38" }, "nicSpeed": { "type": "string", "readOnly": true, "example": "N/A" }, "opticalDrive": { "type": "string", "readOnly": true, "example": "MATSHITA DVD-R UJ-8A8" }, "bootRom": { "type": "string", "readOnly": true, "example": "MBP91.00D3.B08" }, "bleCapable": { "type": "boolean", "readOnly": true, "example": false }, "supportsIosAppInstalls": { "type": "boolean", "readOnly": true, "example": false }, "appleSilicon": { "type": "boolean", "readOnly": true, "example": false }, "provisioningUdid": { "type": "string", "readOnly": true, "example": "00000AAA888-IH866799UUJD991" }, "extensionAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerExtensionAttribute" } } } }, "ComputerIbeacon": { "type": "object", "properties": { "name": { "type": "string", "example": "room A" } } }, "ComputerInventorySearchResultsV2": { "type": "object", "properties": { "totalCount": { "minimum": 0, "type": "integer", "example": 3 }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerInventoryV2" } } } }, "ComputerInventoryV2": { "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "readOnly": true, "example": "1" }, "udid": { "type": "string", "example": "123" }, "general": { "$ref": "#/components/schemas/ComputerGeneral" }, "diskEncryption": { "$ref": "#/components/schemas/ComputerDiskEncryption" }, "purchasing": { "$ref": "#/components/schemas/ComputerPurchase" }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerApplication" } }, "storage": { "$ref": "#/components/schemas/ComputerStorage" }, "userAndLocation": { "$ref": "#/components/schemas/ComputerUserAndLocation" }, "configurationProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerConfigurationProfile" } }, "printers": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerPrinter" } }, "services": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerService" } }, "hardware": { "$ref": "#/components/schemas/ComputerHardware" }, "localUserAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerLocalUserAccount" } }, "certificates": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerCertificate" } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerAttachment" } }, "packageReceipts": { "$ref": "#/components/schemas/ComputerPackageReceipts" }, "security": { "$ref": "#/components/schemas/ComputerSecurity" }, "operatingSystem": { "$ref": "#/components/schemas/ComputerOperatingSystem" }, "licensedSoftware": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerLicensedSoftware" } }, "ibeacons": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerIbeacon" } }, "softwareUpdates": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerSoftwareUpdate" } }, "extensionAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerExtensionAttribute" } }, "contentCaching": { "$ref": "#/components/schemas/ComputerContentCaching" }, "groupMemberships": { "type": "array", "items": { "$ref": "#/components/schemas/GroupMembership" } } } }, "ComputerLicensedSoftware": { "type": "object", "properties": { "id": { "type": "string", "example": "1" }, "name": { "type": "string", "example": "Microsoft Word" } } }, "ComputerLocalUserAccount": { "type": "object", "properties": { "uid": { "type": "string", "example": "501" }, "userGuid": { "type": "string", "readOnly": true, "example": "844F1177-0CF5-40C6-901F-38EDD9969C1C" }, "username": { "type": "string", "example": "jamf" }, "fullName": { "type": "string", "example": "John Jamf" }, "admin": { "type": "boolean", "example": true }, "homeDirectory": { "type": "string", "example": "/Users/jamf" }, "homeDirectorySizeMb": { "type": "integer", "description": "Home directory size in MB.", "format": "int64", "readOnly": true, "example": 131072 }, "fileVault2Enabled": { "type": "boolean", "example": true }, "userAccountType": { "type": "string", "example": "LOCAL", "enum": [ "LOCAL", "MOBILE", "UNKNOWN" ] }, "passwordMinLength": { "type": "integer", "example": 4 }, "passwordMaxAge": { "type": "integer", "example": 5 }, "passwordMinComplexCharacters": { "type": "integer", "example": 5 }, "passwordHistoryDepth": { "type": "integer", "example": 5 }, "passwordRequireAlphanumeric": { "type": "boolean", "example": true }, "computerAzureActiveDirectoryId": { "type": "string", "example": "1" }, "userAzureActiveDirectoryId": { "type": "string", "example": "1" }, "azureActiveDirectoryId": { "type": "string", "example": "ACTIVATED", "enum": [ "ACTIVATED", "DEACTIVATED", "UNRESPONSIVE", "UNKNOWN" ] } } }, "ComputerMdmCapability": { "type": "object", "properties": { "capable": { "type": "boolean", "example": true }, "capableUsers": { "type": "array", "description": "Deprecated. Use userManagementInfo instead.", "example": [ "admin", "rootadmin" ], "deprecated": true, "items": { "type": "string" } }, "userManagementInfo": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerUserManagementInfo" } } } }, "ComputerOperatingSystem": { "type": "object", "properties": { "name": { "type": "string", "readOnly": true, "example": "Mac OS X" }, "version": { "type": "string", "readOnly": true, "example": "10.9.5" }, "build": { "type": "string", "readOnly": true, "example": "13A603" }, "supplementalBuildVersion": { "type": "string", "description": "Collected for macOS 13.0 or later", "readOnly": true, "example": "13A953" }, "rapidSecurityResponse": { "type": "string", "description": "Collected for macOS 13.0 or later", "readOnly": true, "example": "(a)" }, "activeDirectoryStatus": { "type": "string", "readOnly": true, "example": "Not Bound" }, "fileVault2Status": { "type": "string", "example": "ALL_ENCRYPTED", "enum": [ "NOT_APPLICABLE", "NOT_ENCRYPTED", "BOOT_ENCRYPTED", "SOME_ENCRYPTED", "ALL_ENCRYPTED" ] }, "softwareUpdateDeviceId": { "type": "string", "readOnly": true, "example": "J132AP" }, "extensionAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerExtensionAttribute" } } } }, "ComputerPackageReceipts": { "type": "object", "properties": { "installedByJamfPro": { "type": "array", "items": { "type": "string", "example": "com.jamf.protect.JamfProtect" } }, "installedByInstallerSwu": { "type": "array", "items": { "type": "string", "example": "com.apple.pkg.Core" } }, "cached": { "type": "array", "items": { "type": "string", "example": "com.jamf.protect.JamfProtect" } } }, "description": "All package receipts are listed by their package name" }, "ComputerPartition": { "type": "object", "properties": { "name": { "type": "string", "readOnly": true, "example": "Foo" }, "sizeMegabytes": { "type": "integer", "description": "Partition Size in MB.", "format": "int64", "readOnly": true, "example": 262144 }, "availableMegabytes": { "type": "integer", "description": "Available space in MB.", "format": "int64", "readOnly": true, "example": 131072 }, "partitionType": { "type": "string", "readOnly": true, "example": "BOOT", "enum": [ "BOOT", "RECOVERY", "OTHER" ] }, "percentUsed": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Percentage of space used.", "readOnly": true, "example": 25 }, "fileVault2State": { "$ref": "#/components/schemas/ComputerPartitionFileVault2State" }, "fileVault2ProgressPercent": { "type": "integer", "description": "Percentage progress of current FileVault 2 operation.", "nullable": true, "example": 45 }, "lvmManaged": { "type": "boolean", "readOnly": true, "example": true } } }, "ComputerPartitionEncryption": { "type": "object", "properties": { "partitionName": { "type": "string", "example": "main" }, "partitionFileVault2State": { "$ref": "#/components/schemas/ComputerPartitionFileVault2State" }, "partitionFileVault2Percent": { "type": "integer", "example": 100 } } }, "ComputerPartitionFileVault2State": { "type": "string", "example": "ENCRYPTING", "enum": [ "UNKNOWN", "UNENCRYPTED", "INELIGIBLE", "DECRYPTED", "DECRYPTING", "ENCRYPTED", "ENCRYPTING", "RESTART_NEEDED", "OPTIMIZING", "DECRYPTING_PAUSED", "ENCRYPTING_PAUSED" ] }, "ComputerPrinter": { "type": "object", "properties": { "name": { "type": "string", "example": "My Printer" }, "type": { "type": "string", "example": "XYZ 1122" }, "uri": { "type": "string", "example": "ipp://10.0.0.5" }, "location": { "type": "string", "example": "7th floor" } } }, "ComputerPurchase": { "type": "object", "properties": { "leased": { "type": "boolean", "example": true }, "purchased": { "type": "boolean", "example": true }, "poNumber": { "type": "string", "example": "53-1" }, "poDate": { "type": "string", "format": "date", "example": "2019-01-01" }, "vendor": { "type": "string", "example": "Example Vendor" }, "warrantyDate": { "type": "string", "format": "date", "example": "2019-01-01" }, "appleCareId": { "type": "string", "example": "abcd" }, "leaseDate": { "type": "string", "format": "date", "example": "2019-01-01" }, "purchasePrice": { "type": "string", "example": "$500" }, "lifeExpectancy": { "type": "integer", "example": 5 }, "purchasingAccount": { "type": "string", "example": "admin" }, "purchasingContact": { "type": "string", "example": "true" }, "extensionAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerExtensionAttribute" } } } }, "ComputerRemoteManagement": { "type": "object", "properties": { "managed": { "type": "boolean", "example": true }, "managementUsername": { "type": "string", "description": "This field always returns null, please use /local-admin-password/ endpoint instead.", "example": "rootname", "deprecated": true } } }, "ComputerSectionV2": { "type": "string", "example": "general", "enum": [ "GENERAL", "DISK_ENCRYPTION", "PURCHASING", "APPLICATIONS", "STORAGE", "USER_AND_LOCATION", "CONFIGURATION_PROFILES", "PRINTERS", "SERVICES", "HARDWARE", "LOCAL_USER_ACCOUNTS", "CERTIFICATES", "ATTACHMENTS", "PACKAGE_RECEIPTS", "SECURITY", "OPERATING_SYSTEM", "LICENSED_SOFTWARE", "IBEACONS", "SOFTWARE_UPDATES", "EXTENSION_ATTRIBUTES", "CONTENT_CACHING", "GROUP_MEMBERSHIPS" ] }, "ComputerSecurity": { "type": "object", "properties": { "sipStatus": { "type": "string", "example": "ENABLED", "enum": [ "NOT_COLLECTED", "NOT_AVAILABLE", "DISABLED", "ENABLED" ] }, "gatekeeperStatus": { "type": "string", "example": "APP_STORE_AND_IDENTIFIED_DEVELOPERS", "enum": [ "NOT_COLLECTED", "DISABLED", "APP_STORE_AND_IDENTIFIED_DEVELOPERS", "APP_STORE" ] }, "xprotectVersion": { "type": "string", "example": "1.2.3" }, "autoLoginDisabled": { "type": "boolean", "example": false }, "remoteDesktopEnabled": { "type": "boolean", "description": "Collected for macOS 10.14.4 or later", "example": true }, "activationLockEnabled": { "type": "boolean", "description": "Collected for macOS 10.15.0 or later", "example": true }, "recoveryLockEnabled": { "type": "boolean", "example": true }, "firewallEnabled": { "type": "boolean", "example": true }, "secureBootLevel": { "type": "string", "description": "Collected for macOS 10.15.0 or later", "example": "FULL_SECURITY", "enum": [ "NO_SECURITY", "MEDIUM_SECURITY", "FULL_SECURITY", "NOT_SUPPORTED", "UNKNOWN" ] }, "externalBootLevel": { "type": "string", "description": "Collected for macOS 10.15.0 or later", "example": "ALLOW_BOOTING_FROM_EXTERNAL_MEDIA", "enum": [ "ALLOW_BOOTING_FROM_EXTERNAL_MEDIA", "DISALLOW_BOOTING_FROM_EXTERNAL_MEDIA", "NOT_SUPPORTED", "UNKNOWN" ] }, "bootstrapTokenAllowed": { "type": "boolean", "description": "Collected for macOS 11 or later", "example": true }, "bootstrapTokenEscrowedStatus": { "type": "string", "description": "Collected for macOS 11 or later", "example": "ESCROWED", "enum": [ "ESCROWED", "NOT_ESCROWED", "NOT_SUPPORTED" ] }, "lastAttestationAttempt": { "type": "string", "readOnly": true, "example": "1970-01-01T00:00:00Z" }, "lastSuccessfulAttestation": { "type": "string", "readOnly": true, "example": "1970-01-01T00:00:00Z" }, "attestationStatus": { "type": "string", "readOnly": true, "example": "PENDING", "enum": [ "PENDING", "SUCCESS", "CERTIFICATE_INVALID", "DEVICE_PROPERTIES_MISMATCH", "MDA_UNSUPPORTED_DUE_TO_HARDWARE", "MDA_UNSUPPORTED_DUE_TO_SOFTWARE" ] }, "lockdownModeEnabled": { "type": "boolean", "description": "Whether Lockdown Mode is enabled.", "example": false } } }, "ComputerService": { "type": "object", "properties": { "name": { "type": "string", "example": "SomeService" } } }, "ComputerSite": { "type": "object", "properties": { "id": { "type": "string", "nullable": false, "example": "1" }, "name": { "type": "string", "nullable": false, "example": "Eau Claire" } } }, "ComputerSoftwareUpdate": { "type": "object", "properties": { "name": { "type": "string", "example": "BEdit" }, "version": { "type": "string", "example": "1.15.2" }, "packageName": { "type": "string", "example": "com.apple.pkg.AdditionalEssentials" } } }, "ComputerStorage": { "type": "object", "properties": { "bootDriveAvailableSpaceMegabytes": { "type": "integer", "format": "int64", "readOnly": true, "example": 3072 }, "disks": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerDisk" } } } }, "ComputerUserAndLocation": { "type": "object", "properties": { "username": { "type": "string", "example": "Madison Anderson" }, "realname": { "type": "string", "example": "13-inch MacBook" }, "email": { "type": "string", "example": "email@com.pl" }, "position": { "type": "string", "example": "IT Team Lead" }, "phone": { "type": "string", "example": "123-456-789" }, "departmentId": { "type": "string", "example": "1" }, "buildingId": { "type": "string", "example": "1" }, "room": { "type": "string", "example": "5" }, "extensionAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerExtensionAttribute" } } } }, "ComputerUserManagementInfo": { "required": [ "capableUser", "managementId" ], "type": "object", "properties": { "capableUser": { "type": "string", "example": "admin" }, "managementId": { "type": "string", "example": "123e4567-e89b-12d3-a456-426614174000" } }, "example": [ { "capableUser": "admin", "managementId": "123e4567-e89b-42d3-a456-426614174000" }, { "capableUser": "rootadmin", "managementId": "123e4567-e89b-42d3-a456-426614174001" } ] }, "EnrollmentMethod": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "example": "1" }, "objectName": { "type": "string", "readOnly": true, "example": "user@domain.com" }, "objectType": { "type": "string", "readOnly": true, "example": "User-initiated - no invitation" } } }, "GroupMembership": { "type": "object", "properties": { "groupId": { "type": "string", "example": "1" }, "groupName": { "type": "string", "example": "groupOne" }, "groupDescription": { "type": "string", "example": "groupOne description" }, "smartGroup": { "type": "boolean", "description": "Indicates that group is smart group", "example": true } } } }, "parameters": { "page": { "name": "page", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 0 } }, "page-size": { "name": "page-size", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 100 } } }, "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": {} } } } } } } ```