package
0.0.0-20231018133601-58a68a826479
Repository: https://github.com/jc0b/go-jamf-api.git
Documentation: pkg.go.dev

# README

Go API client for api

Overview

The Jamf Pro API is a RESTful API for Jamf Pro built to enable consistent and efficient programmatic access to Jamf Pro.

The swagger schema can be found here.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: production
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import api "github.com/yohan460/go-jamf-api/api"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), api.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), api.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), api.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), api.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to /api

ClassMethodHTTP requestDescription
AdvancedMobileDeviceSearchesApiV1AdvancedMobileDeviceSearchesChoicesGetGet /v1/advanced-mobile-device-searches/choicesGet Mobile Device Advanced Search criteria choices
AdvancedMobileDeviceSearchesApiV1AdvancedMobileDeviceSearchesDeleteMultiplePostPost /v1/advanced-mobile-device-searches/delete-multipleRemove specified Advanced Search objects
AdvancedMobileDeviceSearchesApiV1AdvancedMobileDeviceSearchesGetGet /v1/advanced-mobile-device-searchesGet Advanced Search objects
AdvancedMobileDeviceSearchesApiV1AdvancedMobileDeviceSearchesIdDeleteDelete /v1/advanced-mobile-device-searches/{id}Remove specified Advanced Search object
AdvancedMobileDeviceSearchesApiV1AdvancedMobileDeviceSearchesIdGetGet /v1/advanced-mobile-device-searches/{id}Get specified Advanced Search object
AdvancedMobileDeviceSearchesApiV1AdvancedMobileDeviceSearchesIdPutPut /v1/advanced-mobile-device-searches/{id}Get specified Advanced Search object
AdvancedMobileDeviceSearchesApiV1AdvancedMobileDeviceSearchesPostPost /v1/advanced-mobile-device-searchesCreate Advanced Search object
AdvancedUserContentSearchesApiV1AdvancedUserContentSearchesGetGet /v1/advanced-user-content-searchesGet All Advanced User Content Search objects
AdvancedUserContentSearchesApiV1AdvancedUserContentSearchesIdDeleteDelete /v1/advanced-user-content-searches/{id}Remove specified Advanced User Content Search object
AdvancedUserContentSearchesApiV1AdvancedUserContentSearchesIdGetGet /v1/advanced-user-content-searches/{id}Get Specified Advanced User Content Search object
AdvancedUserContentSearchesApiV1AdvancedUserContentSearchesIdPutPut /v1/advanced-user-content-searches/{id}Get Specified Advanced User Content Search object
AdvancedUserContentSearchesApiV1AdvancedUserContentSearchesPostPost /v1/advanced-user-content-searchesCreate Advanced User Content Search object
ApiAuthenticationApiAuthCurrentPostPost /auth/currentGet the authorization details associated with the current API token
ApiAuthenticationApiAuthGetGet /authGet all the Authorization details associated with the current api
ApiAuthenticationApiAuthInvalidateTokenPostPost /auth/invalidateTokenInvalidate current token
ApiAuthenticationApiAuthKeepAlivePostPost /auth/keepAliveInvalidate existing token and generates new token
ApiAuthenticationApiAuthTokensPostPost /auth/tokensCreate a token based on other authentication details (basic, etc.)
ApiAuthenticationApiV1AuthGetGet /v1/authGet all the Authorization details associated with the current api
ApiAuthenticationApiV1AuthInvalidateTokenPostPost /v1/auth/invalidate-tokenInvalidate current token
ApiAuthenticationApiV1AuthKeepAlivePostPost /v1/auth/keep-aliveInvalidate existing token and generates new token
ApiAuthenticationApiV1AuthTokenPostPost /v1/auth/tokenCreate a token based on other authentication details (basic, etc.)
AppDynamicsConfigurationPreviewApiV1AppDynamicsScriptConfigurationGetGet /v1/app-dynamics/script-configurationGet Application Dynamics Config object
AppRequestPreviewApiV1AppRequestFormInputFieldsGetGet /v1/app-request/form-input-fieldsSearch for Form Input Fields
AppRequestPreviewApiV1AppRequestFormInputFieldsIdDeleteDelete /v1/app-request/form-input-fields/{id}Remove specified Form Input Field record
AppRequestPreviewApiV1AppRequestFormInputFieldsIdGetGet /v1/app-request/form-input-fields/{id}Get specified Form Input Field object
AppRequestPreviewApiV1AppRequestFormInputFieldsIdPutPut /v1/app-request/form-input-fields/{id}Update specified Form Input Field object
AppRequestPreviewApiV1AppRequestFormInputFieldsPostPost /v1/app-request/form-input-fieldsCreate Form Input Field record
AppRequestPreviewApiV1AppRequestFormInputFieldsPutPut /v1/app-request/form-input-fieldsReplace all Form Input Fields
AppRequestPreviewApiV1AppRequestSettingsGetGet /v1/app-request/settingsGet Applicastion Request Settings
AppRequestPreviewApiV1AppRequestSettingsPutPut /v1/app-request/settingsUpdate Application Request Settings
AppStoreCountryCodesPreviewApiV1AppStoreCountryCodesGetGet /v1/app-store-country-codesReturn a list of Countries and the associated Codes
BuildingsApiV1BuildingsDeleteMultiplePostPost /v1/buildings/delete-multipleDelete multiple Buildings by their ids
BuildingsApiV1BuildingsGetGet /v1/buildingsSearch for sorted and paged Buildings
BuildingsApiV1BuildingsIdDeleteDelete /v1/buildings/{id}Remove specified Building record
BuildingsApiV1BuildingsIdGetGet /v1/buildings/{id}Get specified Building object
BuildingsApiV1BuildingsIdHistoryGetGet /v1/buildings/{id}/historyGet specified Building History object
BuildingsApiV1BuildingsIdHistoryPostPost /v1/buildings/{id}/historyAdd specified Building history object notes
BuildingsApiV1BuildingsIdPutPut /v1/buildings/{id}Update specified Building object
BuildingsApiV1BuildingsPostPost /v1/buildingsCreate Building record
CacheSettingsApiV1CacheSettingsGetGet /v1/cache-settingsGet Cache Settings
CacheSettingsApiV1CacheSettingsPutPut /v1/cache-settingsUpdate Cache Settings
CategoriesApiV1CategoriesDeleteMultiplePostPost /v1/categories/delete-multipleDelete multiple Categories by their IDs
CategoriesApiV1CategoriesGetGet /v1/categoriesGet Category objects
CategoriesApiV1CategoriesIdDeleteDelete /v1/categories/{id}Remove specified Category record
CategoriesApiV1CategoriesIdGetGet /v1/categories/{id}Get specified Category object
CategoriesApiV1CategoriesIdHistoryGetGet /v1/categories/{id}/historyGet specified Category history object
CategoriesApiV1CategoriesIdHistoryPostPost /v1/categories/{id}/historyAdd specified Category history object notes
CategoriesApiV1CategoriesIdPutPut /v1/categories/{id}Update specified Category object
CategoriesApiV1CategoriesPostPost /v1/categoriesCreate Category record
CertificateAuthorityApiV1PkiCertificateAuthorityActiveDerGetGet /v1/pki/certificate-authority/active/derReturns X.509 of active Certificate Authority (CA) in DER format
CertificateAuthorityApiV1PkiCertificateAuthorityActiveGetGet /v1/pki/certificate-authority/activeReturns X.509 details of the active Certificate Authority (CA)
CertificateAuthorityApiV1PkiCertificateAuthorityActivePemGetGet /v1/pki/certificate-authority/active/pemReturns active Certificate Authority (CA) in PEM format
CertificateAuthorityApiV1PkiCertificateAuthorityIdDerGetGet /v1/pki/certificate-authority/{id}/derReturns X.509 current Certificate Authority (CA) with provided ID in DER format
CertificateAuthorityApiV1PkiCertificateAuthorityIdGetGet /v1/pki/certificate-authority/{id}Returns X.509 details of Certificate Authority (CA) with provided ID
CertificateAuthorityApiV1PkiCertificateAuthorityIdPemGetGet /v1/pki/certificate-authority/{id}/pemReturns current Certificate Authority (CA) with provided ID in PEM format
ClassicLdapApiV1ClassicLdapIdGetGet /v1/classic-ldap/{id}Get mappings for OnPrem Ldap configuration with given id.
ClientCheckInApiV2CheckInGetGet /v2/check-inGet Client Check-In settings
ClientCheckInApiV2CheckInHistoryGetGet /v2/check-in/historyGet Client Check-In history object
ClientCheckInApiV2CheckInHistoryPostPost /v2/check-in/historyAdd a Note to Client Check-In History
ClientCheckInApiV2CheckInPutPut /v2/check-inUpdate Client Check-In object
ClientCheckInApiV3CheckInGetGet /v3/check-inGet Client Check-In settings
ClientCheckInApiV3CheckInHistoryGetGet /v3/check-in/historyGet Client Check-In history object
ClientCheckInApiV3CheckInHistoryPostPost /v3/check-in/historyAdd a Note to Client Check-In History
ClientCheckInApiV3CheckInPutPut /v3/check-inUpdate Client Check-In object
CloudAzureApiV1AzureAdMigrationReportsIdDownloadGetGet /v1/azure-ad-migration/reports/{id}/downloadDownload report of provided report ID
CloudAzureApiV1AzureAdMigrationReportsIdGetGet /v1/azure-ad-migration/reports/{id}Check status of azure ad migration report
CloudAzureApiV1AzureAdMigrationReportsPendingGetGet /v1/azure-ad-migration/reports/pendingGet pending azure migration report
CloudAzureApiV1AzureAdMigrationReportsPostPost /v1/azure-ad-migration/reportsStart Azure Ad Migration report generation
CloudAzureApiV1CloudAzureDefaultsMappingsGetGet /v1/cloud-azure/defaults/mappingsGet default mappings
CloudAzureApiV1CloudAzureDefaultsServerConfigurationGetGet /v1/cloud-azure/defaults/server-configurationGet default server configuration
CloudAzureApiV1CloudAzureIdDeleteDelete /v1/cloud-azure/{id}Delete Cloud Identity Provider configuration.
CloudAzureApiV1CloudAzureIdGetGet /v1/cloud-azure/{id}Get Azure Cloud Identity Provider configuration with given ID.
CloudAzureApiV1CloudAzureIdPutPut /v1/cloud-azure/{id}Update Azure Cloud Identity Provider configuration
CloudAzureApiV1CloudAzurePostPost /v1/cloud-azureCreate Azure Cloud Identity Provider configuration
CloudIdpApiV1CloudIdpExportPostPost /v1/cloud-idp/exportExport Cloud Identity Providers collection
CloudIdpApiV1CloudIdpGetGet /v1/cloud-idpGet information about all Cloud Identity Providers configurations.
CloudIdpApiV1CloudIdpIdGetGet /v1/cloud-idp/{id}Get Cloud Identity Provider configuration with given ID.
CloudIdpApiV1CloudIdpIdHistoryGetGet /v1/cloud-idp/{id}/historyGet Cloud Identity Provider history
CloudIdpApiV1CloudIdpIdHistoryPostPost /v1/cloud-idp/{id}/historyAdd Cloud Identity Provider history note
CloudIdpApiV1CloudIdpIdTestGroupPostPost /v1/cloud-idp/{id}/test-groupGet group test search
CloudIdpApiV1CloudIdpIdTestUserMembershipPostPost /v1/cloud-idp/{id}/test-user-membershipGet membership test search
CloudIdpApiV1CloudIdpIdTestUserPostPost /v1/cloud-idp/{id}/test-userGet user test search
CloudLdapApiV1CloudLdapsDefaultsMappingsGetGet /v1/cloud-ldaps/defaults/mappingsGet default mappings
CloudLdapApiV1CloudLdapsDefaultsServerConfigurationGetGet /v1/cloud-ldaps/defaults/server-configurationGet default server configuration
CloudLdapApiV1CloudLdapsGetGet /v1/cloud-ldapsGet all Cloud Identity Providers configurations.
CloudLdapApiV1CloudLdapsIdConnectionBindGetGet /v1/cloud-ldaps/{id}/connection/bindGet bind connection pool statistics
CloudLdapApiV1CloudLdapsIdConnectionSearchGetGet /v1/cloud-ldaps/{id}/connection/searchGet search connection pool statistics
CloudLdapApiV1CloudLdapsIdDeleteDelete /v1/cloud-ldaps/{id}Delete Cloud Identity Provider configuration.
CloudLdapApiV1CloudLdapsIdGetGet /v1/cloud-ldaps/{id}Get Cloud Identity Provider configuration with given id.
CloudLdapApiV1CloudLdapsIdHistoryGetGet /v1/cloud-ldaps/{id}/historyGet Cloud Identity Provider history
CloudLdapApiV1CloudLdapsIdHistoryPostPost /v1/cloud-ldaps/{id}/historyAdd Cloud Identity Provider history note
CloudLdapApiV1CloudLdapsIdMappingsGetGet /v1/cloud-ldaps/{id}/mappingsGet mappings configurations for Cloud Identity Providers server configuration.
CloudLdapApiV1CloudLdapsIdMappingsPutPut /v1/cloud-ldaps/{id}/mappingsUpdate Cloud Identity Provider mappings configuration.
CloudLdapApiV1CloudLdapsIdPutPut /v1/cloud-ldaps/{id}Old update Cloud Identity Provider configuration
CloudLdapApiV1CloudLdapsIdTestGroupPostPost /v1/cloud-ldaps/{id}/test-groupGet group test search
CloudLdapApiV1CloudLdapsIdTestUserMembershipPostPost /v1/cloud-ldaps/{id}/test-user-membershipGet membership test search
CloudLdapApiV1CloudLdapsIdTestUserPostPost /v1/cloud-ldaps/{id}/test-userGet user test search
CloudLdapApiV1CloudLdapsPostPost /v1/cloud-ldapsCreate Cloud Identity Provider configuration
CloudLdapApiV1LdapKeystoreVerifyPostPost /v1/ldap-keystore/verifyValidate keystore for Cloud Identity Provider secure connection
CloudLdapApiV2CloudLdapsDefaultsProviderMappingsGetGet /v2/cloud-ldaps/defaults/{provider}/mappingsGet default mappings
CloudLdapApiV2CloudLdapsDefaultsProviderServerConfigurationGetGet /v2/cloud-ldaps/defaults/{provider}/server-configurationGet default server configuration
CloudLdapApiV2CloudLdapsIdConnectionBindGetGet /v2/cloud-ldaps/{id}/connection/bindGet bind connection pool statistics
CloudLdapApiV2CloudLdapsIdConnectionSearchGetGet /v2/cloud-ldaps/{id}/connection/searchGet search connection pool statistics
CloudLdapApiV2CloudLdapsIdConnectionStatusGetGet /v2/cloud-ldaps/{id}/connection/statusTests the communication with the specified cloud connection
CloudLdapApiV2CloudLdapsIdDeleteDelete /v2/cloud-ldaps/{id}Delete Cloud Identity Provider configuration.
CloudLdapApiV2CloudLdapsIdGetGet /v2/cloud-ldaps/{id}Get Cloud Identity Provider configuration with given id.
CloudLdapApiV2CloudLdapsIdMappingsGetGet /v2/cloud-ldaps/{id}/mappingsGet mappings configurations for Cloud Identity Providers server configuration.
CloudLdapApiV2CloudLdapsIdMappingsPutPut /v2/cloud-ldaps/{id}/mappingsUpdate Cloud Identity Provider mappings configuration.
CloudLdapApiV2CloudLdapsIdPutPut /v2/cloud-ldaps/{id}Update Cloud Identity Provider configuration
CloudLdapApiV2CloudLdapsPostPost /v2/cloud-ldapsCreate Cloud Identity Provider configuration
ComputerInventoryApiV1ComputersInventoryDetailIdGetGet /v1/computers-inventory-detail/{id}Return a Computer details with all sections
ComputerInventoryApiV1ComputersInventoryDetailIdPatchPatch /v1/computers-inventory-detail/{id}Return a updated computer instance
ComputerInventoryApiV1ComputersInventoryGetGet /v1/computers-inventoryReturn a Computer Inventory for paginated list of computers
ComputerInventoryApiV1ComputersInventoryIdAttachmentsAttachmentIdDeleteDelete /v1/computers-inventory/{id}/attachments/{attachmentId}Remove attachment
ComputerInventoryApiV1ComputersInventoryIdAttachmentsAttachmentIdGetGet /v1/computers-inventory/{id}/attachments/{attachmentId}Download attachment file
ComputerInventoryApiV1ComputersInventoryIdAttachmentsPostPost /v1/computers-inventory/{id}/attachmentsUpload attachment and assign to computer
ComputerInventoryApiV1ComputersInventoryIdDeleteDelete /v1/computers-inventory/{id}Remove specified Computer record
ComputerInventoryApiV1ComputersInventoryIdGetGet /v1/computers-inventory/{id}Return a Computer General details
ComputerInventoryApiV1ComputersInventoryIdViewRecoveryLockPasswordGetGet /v1/computers-inventory/{id}/view-recovery-lock-passwordReturn a Computers Recovery Lock Password
ComputerInventoryCollectionSettingsApiV1ComputerInventoryCollectionSettingsCustomPathIdDeleteDelete /v1/computer-inventory-collection-settings/custom-path/{id}Delete Custom Path from Computer Inventory Collection Settings
ComputerInventoryCollectionSettingsApiV1ComputerInventoryCollectionSettingsCustomPathPostPost /v1/computer-inventory-collection-settings/custom-pathCreate Computer Inventory Collection Settings Custom Path
ComputerInventoryCollectionSettingsApiV1ComputerInventoryCollectionSettingsGetGet /v1/computer-inventory-collection-settingsReturns computer inventory settings
ComputerInventoryCollectionSettingsApiV1ComputerInventoryCollectionSettingsPatchPatch /v1/computer-inventory-collection-settingsUpdate computer inventory settings
ComputerPrestagesApiV1ComputerPrestagesGetGet /v1/computer-prestagesSearch for sorted and paged Computer Prestages
ComputerPrestagesApiV1ComputerPrestagesIdDeleteDelete /v1/computer-prestages/{id}Delete a Computer Prestage with the supplied id
ComputerPrestagesApiV1ComputerPrestagesIdGetGet /v1/computer-prestages/{id}Retrieve a Computer Prestage with the supplied id
ComputerPrestagesApiV1ComputerPrestagesIdPutPut /v1/computer-prestages/{id}Update a Computer Prestage
ComputerPrestagesApiV1ComputerPrestagesIdScopeDeleteDelete /v1/computer-prestages/{id}/scopeRemove device Scope for a specific Computer Prestage
ComputerPrestagesApiV1ComputerPrestagesIdScopeGetGet /v1/computer-prestages/{id}/scopeGet device Scope for a specific Computer Prestage
ComputerPrestagesApiV1ComputerPrestagesIdScopePostPost /v1/computer-prestages/{id}/scopeAdd device Scope for a specific Computer Prestage
ComputerPrestagesApiV1ComputerPrestagesIdScopePutPut /v1/computer-prestages/{id}/scopeReplace device Scope for a specific Computer Prestage
ComputerPrestagesApiV1ComputerPrestagesPostPost /v1/computer-prestagesCreate a Computer Prestage
ComputerPrestagesApiV1ComputerPrestagesScopeGetGet /v1/computer-prestages/scopeGet all device Scope for all Computer Prestages
ComputerPrestagesApiV2ComputerPrestagesGetGet /v2/computer-prestagesGet sorted and paged Computer Prestages
ComputerPrestagesApiV2ComputerPrestagesIdDeleteDelete /v2/computer-prestages/{id}Delete a Computer Prestage with the supplied id
ComputerPrestagesApiV2ComputerPrestagesIdGetGet /v2/computer-prestages/{id}Retrieve a Computer Prestage with the supplied id
ComputerPrestagesApiV2ComputerPrestagesIdPutPut /v2/computer-prestages/{id}Update a Computer Prestage
ComputerPrestagesApiV2ComputerPrestagesIdScopeDeleteMultiplePostPost /v2/computer-prestages/{id}/scope/delete-multipleRemove device Scope for a specific Computer Prestage
ComputerPrestagesApiV2ComputerPrestagesIdScopeGetGet /v2/computer-prestages/{id}/scopeGet device Scope for a specific Computer Prestage
ComputerPrestagesApiV2ComputerPrestagesIdScopePostPost /v2/computer-prestages/{id}/scopeAdd device Scope for a specific Computer Prestage
ComputerPrestagesApiV2ComputerPrestagesIdScopePutPut /v2/computer-prestages/{id}/scopeReplace device Scope for a specific Computer Prestage
ComputerPrestagesApiV2ComputerPrestagesPostPost /v2/computer-prestagesCreate a Computer Prestage
ComputerPrestagesApiV2ComputerPrestagesScopeGetGet /v2/computer-prestages/scopeGet all device Scope for all Computer Prestages
ComputersPreviewApiPreviewComputersGetGet /preview/computersReturn a list of Computers
ConditionalAccessApiV1ConditionalAccessDeviceComplianceInformationComputerDeviceIdGetGet /v1/conditional-access/device-compliance-information/computer/{deviceId}Get compliance information for a single computer device
ConditionalAccessApiV1ConditionalAccessDeviceComplianceInformationMobileDeviceIdGetGet /v1/conditional-access/device-compliance-information/mobile/{deviceId}Get compliance information for a single mobile device
CsaApiV1CsaTokenDeleteDelete /v1/csa/tokenDelete the CSA token exchange - This will disable Jamf Pro's ability to authenticate with cloud-hosted services
CsaApiV1CsaTokenGetGet /v1/csa/tokenGet details regarding the CSA token exchange
CsaApiV1CsaTokenPostPost /v1/csa/tokenInitialize the CSA token exchange
CsaApiV1CsaTokenPutPut /v1/csa/tokenRe-initialize the CSA token exchange with new credentials
DepartmentsApiV1DepartmentsDeleteMultiplePostPost /v1/departments/delete-multipleDeletes all departments by ids passed in body
DepartmentsApiV1DepartmentsGetGet /v1/departmentsSearch for Departments
DepartmentsApiV1DepartmentsIdDeleteDelete /v1/departments/{id}Remove specified department record
DepartmentsApiV1DepartmentsIdGetGet /v1/departments/{id}Get specified Department object
DepartmentsApiV1DepartmentsIdHistoryGetGet /v1/departments/{id}/historyGet specified Department history object
DepartmentsApiV1DepartmentsIdHistoryPostPost /v1/departments/{id}/historyAdd specified Department history object notes
DepartmentsApiV1DepartmentsIdPutPut /v1/departments/{id}Update specified department object
DepartmentsApiV1DepartmentsPostPost /v1/departmentsCreate department record
DeviceCommunicationSettingsApiV1DeviceCommunicationSettingsGetGet /v1/device-communication-settingsRetrieves all settings for device communication
DeviceCommunicationSettingsApiV1DeviceCommunicationSettingsHistoryGetGet /v1/device-communication-settings/historyGet Device Communication settings history
DeviceCommunicationSettingsApiV1DeviceCommunicationSettingsHistoryPostPost /v1/device-communication-settings/historyAdd Device Communication Settings history notes
DeviceCommunicationSettingsApiV1DeviceCommunicationSettingsPutPut /v1/device-communication-settingsUpdate device communication settings
DeviceEnrollmentsApiV1DeviceEnrollmentsGetGet /v1/device-enrollmentsRead all sorted and paged Device Enrollment instances
DeviceEnrollmentsApiV1DeviceEnrollmentsIdDeleteDelete /v1/device-enrollments/{id}Delete a Device Enrollment Instance with the supplied id
DeviceEnrollmentsApiV1DeviceEnrollmentsIdDisownPostPost /v1/device-enrollments/{id}/disownDisown devices from the given Device Enrollment Instance
DeviceEnrollmentsApiV1DeviceEnrollmentsIdGetGet /v1/device-enrollments/{id}Retrieve a Device Enrollment Instance with the supplied id
DeviceEnrollmentsApiV1DeviceEnrollmentsIdHistoryGetGet /v1/device-enrollments/{id}/historyGet sorted and paged Device Enrollment history objects
DeviceEnrollmentsApiV1DeviceEnrollmentsIdHistoryPostPost /v1/device-enrollments/{id}/historyAdd Device Enrollment history object notes
DeviceEnrollmentsApiV1DeviceEnrollmentsIdPutPut /v1/device-enrollments/{id}Update a Device Enrollment Instance with the supplied id
DeviceEnrollmentsApiV1DeviceEnrollmentsIdSyncsGetGet /v1/device-enrollments/{id}/syncsGet all instance sync states for a single Device Enrollment Instance
DeviceEnrollmentsApiV1DeviceEnrollmentsIdSyncsLatestGetGet /v1/device-enrollments/{id}/syncs/latestGet the latest sync state for a single Device Enrollment Instance
DeviceEnrollmentsApiV1DeviceEnrollmentsIdUploadTokenPutPut /v1/device-enrollments/{id}/upload-tokenUpdate a Device Enrollment Instance with the supplied Token
DeviceEnrollmentsApiV1DeviceEnrollmentsPublicKeyGetGet /v1/device-enrollments/public-keyRetrieve the Jamf Pro Device Enrollment public key
DeviceEnrollmentsApiV1DeviceEnrollmentsSyncsGetGet /v1/device-enrollments/syncsGet all instance sync states for all Device Enrollment Instances
DeviceEnrollmentsApiV1DeviceEnrollmentsUploadTokenPostPost /v1/device-enrollments/upload-tokenCreate a Device Enrollment Instance with the supplied Token
DeviceEnrollmentsDevicesApiV1DeviceEnrollmentsIdDevicesGetGet /v1/device-enrollments/{id}/devicesRetrieve a list of Devices assigned to the supplied id
EbooksApiV1EbooksGetGet /v1/ebooksGet Ebook object
EbooksApiV1EbooksIdGetGet /v1/ebooks/{id}Get specified Ebook object
EbooksApiV1EbooksIdScopeGetGet /v1/ebooks/{id}/scopeGet specified scope of Ebook object
EngageApiV1EngageGetGet /v1/engageGet Engage settings
EngageApiV1EngageHistoryGetGet /v1/engage/historyGet Engage settings history
EngageApiV1EngageHistoryPostPost /v1/engage/historyAdd Engage settings history notes
EngageApiV1EngagePutPut /v1/engageUpdate Engage settings
EnrollmentApiPreviewEnrollmentAccessGroupsGetGet /preview/enrollment/access-groupsRetrieve the configured LDAP groups configured for User-Initiated Enrollment.
EnrollmentApiPreviewEnrollmentAccessGroupsIdDeleteDelete /preview/enrollment/access-groups/{id}Delete an LDAP group's access to user initiated Enrollment.
EnrollmentApiPreviewEnrollmentAccessGroupsIdGetGet /preview/enrollment/access-groups/{id}Retrieve the configured LDAP groups configured for User-Initiated Enrollment
EnrollmentApiPreviewEnrollmentAccessGroupsIdPutPut /preview/enrollment/access-groups/{id}Modify the configured LDAP groups configured for User-Initiated Enrollment. Only exiting Access Groups can be updated.
EnrollmentApiPreviewEnrollmentAccessGroupsPostPost /preview/enrollment/access-groupsAdd the configured LDAP group for User-Initiated Enrollment.
EnrollmentApiV1EnrollmentAccessGroupsGetGet /v1/enrollment/access-groupsRetrieve the configured LDAP groups configured for User-Initiated Enrollment
EnrollmentApiV1EnrollmentAccessGroupsGroupKeyDeleteDelete /v1/enrollment/access-groups/{group-key}Delete an LDAP group's access to user initiated Enrollment
EnrollmentApiV1EnrollmentAccessGroupsGroupKeyGetGet /v1/enrollment/access-groups/{group-key}Retrieve the configured LDAP groups configured for User-Initiated Enrollment
EnrollmentApiV1EnrollmentAccessGroupsGroupKeyPutPut /v1/enrollment/access-groups/{group-key}Modify the configured LDAP groups configured for User-Initiated Enrollment
EnrollmentApiV1EnrollmentFilteredLanguageCodesGetGet /v1/enrollment/filtered-language-codesRetrieve the list of languages and corresponding ISO 639-1 Codes but only those not already added to Enrollment
EnrollmentApiV1EnrollmentGetGet /v1/enrollmentGet Enrollment object and Re-enrollment settings
EnrollmentApiV1EnrollmentHistoryGetGet /v1/enrollment/historyGet sorted and paged Enrollment history object
EnrollmentApiV1EnrollmentHistoryPostPost /v1/enrollment/historyAdd Enrollment history object notes
EnrollmentApiV1EnrollmentLanguageCodesGetGet /v1/enrollment/language-codesRetrieve the list of languages and corresponding ISO 639-1 Codes
EnrollmentApiV1EnrollmentLanguagesGetGet /v1/enrollment/languagesGet an array of the language codes that have Enrollment messaging
EnrollmentApiV1EnrollmentLanguagesLanguageDeleteDelete /v1/enrollment/languages/{language}Delete the Enrollment messaging for a language
EnrollmentApiV1EnrollmentLanguagesLanguageGetGet /v1/enrollment/languages/{language}Retrieve the Enrollment messaging for a language
EnrollmentApiV1EnrollmentLanguagesLanguagePutPut /v1/enrollment/languages/{language}Edit Enrollment messaging for a language
EnrollmentApiV1EnrollmentPutPut /v1/enrollmentUpdate Enrollment object
EnrollmentApiV2EnrollmentAccessGroupsGetGet /v2/enrollment/access-groupsRetrieve the configured LDAP groups configured for User-Initiated Enrollment
EnrollmentApiV2EnrollmentAccessGroupsPostPost /v2/enrollment/access-groupsAdd the configured LDAP group for User-Initiated Enrollment.
EnrollmentApiV2EnrollmentAccessGroupsServerIdGroupIdDeleteDelete /v2/enrollment/access-groups/{serverId}/{groupId}Delete an LDAP group's access to user initiated Enrollment
EnrollmentApiV2EnrollmentAccessGroupsServerIdGroupIdGetGet /v2/enrollment/access-groups/{serverId}/{groupId}Retrieve the configured LDAP groups configured for User-Initiated Enrollment
EnrollmentApiV2EnrollmentAccessGroupsServerIdGroupIdPutPut /v2/enrollment/access-groups/{serverId}/{groupId}Modify the configured LDAP groups configured for User-Initiated Enrollment
EnrollmentApiV2EnrollmentFilteredLanguageCodesGetGet /v2/enrollment/filtered-language-codesRetrieve the list of languages and corresponding ISO 639-1 Codes but only those not already added to Enrollment
EnrollmentApiV2EnrollmentGetGet /v2/enrollmentGet Enrollment object and Re-enrollment settings
EnrollmentApiV2EnrollmentHistoryExportPostPost /v2/enrollment/history/exportExport enrollment history collection
EnrollmentApiV2EnrollmentHistoryGetGet /v2/enrollment/historyGet sorted and paged Enrollment history object
EnrollmentApiV2EnrollmentHistoryPostPost /v2/enrollment/historyAdd Enrollment history object notes
EnrollmentApiV2EnrollmentLanguageCodesGetGet /v2/enrollment/language-codesRetrieve the list of languages and corresponding ISO 639-1 Codes
EnrollmentApiV2EnrollmentLanguagesGetGet /v2/enrollment/languagesGet an array of the language codes that have Enrollment messaging
EnrollmentApiV2EnrollmentLanguagesLanguageIdDeleteDelete /v2/enrollment/languages/{languageId}Delete the Enrollment messaging for a language
EnrollmentApiV2EnrollmentLanguagesLanguageIdGetGet /v2/enrollment/languages/{languageId}Retrieve the Enrollment messaging for a language
EnrollmentApiV2EnrollmentLanguagesLanguageIdPutPut /v2/enrollment/languages/{languageId}Edit Enrollment messaging for a language
EnrollmentApiV2EnrollmentPutPut /v2/enrollmentUpdate Enrollment object
EnrollmentCustomizationApiV1EnrollmentCustomizationGetGet /v1/enrollment-customizationRetrieve sorted and paged Enrollment Customizations
EnrollmentCustomizationApiV1EnrollmentCustomizationIdDeleteDelete /v1/enrollment-customization/{id}Delete an Enrollment Customization with the supplied id
EnrollmentCustomizationApiV1EnrollmentCustomizationIdGetGet /v1/enrollment-customization/{id}Retrieve an Enrollment Customization with the supplied id
EnrollmentCustomizationApiV1EnrollmentCustomizationIdHistoryGetGet /v1/enrollment-customization/{id}/historyGet sorted and paged Enrollment Customization history objects
EnrollmentCustomizationApiV1EnrollmentCustomizationIdHistoryPostPost /v1/enrollment-customization/{id}/historyAdd Enrollment Customization history object notes
EnrollmentCustomizationApiV1EnrollmentCustomizationIdPrestagesGetGet /v1/enrollment-customization/{id}/prestagesRetrieve the list of Prestages using this Enrollment Customization
EnrollmentCustomizationApiV1EnrollmentCustomizationIdPutPut /v1/enrollment-customization/{id}Update an Enrollment Customization
EnrollmentCustomizationApiV1EnrollmentCustomizationImagesPostPost /v1/enrollment-customization/imagesUpload an image
EnrollmentCustomizationApiV1EnrollmentCustomizationPostPost /v1/enrollment-customizationCreate an Enrollment Customization
EnrollmentCustomizationApiV2EnrollmentCustomizationsGetGet /v2/enrollment-customizationsRetrieve sorted and paged Enrollment Customizations
EnrollmentCustomizationApiV2EnrollmentCustomizationsIdDeleteDelete /v2/enrollment-customizations/{id}Delete an Enrollment Customization with the supplied id
EnrollmentCustomizationApiV2EnrollmentCustomizationsIdGetGet /v2/enrollment-customizations/{id}Retrieve an Enrollment Customization with the supplied id
EnrollmentCustomizationApiV2EnrollmentCustomizationsIdHistoryGetGet /v2/enrollment-customizations/{id}/historyGet sorted and paged Enrollment Customization history objects
EnrollmentCustomizationApiV2EnrollmentCustomizationsIdHistoryPostPost /v2/enrollment-customizations/{id}/historyAdd Enrollment Customization history object notes
EnrollmentCustomizationApiV2EnrollmentCustomizationsIdPrestagesGetGet /v2/enrollment-customizations/{id}/prestagesRetrieve the list of Prestages using this Enrollment Customization
EnrollmentCustomizationApiV2EnrollmentCustomizationsIdPutPut /v2/enrollment-customizations/{id}Update an Enrollment Customization
EnrollmentCustomizationApiV2EnrollmentCustomizationsImagesPostPost /v2/enrollment-customizations/imagesUpload an image
EnrollmentCustomizationApiV2EnrollmentCustomizationsPostPost /v2/enrollment-customizationsCreate an Enrollment Customization
EnrollmentCustomizationPreviewApiV1EnrollmentCustomizationIdAllGetGet /v1/enrollment-customization/{id}/allGet all Panels for single Enrollment Customization
EnrollmentCustomizationPreviewApiV1EnrollmentCustomizationIdAllPanelIdDeleteDelete /v1/enrollment-customization/{id}/all/{panel-id}Delete a single Panel from an Enrollment Customization
EnrollmentCustomizationPreviewApiV1EnrollmentCustomizationIdAllPanelIdGetGet /v1/enrollment-customization/{id}/all/{panel-id}Get a single Panel for a single Enrollment Customization
EnrollmentCustomizationPreviewApiV1EnrollmentCustomizationIdLdapPanelIdDeleteDelete /v1/enrollment-customization/{id}/ldap/{panel-id}Delete an LDAP single panel from an Enrollment Customization
EnrollmentCustomizationPreviewApiV1EnrollmentCustomizationIdLdapPanelIdGetGet /v1/enrollment-customization/{id}/ldap/{panel-id}Get a single LDAP panel for a single Enrollment Customization
EnrollmentCustomizationPreviewApiV1EnrollmentCustomizationIdLdapPanelIdPutPut /v1/enrollment-customization/{id}/ldap/{panel-id}Update a single LDAP Panel for a single Enrollment Customization
EnrollmentCustomizationPreviewApiV1EnrollmentCustomizationIdLdapPostPost /v1/enrollment-customization/{id}/ldapCreate an LDAP Panel for a single Enrollment Customization
EnrollmentCustomizationPreviewApiV1EnrollmentCustomizationIdSsoPanelIdDeleteDelete /v1/enrollment-customization/{id}/sso/{panel-id}Delete a single SSO Panel from an Enrollment Customization
EnrollmentCustomizationPreviewApiV1EnrollmentCustomizationIdSsoPanelIdGetGet /v1/enrollment-customization/{id}/sso/{panel-id}Get a single SSO Panel for a single Enrollment Customization
EnrollmentCustomizationPreviewApiV1EnrollmentCustomizationIdSsoPanelIdPutPut /v1/enrollment-customization/{id}/sso/{panel-id}Update a single SSO Panel for a single Enrollment Customization
EnrollmentCustomizationPreviewApiV1EnrollmentCustomizationIdSsoPostPost /v1/enrollment-customization/{id}/ssoCreate an SSO Panel for a single Enrollment Customization
EnrollmentCustomizationPreviewApiV1EnrollmentCustomizationIdTextPanelIdDeleteDelete /v1/enrollment-customization/{id}/text/{panel-id}Delete a Text single Panel from an Enrollment Customization
EnrollmentCustomizationPreviewApiV1EnrollmentCustomizationIdTextPanelIdGetGet /v1/enrollment-customization/{id}/text/{panel-id}Get a single Text Panel for a single Enrollment Customization
EnrollmentCustomizationPreviewApiV1EnrollmentCustomizationIdTextPanelIdMarkdownGetGet /v1/enrollment-customization/{id}/text/{panel-id}/markdownGet the markdown output of a single Text Panel for a single Enrollment
EnrollmentCustomizationPreviewApiV1EnrollmentCustomizationIdTextPanelIdPutPut /v1/enrollment-customization/{id}/text/{panel-id}Update a single Text Panel for a single Enrollment Customization
EnrollmentCustomizationPreviewApiV1EnrollmentCustomizationIdTextPostPost /v1/enrollment-customization/{id}/textCreate a Text Panel for a single Enrollment Customization
EnrollmentCustomizationPreviewApiV1EnrollmentCustomizationParseMarkdownPostPost /v1/enrollment-customization/parse-markdownParse the given string as markdown text and return Html output
IconApiV1IconIdGetGet /v1/icon/{id}Get an icon
IconApiV1IconPostPost /v1/iconUpload an icon
InventoryInformationApiV1InventoryInformationGetGet /v1/inventory-informationGet statistics about managed/unmanaged devices and computers in the inventory
InventoryPreloadApiInventoryPreloadCsvTemplateGetGet /inventory-preload/csv-templateGet the Inventory Preload CSV template
InventoryPreloadApiInventoryPreloadDeleteDelete /inventory-preloadDelete all Inventory Preload records
InventoryPreloadApiInventoryPreloadGetGet /inventory-preloadReturn all Inventory Preload records
InventoryPreloadApiInventoryPreloadHistoryGetGet /inventory-preload/historyGet Inventory Preload history entries
InventoryPreloadApiInventoryPreloadHistoryNotesPostPost /inventory-preload/history/notesAdd Inventory Preload history object notes
InventoryPreloadApiInventoryPreloadIdDeleteDelete /inventory-preload/{id}Delete an Inventory Preload record
InventoryPreloadApiInventoryPreloadIdGetGet /inventory-preload/{id}Get an Inventory Preload record
InventoryPreloadApiInventoryPreloadIdPutPut /inventory-preload/{id}Update an Inventory Preload record
InventoryPreloadApiInventoryPreloadPostPost /inventory-preloadCreate a new Inventory Preload record using JSON or CSV
InventoryPreloadApiInventoryPreloadValidateCsvPostPost /inventory-preload/validate-csvValidate a given CSV file
InventoryPreloadApiV1InventoryPreloadCsvTemplateGetGet /v1/inventory-preload/csv-templateRetrieve the Inventory Preload CSV template
InventoryPreloadApiV1InventoryPreloadDeleteDelete /v1/inventory-preloadDelete all Inventory Preload records
InventoryPreloadApiV1InventoryPreloadGetGet /v1/inventory-preloadReturn all Inventory Preload records
InventoryPreloadApiV1InventoryPreloadHistoryGetGet /v1/inventory-preload/historyGet Inventory Preload history entries
InventoryPreloadApiV1InventoryPreloadHistoryPostPost /v1/inventory-preload/historyAdd Inventory Preload history object notes
InventoryPreloadApiV1InventoryPreloadIdDeleteDelete /v1/inventory-preload/{id}Delete an Inventory Preload record
InventoryPreloadApiV1InventoryPreloadIdGetGet /v1/inventory-preload/{id}Get an Inventory Preload record
InventoryPreloadApiV1InventoryPreloadIdPutPut /v1/inventory-preload/{id}Update an Inventory Preload record
InventoryPreloadApiV1InventoryPreloadPostPost /v1/inventory-preloadCreate a new Inventory Preload record using JSON or CSV
InventoryPreloadApiV1InventoryPreloadValidateCsvPostPost /v1/inventory-preload/validate-csvValidate a given CSV file
InventoryPreloadApiV2InventoryPreloadCsvGetGet /v2/inventory-preload/csvDownload all Inventory Preload records
InventoryPreloadApiV2InventoryPreloadCsvPostPost /v2/inventory-preload/csvCreate one or more new Inventory Preload records using CSV
InventoryPreloadApiV2InventoryPreloadCsvTemplateGetGet /v2/inventory-preload/csv-templateDownload the Inventory Preload CSV template
InventoryPreloadApiV2InventoryPreloadCsvValidatePostPost /v2/inventory-preload/csv-validateValidate a given CSV file
InventoryPreloadApiV2InventoryPreloadEaColumnsGetGet /v2/inventory-preload/ea-columnsRetrieve a list of extension attribute columns
InventoryPreloadApiV2InventoryPreloadExportPostPost /v2/inventory-preload/exportExport a collection of inventory preload records
InventoryPreloadApiV2InventoryPreloadHistoryGetGet /v2/inventory-preload/historyGet Inventory Preload history entries
InventoryPreloadApiV2InventoryPreloadHistoryPostPost /v2/inventory-preload/historyAdd Inventory Preload history object notes
InventoryPreloadApiV2InventoryPreloadRecordsDeleteAllPostPost /v2/inventory-preload/records/delete-allDelete all Inventory Preload records
InventoryPreloadApiV2InventoryPreloadRecordsGetGet /v2/inventory-preload/recordsReturn all Inventory Preload records
InventoryPreloadApiV2InventoryPreloadRecordsIdDeleteDelete /v2/inventory-preload/records/{id}Delete an Inventory Preload record
InventoryPreloadApiV2InventoryPreloadRecordsIdGetGet /v2/inventory-preload/records/{id}Get an Inventory Preload record
InventoryPreloadApiV2InventoryPreloadRecordsIdPutPut /v2/inventory-preload/records/{id}Update an Inventory Preload record
InventoryPreloadApiV2InventoryPreloadRecordsPostPost /v2/inventory-preload/recordsCreate a new Inventory Preload record using JSON
JamfConnectApiV1JamfConnectConfigProfilesGetGet /v1/jamf-connect/config-profilesSearch for config profiles linked to Jamf Connect
JamfConnectApiV1JamfConnectConfigProfilesIdPutPut /v1/jamf-connect/config-profiles/{id}Update the way the Jamf Connect app gets updated on computers within scope of the associated configuration profile.
JamfConnectApiV1JamfConnectDeploymentsIdTasksGetGet /v1/jamf-connect/deployments/{id}/tasksSearch for deployment tasks for a config profile linked to Jamf Connect
JamfConnectApiV1JamfConnectDeploymentsIdTasksRetryPostPost /v1/jamf-connect/deployments/{id}/tasks/retryRequest a retry of Connect install tasks
JamfConnectApiV1JamfConnectGetGet /v1/jamf-connectGet the Jamf Connect settings that you have access to see
JamfConnectApiV1JamfConnectHistoryGetGet /v1/jamf-connect/historyGet Jamf Connect history
JamfConnectApiV1JamfConnectHistoryPostPost /v1/jamf-connect/historyAdd Jamf Connect history notes
JamfManagementFrameworkApiV1JamfManagementFrameworkRedeployIdPostPost /v1/jamf-management-framework/redeploy/{id}Redeploy Jamf Management Framework
JamfPackageApiV1JamfPackageGetGet /v1/jamf-packageGet the packages for a given Jamf application
JamfPackageApiV2JamfPackageGetGet /v2/jamf-packageGet the packages for a given Jamf application
JamfProInformationPreviewApiV1JamfProInformationGetGet /v1/jamf-pro-informationGet basic information about the Jamf Pro Server
JamfProInitializationApiV1SystemInitializeDatabaseConnectionPostPost /v1/system/initialize-database-connectionProvide Database Password during startup
JamfProInitializationApiV1SystemInitializePostPost /v1/system/initializeSet up fresh installed Jamf Pro Server
JamfProInitializationPreviewApiSystemInitializeDatabaseConnectionPostPost /system/initialize-database-connectionProvide Database Password during startup
JamfProInitializationPreviewApiSystemInitializePostPost /system/initializeSet up fresh installed Jamf Pro Server
JamfProNotificationsApiV1NotificationsGetGet /v1/notificationsGet Notifications for user and site
JamfProNotificationsApiV1NotificationsTypeIdDeleteDelete /v1/notifications/{type}/{id}Delete Notifications
JamfProNotificationsPreviewApiNotificationsAlertsGetGet /notifications/alertsGet Notifications for user and site
JamfProNotificationsPreviewApiNotificationsAlertsIdDeleteDelete /notifications/alerts/{id}DEPRECATED - USE "alerts/{type}/{id}" INSTEAD. Deletes only Patch Management notifications.
JamfProNotificationsPreviewApiNotificationsAlertsTypeIdDeleteDelete /notifications/alerts/{type}/{id}Delete Notifications
JamfProServerUrlPreviewApiV1JamfProServerUrlGetGet /v1/jamf-pro-server-urlGet Jamf Pro Server URL settings
JamfProServerUrlPreviewApiV1JamfProServerUrlHistoryGetGet /v1/jamf-pro-server-url/historyGet Jamf Pro Server URL settings history
JamfProServerUrlPreviewApiV1JamfProServerUrlHistoryPostPost /v1/jamf-pro-server-url/historyAdd Jamf Pro Server URL settings history notes
JamfProServerUrlPreviewApiV1JamfProServerUrlPutPut /v1/jamf-pro-server-urlUpdate Jamf Pro Server URL settings
JamfProUserAccountSettingsApiV1UserPreferencesKeyIdDeleteDelete /v1/user/preferences/{keyId}Remove specified setting for authenticated user
JamfProUserAccountSettingsApiV1UserPreferencesKeyIdGetGet /v1/user/preferences/{keyId}Get the user setting for the authenticated user and key
JamfProUserAccountSettingsApiV1UserPreferencesKeyIdPutPut /v1/user/preferences/{keyId}Persist the user setting
JamfProUserAccountSettingsPreviewApiUserObjPreferenceKeyDeleteDelete /user/obj/preference/{key}Remove specified setting for authenticated user
JamfProUserAccountSettingsPreviewApiUserObjPreferenceKeyGetGet /user/obj/preference/{key}Get the user setting for the authenticated user and key
JamfProUserAccountSettingsPreviewApiUserObjPreferenceKeyPutPut /user/obj/preference/{key}Persist the user setting
JamfProVersionApiV1JamfProVersionGetGet /v1/jamf-pro-versionReturn information about the Jamf Pro including the current version
JamfProtectApiV1JamfProtectDeleteDelete /v1/jamf-protectDelete Jamf Protect API registration.
JamfProtectApiV1JamfProtectDeploymentsIdTasksGetGet /v1/jamf-protect/deployments/{id}/tasksSearch for deployment tasks for a config profile linked to Jamf Protect
JamfProtectApiV1JamfProtectDeploymentsIdTasksRetryPostPost /v1/jamf-protect/deployments/{id}/tasks/retryRequest a retry of Protect install tasks
JamfProtectApiV1JamfProtectGetGet /v1/jamf-protectJamf Protect integration settings
JamfProtectApiV1JamfProtectHistoryGetGet /v1/jamf-protect/historyGet Jamf Protect history
JamfProtectApiV1JamfProtectHistoryPostPost /v1/jamf-protect/historyAdd Jamf Protect history notes
JamfProtectApiV1JamfProtectPlansGetGet /v1/jamf-protect/plansGet all of the previously synced Jamf Protect Plans with information about their associated configuration profile
JamfProtectApiV1JamfProtectPlansSyncPostPost /v1/jamf-protect/plans/syncSync Plans with Jamf Protect
JamfProtectApiV1JamfProtectPutPut /v1/jamf-protectJamf Protect integration settings
JamfProtectApiV1JamfProtectRegisterPostPost /v1/jamf-protect/registerRegister a Jamf Protect API configuration with Jamf Pro
LdapApiLdapGroupsGetGet /ldap/groupsRetrieve the configured access groups that contain the text in the search param
LdapApiLdapServersGetGet /ldap/serversRetrieve all Servers including LDAP and Cloud Identity Providers.
LdapApiV1LdapGroupsGetGet /v1/ldap/groupsRetrieve the configured access groups that contain the text in the search param
LdapApiV1LdapLdapServersGetGet /v1/ldap/ldap-serversRetrieve all LDAP Servers.
LdapApiV1LdapServersGetGet /v1/ldap/serversRetrieve all Servers including LDAP and Cloud Identity Providers.
LocalesPreviewApiV1LocalesGetGet /v1/localesReturn locales that can be used in other features
MacosManagedSoftwareUpdatesApiV1MacosManagedSoftwareUpdatesAvailableUpdatesGetGet /v1/macos-managed-software-updates/available-updatesRetrieve available MacOs Managed Software Updates
MacosManagedSoftwareUpdatesApiV1MacosManagedSoftwareUpdatesSendUpdatesPostPost /v1/macos-managed-software-updates/send-updatesSend MacOs Managed Software Updates
MdmApiPreviewMdmCommandsPostPost /preview/mdm/commandsPost a command for creation and queuing
MdmApiV1DeployPackagePostPost /v1/deploy-packageDeploy packages using MDM
MdmApiV1MdmCommandsGetGet /v1/mdm/commandsGet information about mdm commands made by Jamf Pro.
MdmApiV1MdmRenewProfilePostPost /v1/mdm/renew-profileRenew MDM Profile
MobileDeviceEnrollmentProfileApiV1MobileDeviceEnrollmentProfileIdDownloadProfileGetGet /v1/mobile-device-enrollment-profile/{id}/download-profileRetrieve the MDM Enrollment Profile
MobileDeviceExtensionAttributesPreviewApiDevicesExtensionAttributesGetGet /devices/extensionAttributesGet Mobile Device Extension Attribute values placed in select paramter
MobileDeviceGroupsPreviewApiV1MobileDeviceGroupsGetGet /v1/mobile-device-groupsReturn the list of all Mobile Device Groups
MobileDevicePrestagesApiV1MobileDevicePrestagesGetGet /v1/mobile-device-prestagesSearch for sorted and paged Mobile Device Prestages
MobileDevicePrestagesApiV1MobileDevicePrestagesIdAttachmentsDeleteDelete /v1/mobile-device-prestages/{id}/attachmentsRemove an attachment for a Mobile Device Prestage
MobileDevicePrestagesApiV1MobileDevicePrestagesIdAttachmentsGetGet /v1/mobile-device-prestages/{id}/attachmentsGet attachments for a Mobile Device Prestage
MobileDevicePrestagesApiV1MobileDevicePrestagesIdAttachmentsPostPost /v1/mobile-device-prestages/{id}/attachmentsAdd an attachment to a Mobile Device Prestage
MobileDevicePrestagesApiV1MobileDevicePrestagesIdDeleteDelete /v1/mobile-device-prestages/{id}Delete a Mobile Device Prestage with the supplied id
MobileDevicePrestagesApiV1MobileDevicePrestagesIdGetGet /v1/mobile-device-prestages/{id}Retrieve a Mobile Device Prestage with the supplied id
MobileDevicePrestagesApiV1MobileDevicePrestagesIdHistoryGetGet /v1/mobile-device-prestages/{id}/historyGet sorted and paged Mobile Device Prestage history objects
MobileDevicePrestagesApiV1MobileDevicePrestagesIdHistoryPostPost /v1/mobile-device-prestages/{id}/historyAdd Mobile Device Prestage history object notes
MobileDevicePrestagesApiV1MobileDevicePrestagesIdPutPut /v1/mobile-device-prestages/{id}Update a Mobile Device Prestage
MobileDevicePrestagesApiV1MobileDevicePrestagesIdScopeDeleteDelete /v1/mobile-device-prestages/{id}/scopeRemove Device Scope for a specific Mobile Device Prestage
MobileDevicePrestagesApiV1MobileDevicePrestagesIdScopeGetGet /v1/mobile-device-prestages/{id}/scopeGet Device Scope for a specific Mobile Device Prestage
MobileDevicePrestagesApiV1MobileDevicePrestagesIdScopePostPost /v1/mobile-device-prestages/{id}/scopeAdd Device Scope for a specific Mobile Device Prestage
MobileDevicePrestagesApiV1MobileDevicePrestagesIdScopePutPut /v1/mobile-device-prestages/{id}/scopeReplace Device Scope for a specific Mobile Device Prestage
MobileDevicePrestagesApiV1MobileDevicePrestagesPostPost /v1/mobile-device-prestagesCreate a Mobile Device Prestage
MobileDevicePrestagesApiV1MobileDevicePrestagesScopeGetGet /v1/mobile-device-prestages/scopeGet all Device Scope for all Mobile Device Prestages
MobileDevicePrestagesApiV1MobileDevicePrestagesSyncGetGet /v1/mobile-device-prestages/syncGet all Prestage sync States for all prestages
MobileDevicePrestagesApiV1MobileDevicePrestagesSyncIdGetGet /v1/mobile-device-prestages/sync/{id}Get all prestage sync states for a single prestage
MobileDevicePrestagesApiV1MobileDevicePrestagesSyncIdLatestGetGet /v1/mobile-device-prestages/sync/{id}/latestGet the latest Sync State for a single Prestage
MobileDevicePrestagesApiV2MobileDevicePrestagesGetGet /v2/mobile-device-prestagesGet sorted and paged Mobile Device Prestages
MobileDevicePrestagesApiV2MobileDevicePrestagesIdAttachmentsDeleteMultiplePostPost /v2/mobile-device-prestages/{id}/attachments/delete-multipleRemove an attachment for a Mobile Device Prestage
MobileDevicePrestagesApiV2MobileDevicePrestagesIdAttachmentsGetGet /v2/mobile-device-prestages/{id}/attachmentsGet attachments for a Mobile Device Prestage
MobileDevicePrestagesApiV2MobileDevicePrestagesIdAttachmentsPostPost /v2/mobile-device-prestages/{id}/attachmentsAdd an attachment to a Mobile Device Prestage
MobileDevicePrestagesApiV2MobileDevicePrestagesIdDeleteDelete /v2/mobile-device-prestages/{id}Delete a Mobile Device Prestage with the supplied id
MobileDevicePrestagesApiV2MobileDevicePrestagesIdGetGet /v2/mobile-device-prestages/{id}Retrieve a Mobile Device Prestage with the supplied id
MobileDevicePrestagesApiV2MobileDevicePrestagesIdHistoryGetGet /v2/mobile-device-prestages/{id}/historyGet sorted and paged Mobile Device Prestage history objects
MobileDevicePrestagesApiV2MobileDevicePrestagesIdHistoryPostPost /v2/mobile-device-prestages/{id}/historyAdd Mobile Device Prestage history object notes
MobileDevicePrestagesApiV2MobileDevicePrestagesIdPutPut /v2/mobile-device-prestages/{id}Update a Mobile Device Prestage
MobileDevicePrestagesApiV2MobileDevicePrestagesIdScopeDeleteMultiplePostPost /v2/mobile-device-prestages/{id}/scope/delete-multipleRemove Device Scope for a specific Mobile Device Prestage
MobileDevicePrestagesApiV2MobileDevicePrestagesIdScopeGetGet /v2/mobile-device-prestages/{id}/scopeGet Device Scope for a specific Mobile Device Prestage
MobileDevicePrestagesApiV2MobileDevicePrestagesIdScopePostPost /v2/mobile-device-prestages/{id}/scopeAdd Device Scope for a specific Mobile Device Prestage
MobileDevicePrestagesApiV2MobileDevicePrestagesIdScopePutPut /v2/mobile-device-prestages/{id}/scopeReplace Device Scope for a specific Mobile Device Prestage
MobileDevicePrestagesApiV2MobileDevicePrestagesIdSyncsGetGet /v2/mobile-device-prestages/{id}/syncsGet all prestage sync states for a single prestage
MobileDevicePrestagesApiV2MobileDevicePrestagesIdSyncsLatestGetGet /v2/mobile-device-prestages/{id}/syncs/latestGet the latest Sync State for a single Prestage
MobileDevicePrestagesApiV2MobileDevicePrestagesPostPost /v2/mobile-device-prestagesCreate a Mobile Device Prestage
MobileDevicePrestagesApiV2MobileDevicePrestagesScopeGetGet /v2/mobile-device-prestages/scopeGet all Device Scope for all Mobile Device Prestages
MobileDevicePrestagesApiV2MobileDevicePrestagesSyncsGetGet /v2/mobile-device-prestages/syncsGet all Prestage sync States for all prestages
MobileDevicesApiV1MobileDevicesGetGet /v1/mobile-devicesGet Mobile Device objects
MobileDevicesApiV1MobileDevicesIdDetailGetGet /v1/mobile-devices/{id}/detailGet Mobile Device
MobileDevicesApiV1MobileDevicesIdGetGet /v1/mobile-devices/{id}Get Mobile Device
MobileDevicesApiV1MobileDevicesIdPatchPatch /v1/mobile-devices/{id}Update fields on a mobile device that are allowed to be modified by users
MobileDevicesApiV1SearchMobileDevicesPostPost /v1/search-mobile-devicesSearch Mobile Devices
MobileDevicesApiV2MobileDevicesGetGet /v2/mobile-devicesGet Mobile Device objects
MobileDevicesApiV2MobileDevicesIdDetailGetGet /v2/mobile-devices/{id}/detailGet Mobile Device
MobileDevicesApiV2MobileDevicesIdGetGet /v2/mobile-devices/{id}Get Mobile Device
MobileDevicesApiV2MobileDevicesIdPatchPatch /v2/mobile-devices/{id}Update fields on a mobile device that are allowed to be modified by users
ParentAppPreviewApiV1ParentAppGetGet /v1/parent-appGet the current Jamf Parent app settings
ParentAppPreviewApiV1ParentAppHistoryGetGet /v1/parent-app/historyGet Jamf Parent app settings history
ParentAppPreviewApiV1ParentAppHistoryPostPost /v1/parent-app/historyAdd Jamf Parent app settings history notes
ParentAppPreviewApiV1ParentAppPutPut /v1/parent-appUpdate Jamf Parent app settings
PatchPoliciesPreviewApiPatchPatchPoliciesGetGet /patch/patch-policiesReturn a list of patch policies
PatchPoliciesPreviewApiPatchPatchPoliciesIdDashboardDeleteDelete /patch/patch-policies/{id}/dashboardRemove a patch policy from the dashboard
PatchPoliciesPreviewApiPatchPatchPoliciesIdDashboardGetGet /patch/patch-policies/{id}/dashboardReturn whether or not the requested patch policy is on the dashboard
PatchPoliciesPreviewApiPatchPatchPoliciesIdDashboardPostPost /patch/patch-policies/{id}/dashboardAdd a patch policy to the dashboard
PatchPolicyLogsPreviewApiPatchPatchPoliciesIdLogsGetGet /patch/patch-policies/{id}/logsReturn the Patch Policy Attempt details
PatchesApiPatchIdGetGet /patch/{id}Return Active Patch Summary
PatchesApiPatchIdPutPut /patch/{id}Update patch report
PatchesApiPatchIdVersionsGetGet /patch/{id}/versionsReturn patch versions
PatchesApiPatchObjPolicyIdGetGet /patch/obj/policy/{id}Return Patch Policy Summary
PatchesApiPatchSvcDisclaimerAgreePostPost /patch/svc/disclaimerAgreeAccept Patch reporting disclaimer
PatchesPreviewApiPatchDisclaimerAgreePostPost /patch/disclaimerAgreeAccept Patch reporting disclaimer
PatchesPreviewApiPatchObjIdGetGet /patch/obj/{id}Return Active Patch Summary
PatchesPreviewApiPatchObjIdPutPut /patch/obj/{id}Update patch report
PatchesPreviewApiPatchObjIdVersionsGetGet /patch/obj/{id}/versionsReturn patch versions
PatchesPreviewApiPatchObjPolicyIdLogsEligibleRetryCountGetGet /patch/obj/policy/{id}/logs/eligibleRetryCountReturn the count of the Patch Policy Logs for the policy is that are eligible for a retry attempt
PatchesPreviewApiPatchObjPolicyIdSoftwareTitleConfigurationIdGetGet /patch/obj/policy/{id}/softwareTitleConfigurationIdReturn the Software Title Configuration Id for the given patch
PatchesPreviewApiPatchObjSoftwareTitleConfigurationIdGetGet /patch/obj/softwareTitleConfiguration/{id}Return the Software Title Configuration
PatchesPreviewApiPatchObjSoftwareTitleIdPoliciesGetGet /patch/obj/softwareTitle/{id}/policiesReturn the Summaries of the Patch Policies for the software title
PatchesPreviewApiPatchObjsPolicyIdGetGet /patch/objs/policy/{id}Return Patch Policy Summary
PatchesPreviewApiPatchOnDashboardGetGet /patch/onDashboardReturn list of Patch ids on dashboard
PatchesPreviewApiPatchRetryPolicyPostPost /patch/retryPolicyRetry policy
PatchesPreviewApiPatchSearchActivePatchHistoryPostPost /patch/searchActivePatchHistorySearch the history for a Specific Active Patch
PatchesPreviewApiPatchSearchPatchPolicyLogsPostPost /patch/searchPatchPolicyLogsReturn Patch Policy Logs
PatchesPreviewApiPatchSvcRetryPolicyPostPost /patch/svc/retryPolicyRetry policy
PoliciesPreviewApiSettingsObjPolicyPropertiesGetGet /settings/obj/policyPropertiesGet Policy Properties object
PoliciesPreviewApiSettingsObjPolicyPropertiesPutPut /settings/obj/policyPropertiesUpdate Policy Properties object
PoliciesPreviewApiV1PolicyPropertiesGetGet /v1/policy-propertiesGet Policy Properties object
PoliciesPreviewApiV1PolicyPropertiesPutPut /v1/policy-propertiesUpdate Policy Properties object
ReEnrollmentPreviewApiV1ReenrollmentGetGet /v1/reenrollmentGet Re-enrollment object
ReEnrollmentPreviewApiV1ReenrollmentHistoryGetGet /v1/reenrollment/historyGet Re-enrollment history object
ReEnrollmentPreviewApiV1ReenrollmentHistoryPostPost /v1/reenrollment/historyAdd specified Re-enrollment history object notes
ReEnrollmentPreviewApiV1ReenrollmentPutPut /v1/reenrollmentUpdate the Re-enrollment object
RemoteAdministrationApiPreviewRemoteAdministrationConfigurationsGetGet /preview/remote-administration-configurationsGet information about all remote administration configurations.
ScriptsApiV1ScriptsGetGet /v1/scriptsSearch for sorted and paged Scripts
ScriptsApiV1ScriptsIdDeleteDelete /v1/scripts/{id}Delete a Script at the specified id
ScriptsApiV1ScriptsIdDownloadGetGet /v1/scripts/{id}/downloadDownload a text file of the Script contents
ScriptsApiV1ScriptsIdGetGet /v1/scripts/{id}Retrieve a full script object
ScriptsApiV1ScriptsIdHistoryGetGet /v1/scripts/{id}/historyGet specified Script history object
ScriptsApiV1ScriptsIdHistoryPostPost /v1/scripts/{id}/historyAdd specified Script history object notes
ScriptsApiV1ScriptsIdPutPut /v1/scripts/{id}Replace the script at the id with the supplied information
ScriptsApiV1ScriptsPostPost /v1/scriptsCreate a Script
SelfServiceApiV1SelfServiceSettingsGetGet /v1/self-service/settingsGet an object representation of Self Service settings
SelfServiceApiV1SelfServiceSettingsPutPut /v1/self-service/settingsPut an object representation of Self Service settings
SelfServiceBrandingIosApiV1SelfServiceBrandingIosGetGet /v1/self-service/branding/iosSearch for sorted and paged iOS branding configurations
SelfServiceBrandingIosApiV1SelfServiceBrandingIosIdDeleteDelete /v1/self-service/branding/ios/{id}Delete the Self Service iOS branding configuration indicated by the provided id
SelfServiceBrandingIosApiV1SelfServiceBrandingIosIdGetGet /v1/self-service/branding/ios/{id}Read a single Self Service iOS branding configuration indicated by the provided id
SelfServiceBrandingIosApiV1SelfServiceBrandingIosIdPutPut /v1/self-service/branding/ios/{id}Update a Self Service iOS branding configuration with the supplied details
SelfServiceBrandingIosApiV1SelfServiceBrandingIosPostPost /v1/self-service/branding/iosCreate a Self Service iOS branding configuration with the supplied
SelfServiceBrandingMacosApiV1SelfServiceBrandingMacosGetGet /v1/self-service/branding/macosSearch for sorted and paged macOS branding configurations
SelfServiceBrandingMacosApiV1SelfServiceBrandingMacosIdDeleteDelete /v1/self-service/branding/macos/{id}Delete the Self Service macOS branding configuration indicated by the provided id
SelfServiceBrandingMacosApiV1SelfServiceBrandingMacosIdGetGet /v1/self-service/branding/macos/{id}Read a single Self Service macOS branding configuration indicated by the provided id
SelfServiceBrandingMacosApiV1SelfServiceBrandingMacosIdPutPut /v1/self-service/branding/macos/{id}Update a Self Service macOS branding configuration with the supplied details
SelfServiceBrandingMacosApiV1SelfServiceBrandingMacosPostPost /v1/self-service/branding/macosCreate a Self Service macOS branding configuration with the supplied
SelfServiceBrandingPreviewApiSelfServiceBrandingImagesPostPost /self-service/branding/imagesUpload an image
SitesPreviewApiSettingsSitesGetGet /settings/sitesFind all sites
SmartComputerGroupsPreviewApiV1ComputersIdRecalculateSmartGroupsPostPost /v1/computers/{id}/recalculate-smart-groupsRecalculate a smart group for the given id
SmartComputerGroupsPreviewApiV1SmartComputerGroupsIdRecalculatePostPost /v1/smart-computer-groups/{id}/recalculateRecalculate the smart group for the given id
SmartMobileDeviceGroupsPreviewApiV1MobileDevicesIdRecalculateSmartGroupsPostPost /v1/mobile-devices/{id}/recalculate-smart-groupsRecalculate all smart groups for the given device id and then return count of smart groups that device fall into
SmartMobileDeviceGroupsPreviewApiV1SmartMobileDeviceGroupsIdRecalculatePostPost /v1/smart-mobile-device-groups/{id}/recalculateRecalculate a smart group for the given id then return the ids for the devices in the smart group
SmartUserGroupsPreviewApiV1SmartUserGroupsIdRecalculatePostPost /v1/smart-user-groups/{id}/recalculateRecalculate the smart group for the given id and then return the ids for the users in the smart group
SmartUserGroupsPreviewApiV1UsersIdRecalculateSmartGroupsPostPost /v1/users/{id}/recalculate-smart-groupsRecalculate a smart group for the given user id and then return the count of smart groups the user falls into
SsoCertificateApiV2SsoCertDeleteDelete /v2/sso/certDelete the currently configured certificate used by SSO
SsoCertificateApiV2SsoCertDownloadGetGet /v2/sso/cert/downloadDownload the certificate currently configured for use with Jamf Pro's SSO configuration
SsoCertificateApiV2SsoCertGetGet /v2/sso/certRetrieve the certificate currently configured for use with SSO
SsoCertificateApiV2SsoCertParsePostPost /v2/sso/cert/parseParse the certificate to get details about certificate type and keys needed to upload certificate file
SsoCertificateApiV2SsoCertPostPost /v2/sso/certJamf Pro will generate a new certificate and use it to sign SSO
SsoCertificateApiV2SsoCertPutPut /v2/sso/certUpdate the certificate used by Jamf Pro to sign SSO requests to the identify provider
SsoCertificatePreviewApiV1SsoCertDeleteDelete /v1/sso/certDelete the currently configured certificate used by SSO
SsoCertificatePreviewApiV1SsoCertDownloadGetGet /v1/sso/cert/downloadDownload the certificate currently configured for use with Jamf Pro's SSO configuration
SsoCertificatePreviewApiV1SsoCertGetGet /v1/sso/certRetrieve the certificate currently configured for use with SSO
SsoCertificatePreviewApiV1SsoCertParsePostPost /v1/sso/cert/parseParse the certificate to get details about certificate type and keys needed to upload certificate file
SsoCertificatePreviewApiV1SsoCertPostPost /v1/sso/certJamf Pro will generate a new certificate and use it to sign SSO
SsoCertificatePreviewApiV1SsoCertPutPut /v1/sso/certUpdate the certificate used by Jamf Pro to sign SSO requests to the identify provider
SsoSettingsApiV1SsoDependenciesGetGet /v1/sso/dependenciesRetrieve the list of Enrollment Customizations using SSO
SsoSettingsApiV1SsoDisablePostPost /v1/sso/disableDisable SSO
SsoSettingsApiV1SsoGetGet /v1/ssoRetrieve the current Single Sign On configuration settings
SsoSettingsApiV1SsoHistoryGetGet /v1/sso/historyGet SSO history object
SsoSettingsApiV1SsoHistoryPostPost /v1/sso/historyAdd SSO history object notes
SsoSettingsApiV1SsoMetadataDownloadGetGet /v1/sso/metadata/downloadDownload the Jamf Pro SAML metadata file
SsoSettingsApiV1SsoPutPut /v1/ssoUpdates the current Single Sign On configuration settings
SsoSettingsApiV1SsoValidatePostPost /v1/sso/validateEndpoint for validation of a saml metadata url
StartupStatusApiStartupStatusGetGet /startup-statusRetrieve information about application startup
StaticUserGroupsPreviewApiV1StaticUserGroupsGetGet /v1/static-user-groupsReturn a list of all Static User Groups
StaticUserGroupsPreviewApiV1StaticUserGroupsIdGetGet /v1/static-user-groups/{id}Return a specific Static User Group by id
SupervisionIdentitiesPreviewApiV1SupervisionIdentitiesGetGet /v1/supervision-identitiesSearch for sorted and paged Supervision Identities
SupervisionIdentitiesPreviewApiV1SupervisionIdentitiesIdDeleteDelete /v1/supervision-identities/{id}Delete a Supervision Identity with the supplied id
SupervisionIdentitiesPreviewApiV1SupervisionIdentitiesIdDownloadGetGet /v1/supervision-identities/{id}/downloadDownload the Supervision Identity .p12 file
SupervisionIdentitiesPreviewApiV1SupervisionIdentitiesIdGetGet /v1/supervision-identities/{id}Retrieve a Supervision Identity with the supplied id
SupervisionIdentitiesPreviewApiV1SupervisionIdentitiesIdPutPut /v1/supervision-identities/{id}Update a Supervision Identity with the supplied information
SupervisionIdentitiesPreviewApiV1SupervisionIdentitiesPostPost /v1/supervision-identitiesCreate a Supervision Identity for the supplied information
SupervisionIdentitiesPreviewApiV1SupervisionIdentitiesUploadPostPost /v1/supervision-identities/uploadUpload the Supervision Identity .p12 file
TeacherAppApiV1TeacherAppGetGet /v1/teacher-appGet the Jamf Teacher settings that you have access to see
TeacherAppApiV1TeacherAppHistoryGetGet /v1/teacher-app/historyGet Jamf Teacher app settings history
TeacherAppApiV1TeacherAppHistoryPostPost /v1/teacher-app/historyAdd Jamf Teacher app settings history notes
TeacherAppApiV1TeacherAppPutPut /v1/teacher-appUpdate a Jamf Teacher settings object
TeamViewerRemoteAdministrationApiPreviewRemoteAdministrationConfigurationsTeamViewerConfigurationIdSessionsGetGet /preview/remote-administration-configurations/team-viewer/{configurationId}/sessionsGet a paginated list of sessions
TeamViewerRemoteAdministrationApiPreviewRemoteAdministrationConfigurationsTeamViewerConfigurationIdSessionsPostPost /preview/remote-administration-configurations/team-viewer/{configurationId}/sessionsCreate a new session
TeamViewerRemoteAdministrationApiPreviewRemoteAdministrationConfigurationsTeamViewerConfigurationIdSessionsSessionIdClosePostPost /preview/remote-administration-configurations/team-viewer/{configurationId}/sessions/{sessionId}/closeClose a session
TeamViewerRemoteAdministrationApiPreviewRemoteAdministrationConfigurationsTeamViewerConfigurationIdSessionsSessionIdGetGet /preview/remote-administration-configurations/team-viewer/{configurationId}/sessions/{sessionId}Get a session by its ID
TeamViewerRemoteAdministrationApiPreviewRemoteAdministrationConfigurationsTeamViewerConfigurationIdSessionsSessionIdResendNotificationPostPost /preview/remote-administration-configurations/team-viewer/{configurationId}/sessions/{sessionId}/resend-notificationResend nofications for a session
TeamViewerRemoteAdministrationApiPreviewRemoteAdministrationConfigurationsTeamViewerConfigurationIdSessionsSessionIdStatusGetGet /preview/remote-administration-configurations/team-viewer/{configurationId}/sessions/{sessionId}/statusGet a session status by its ID
TeamViewerRemoteAdministrationApiPreviewRemoteAdministrationConfigurationsTeamViewerIdDeleteDelete /preview/remote-administration-configurations/team-viewer/{id}Delete Team Viewer Remote Administration connection configuration
TeamViewerRemoteAdministrationApiPreviewRemoteAdministrationConfigurationsTeamViewerIdGetGet /preview/remote-administration-configurations/team-viewer/{id}Get Team Viewer Remote Administration connection configuration
TeamViewerRemoteAdministrationApiPreviewRemoteAdministrationConfigurationsTeamViewerIdPatchPatch /preview/remote-administration-configurations/team-viewer/{id}Update Team Viewer Remote Administration connection configuration
TeamViewerRemoteAdministrationApiPreviewRemoteAdministrationConfigurationsTeamViewerIdStatusGetGet /preview/remote-administration-configurations/team-viewer/{id}/statusGet Team Viewer Remote Administration connection status
TeamViewerRemoteAdministrationApiPreviewRemoteAdministrationConfigurationsTeamViewerPostPost /preview/remote-administration-configurations/team-viewerCreate Team Viewer Remote Administration connection configuration
TimeZonesPreviewApiV1TimeZonesGetGet /v1/time-zonesReturn information about the currently supported Time Zones
TomcatSettingsPreviewApiSettingsIssueTomcatSslCertificatePostPost /settings/issueTomcatSslCertificateGenerate a SSL Certificate using Jamf Certificate Authority
UserSessionPreviewApiUserGetGet /userReturn all Jamf Pro user acounts
UserSessionPreviewApiUserUpdateSessionPostPost /user/updateSessionUpdate values in the User's current session
VenafiPreviewApiV1PkiVenafiIdConnectionStatusGetGet /v1/pki/venafi/{id}/connection-statusTests the communication between Jamf Pro and a Jamf Pro PKI Proxy Server
VenafiPreviewApiV1PkiVenafiIdDeleteDelete /v1/pki/venafi/{id}Delete a Venafi PKI configuration from Jamf Pro
VenafiPreviewApiV1PkiVenafiIdDependentProfilesGetGet /v1/pki/venafi/{id}/dependent-profilesGet configuration profile data using specified Venafi CA object
VenafiPreviewApiV1PkiVenafiIdGetGet /v1/pki/venafi/{id}Retrieve a Venafi PKI configuration from Jamf Pro
VenafiPreviewApiV1PkiVenafiIdHistoryGetGet /v1/pki/venafi/{id}/historyGet specified Venafi CA history object
VenafiPreviewApiV1PkiVenafiIdHistoryPostPost /v1/pki/venafi/{id}/historyAdd specified Venafi CA Object Note
VenafiPreviewApiV1PkiVenafiIdJamfPublicKeyGetGet /v1/pki/venafi/{id}/jamf-public-keyDownloads a certificate used to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server
VenafiPreviewApiV1PkiVenafiIdJamfPublicKeyRegeneratePostPost /v1/pki/venafi/{id}/jamf-public-key/regenerateRegenerates a certificate used to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server
VenafiPreviewApiV1PkiVenafiIdPatchPatch /v1/pki/venafi/{id}Update a Venafi PKI configuration in Jamf Pro
VenafiPreviewApiV1PkiVenafiIdProxyTrustStoreDeleteDelete /v1/pki/venafi/{id}/proxy-trust-storeRemoves the PKI Proxy Server public key used to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server
VenafiPreviewApiV1PkiVenafiIdProxyTrustStoreGetGet /v1/pki/venafi/{id}/proxy-trust-storeDownloads the PKI Proxy Server public key to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server
VenafiPreviewApiV1PkiVenafiIdProxyTrustStorePostPost /v1/pki/venafi/{id}/proxy-trust-storeUploads the PKI Proxy Server public key to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server
VenafiPreviewApiV1PkiVenafiPostPost /v1/pki/venafiCreate a PKI configuration in Jamf Pro for Venafi
VolumePurchasingLocationsApiV1VolumePurchasingLocationsGetGet /v1/volume-purchasing-locationsRetrieve Volume Purchasing Locations
VolumePurchasingLocationsApiV1VolumePurchasingLocationsIdDeleteDelete /v1/volume-purchasing-locations/{id}Delete a Volume Purchasing Location with the supplied id
VolumePurchasingLocationsApiV1VolumePurchasingLocationsIdGetGet /v1/volume-purchasing-locations/{id}Retrieve a Volume Purchasing Location with the supplied id
VolumePurchasingLocationsApiV1VolumePurchasingLocationsIdHistoryGetGet /v1/volume-purchasing-locations/{id}/historyGet specified Volume Purchasing Location history object
VolumePurchasingLocationsApiV1VolumePurchasingLocationsIdPatchPatch /v1/volume-purchasing-locations/{id}Update a Volume Purchasing Location
VolumePurchasingLocationsApiV1VolumePurchasingLocationsIdReclaimPostPost /v1/volume-purchasing-locations/{id}/reclaimReclaim a Volume Purchasing Location with the supplied id
VolumePurchasingLocationsApiV1VolumePurchasingLocationsIdRevokeLicensesPostPost /v1/volume-purchasing-locations/{id}/revoke-licensesRevoke licenses for a Volume Purchasing Location with the supplied id
VolumePurchasingLocationsApiV1VolumePurchasingLocationsPostPost /v1/volume-purchasing-locationsCreate a Volume Purchasing Location
VolumePurchasingSubscriptionsApiV1VolumePurchasingSubscriptionsGetGet /v1/volume-purchasing-subscriptionsRetrieve Volume Purchasing Subscriptions
VolumePurchasingSubscriptionsApiV1VolumePurchasingSubscriptionsIdDeleteDelete /v1/volume-purchasing-subscriptions/{id}Delete a Volume Purchasing Subscription with the supplied id
VolumePurchasingSubscriptionsApiV1VolumePurchasingSubscriptionsIdGetGet /v1/volume-purchasing-subscriptions/{id}Retrieve a Volume Purchasing Subscription with the supplied id
VolumePurchasingSubscriptionsApiV1VolumePurchasingSubscriptionsIdPutPut /v1/volume-purchasing-subscriptions/{id}Update a Volume Purchasing Subscription
VolumePurchasingSubscriptionsApiV1VolumePurchasingSubscriptionsPostPost /v1/volume-purchasing-subscriptionsCreate a Volume Purchasing Subscription
VppAdminAccountsPreviewApiVppAdminAccountsGetGet /vpp/admin-accountsFound all VPP Admin Accounts
VppSubscriptionsPreviewApiVppSubscriptionsGetGet /vpp/subscriptionsFound all VPP - subscriptions
VppSubscriptionsPreviewApiVppSubscriptionsIdGetGet /vpp/subscriptions/{id}Found VPP subscription by id

Documentation For Models

Documentation For Authorization

BasicAuth

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Bearer

  • Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author