Giter VIP home page Giter VIP logo

jnuc-2023's Introduction

API endpoints

These endpoints allow you to interact with Jamf Pro App Installers and their deployments programmatically.

GET

/v1/app-installers/titles/
/v1/app-installers/titles/{TITLE_ID}
/v1/app-installers/deployments
/v1/app-installers/deployments/{DEPLOYMENT_ID}
/v1/app-installers/deployments/{DEPLOYMENT_ID}/computers
/v1/app-installers/deployments/{DEPLOYMENT_ID}/installation-summary

POST

/v1/app-installers/deployments
/v1/app-installers/deployments/{DEPLOYMENT_ID}/computers/installation-retry
/v1/app-installers/deployments/{DEPLOYMENT_ID}/computers/{COMPUTER_ID}/installation-retry

GET /v1/app-installers/titles/

Get all available App Instalers from the Jamf Pro App Catalog.

Response

{
    "totalCount": integer,
    "results": [
        {
            "id": string,
            "bundleId": string,
            "titleName": string,
            "publisher": string,
            "iconUrl": string,
            "version": string
        },
        ...
    ]
}

GET /v1/app-installers/titles/{TITLE_ID}

Get details for a particular App Installer by supplying its ID.

Parameters

Name Required Type Description
TITLE_ID true string Can be retrieved using /v1/app-installers/titles/

Response

{
    "id": string,
    "bundleId": string,
    "titleName": string,
    "publisher": string,
    "iconUrl": string,
    "version": string,
    "sizeInBytes": integer,
    "minimumOsVersion": string,
    "language": string,
    "availabilityDate": string,
    "packageSigningIdentity": string,
    "installerPackageHashType": string,
    "installerPackageHash": string,
    "shortVersion": string,
    "architecture": string,
    "originalMediaSources": [
        {
        "hashType": string,
        "hash": string,
        "url": string
        }
    ],
    "launchDaemonIncluded": boolean,
    "notificationAvailable": boolean,
    "suppressAutoUpdate": boolean
    }

GET /v1/app-installers/deployments/

Get all deployed App Installers (enabled or not) from your Jamf Pro instance.

Response

{
    "totalCount": integer,
    "results": [
        {
            "id": string,
            "name": string,
            "enabled": boolean,
            "selectedVersion": string,
            "latestVersion": string,
            "deploymentType": string,
            "updateBehavior": string,
            "site": {
                "id": string,
                "name": string
            },
            "smartGroup": {
                "id": string,
                "name": string
            },
            "category": {
                "id": string,
                "name": string
            },
            "computerStatuses": {
                "installed": integer,
                "available": integer,
                "inProgress": integer,
                "failed": integer,
                "unqualified": integer
            },
            "bundleId": string
        },
        ...
    ]
}

GET /v1/app-installers/deployments/{DEPLOYMENT_ID}

Get details for a particular App Installer deployment by supplying the corresponding deployment ID.

Parameters

Name Required Type Description
DEPLOYMENT_ID true string Can be retrieved using /v1/app-installers/deployments/

Response

        {
            "id": string,
            "name": string,
            "enabled": boolean,
            "appTitleId": string,
            "deploymentType": string,
            "updateBehavior": string,
            "siteId": string,
            "smartGroupId": string,
            "installPredefinedConfigProfiles": string,
            "titleAvailableInAis": boolean
            "notificationSettings": {
                "notificationMessage": string,
                "notificationInterval": integer,
                "deadlineMessage": string,
                "deadline": string,
                "quitDelay": string,
                "completeMessage": string,
                "relaunch": boolean
            },
            "selfServiceSettings": {
                "includeInFeaturedCategory": boolean,
                "includeInComplianceCategory": boolean,
                "forceViewDescription": boolean,
                "description": string,
                "categories": [
                {
                    "id": string,
                    "featured": boolean
                }
                ]
            },
            "selectedVersion": string,
            "latestAvailableVersion": string
        }

GET /v1/app-installers/deployments/{DEPLOYMENT_ID}/computers

Get a system-level summary for a particular App Installer deployment.

Parameters

Name Required Type Description
DEPLOYMENT_ID true string Can be retrieved using /v1/app-installers/deployments/

Response

{
    "totalCount": integer,
    "results": [
    {
        "id": string,
        "status": string,
        "error": string,
        "retryable": boolean,
        "computerName": string
    }
    ]
}

GET /v1/app-installers/deployments/{DEPLOYMENT_ID}/installation-summary

Get the installation summary for a particular App Installer deployment.

Parameters

Name Required Type Description
DEPLOYMENT_ID true string Can be retrieved using /v1/app-installers/deployments/

Response

{
    "installed": integer,
    "available": integer,
    "inProgress": integer,
    "failed": integer,
    "unqualified": integer
}

POST /v1/app-installers/deployments

Create a new App Installer deployment.

Payload

{
  "name": "string,
  "enabled": boolean,
  "appTitleId": string,
  "siteId": string,
  "categoryId": string,
  "smartGroupId": string,
  "deploymentType": string // Example: "INSTALL_AUTOMATICALLY",
  "updateBehavior": string // Example: "AUTOMATIC",
  "notificationSettings": {
    "notificationMessage": string,
    "notificationInterval": integer,
    "deadlineMessage": string,
    "deadline": integer,
    "quitDelay": integer,
    "completeMessage": string,
    "relaunch": boolean
  },
  "installPredefinedConfigProfiles": boolean
}

Response

// Status 200 indicates successful creation of a new App Installer deployment.

POST /v1/app-installers/deployments/{DEPLOYMENT_ID}/computers/installation-retry

Issue a RETRY for failed App Installer installations for a deployment by providing its ID.

Parameters

Name Required Type Description
DEPLOYMENT_ID true string Can be retrieved using /v1/app-installers/deployments/

Response

// Status 204 indicates successful retry submission

POST /v1/app-installers/deployments/{DEPLOYMENT_ID}/computers/{COMPUTER_ID}/installation-retry

Retry a failed App Installer installation for a single system.

Parameters

Name Required Type Description
DEPLOYMENT_ID true string Can be retrieved using /v1/app-installers/deployments/
COMPUTER_ID true string ID used to identify Computer in Jamf Pro.

Response

// Status 204 indicates successful retry submission

jnuc-2023's People

Contributors

tyler-tee avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.