API Reference

Create a new App Installer deployment

post
https://{region}.api.jamfcloud.com/pro/v1/app-installers/deployments

Create a new App Installer deployment. The deployment has a specific app version and might be scoped to a smart group.

Required Permissions: applications:create

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

app installer to create

string
required
length between 1 and 255

Human readable name of the deployment

boolean
Defaults to false

Is deployment active or is it a draft.

string
required

ID of app titles to be deployed

string
enum
required

Defines the 'deployment type' for an App Title.

  • INSTALL_AUTOMATICALLY - the app will be installed as soon as possible
  • SELF_SERVICE - the app will be available in Self Service where user can decide if the app should be installed
Allowed:
string
enum
required

Strategy for app updates.

  • MANUAL - the app will not get automatic updates without admin interaction
  • AUTOMATIC - the app will get automatic updates
Allowed:
string
Defaults to -1

A site that this deployment should be assigned to, '-1' means no assigment

string
Defaults to -1

A category that this deployment should be assigned to, '-1' means no assignment

string
Defaults to -1

A smart group to which the app should be deployed. Default value, which means that the app installer will not be deployed, will be used if it is set to null and deployment is not active

boolean
Defaults to false

Determines whether the predefined configuration profiles will be automatically installed on client computers

boolean
Defaults to false

Determines whether events related to this deployment will trigger admin notifications

notificationSettings
object | null

Computer notification settings for running app with pending update; Settings are used only if version of the app supports notifications

selfServiceSettings
object | null

Self Service settings to be used when deployment type is set to SELF_SERVICE

Headers
uuid
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The tenant UUID identifier. Send it to address tenant scope. This API is also published at environment scope — send that scope's header instead. Send exactly one scope header per request.

uuid
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The environment UUID identifier. Send it to address environment scope. This API is also published at tenant scope — send that scope's header instead. Send exactly one scope header per request.

Responses

Updated 10 days ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 10 days ago

Did this page help you?