Update specified distribution point object

patch

https://{region}.api.jamfcloud.com/pro/v1/distribution-points/{id}

Updates the specified object configuration of a File Share Distribution Point in Jamf Pro. ID path parameter is mandatory and other fields can be updated as a whole or with minimal object.

Required Permissions: distribution-points:read, distribution-points:update

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

id

string

required

Instance id of distribution point

Body Params

distribution point object to update.

name

string

required

serverName

string

required

principal

boolean

Defaults to false

backupDistributionPointId

string

Defaults to -1

sshUsername

string

sshPassword

password

localPathToShare

string

fileSharingConnectionType

string

enum

required

Defaults to NONE

Specify the type of connection , Either of fileSharingConnectionType (or) https connection type needs to be enabled using httpsEnabled for a distribution point to be created.

Allowed:

shareName

string

Required if fileSharingConnectionType is either AFP (or) SMB

workgroup

string

port

integer

Defaults to 139

Required if fileSharingConnectionType is either AFP (or) SMB

readWriteUsername

string

Required if fileSharingConnectionType is either AFP (or) SMB

readWritePassword

password

Required if fileSharingConnectionType is either AFP (or) SMB

readOnlyUsername

string

Required if fileSharingConnectionType is either AFP (or) SMB

readOnlyPassword

password

Required if fileSharingConnectionType is either AFP (or) SMB

httpsEnabled

boolean

Defaults to false

Allow downloads over HTTPS - requires installation of a valid SSL certificate

httpsPort

integer

Defaults to 443

Port number of the server - required if HTTPS enabled

httpsContext

string

Path to the share (e.g. if the share is accessible at http://192.168.10.10/JamfShare, the context is "JamfShare") - required if HTTPS enabled

httpsSecurityType

string

enum

Defaults to NONE

Type of authentication required to download files from the distribution point - required if HTTPS enabled

Allowed:

httpsUsername

string

Required if httpsSecurityType is USERNAME_PASSWORD

httpsPassword

password

Required if httpsSecurityType is USERNAME_PASSWORD

enableLoadBalancing

boolean

Defaults to false

This is used to configure load balancing on the backup distribution point. Cannot be enabled when the backup distribution point configured is cloud.

Headers

X-Tenant-Id

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.

X-Environment-Id

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

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json