GuidesRecipesAPI ReferenceChangelog
Log In
API Reference

Update specific fields on a cloud distribution point

patch
https://yourServer.jamfcloud.com/api/v1/cloud-distribution-point

Update specific fields on a cloud distribution point, then return the updated cloud distribution point details object.

Body Params
string
enum
required
Defaults to NONE

Specifies the content delivery network (CDN) used to distribute content for the cloud distribution point.

Allowed:
boolean
Defaults to false

Use as principal distribution point. Use as the authoritative source for all files.
Possible values are:
false
true

string
required

The username or access key used for authenticating with the selected content delivery network (CDN). This field is required when the cdnType is set to Rackspace Cloud Files(RACKSPACE_CLOUD_FILES), Amazon Web Services(AMAZON_S3), or Akamai(AKAMAI), as it is used to authenticate and authorize access to the respective cloud services.

  • For Rackspace Cloud Files(RACKSPACE_CLOUD_FILES), this is typically the username associated with your Rackspace cloud account.
  • For Amazon Web Services(AMAZON_S3), this corresponds to the Access Key ID used to interact with Amazon Web Services(AMAZON_S3) resources.
  • For Akamai(AKAMAI), this is the username used for API authentication to access Akamai's content delivery services. If the cdnType is None, this field is not applicable.
password
required

The password or authentication key used for connecting to the selected content delivery network (CDN). This field is required when the cdnType is set to Rackspace Cloud Files(RACKSPACE_CLOUD_FILES), Amazon Web Services(AMAZON_S3), or Akamai(AKAMAI), and is used to authenticate and authorize access to the respective cloud services.

  • For Rackspace Cloud Files(RACKSPACE_CLOUD_FILES), this refers to the API Key that is used in conjunction with the username for authenticating API requests.
  • For Amazon Web Services(AMAZON_S3), this corresponds to the Secret Access Key associated with your AWS account, used to securely sign requests to AWS services.
  • For Akamai(AKAMAI), this is the password used for API authentication to access Akamai's content delivery services. If the cdnType is None, this field is not applicable.
string

The directory or path for content delivery in Akamai. This field is required when the cdnType is set to Akamai(AKAMAI) and specifies where content is stored within Akamai's system.

string

The URL used to upload files to Akamai's NetStorage. This field is required when the cdnType is set to Akamai(AKAMAI). It specifies where content should be uploaded to Akamai’s cloud storage before being distributed via their CDN. The upload typically uses FTP or SFTP.

string

The URL used to access and download content from Akamai's EdgeSuite. This field is required when the cdnType is set to Akamai(AKAMAI). It specifies the endpoint from which files are retrieved by devices or users.

boolean
Defaults to false

Enable Remote Authentication.Authorize requests for files stored on the distribution point. This field is required when the cdnType is set to Akamai(AKAMAI).
Possible values are:
false
true

integer
Defaults to 200

Secondary Auth Status Code. Configure the HTTP response code that will be returned by Jamf Pro during remote authentication. This field is required when the cdnType is set to Akamai(AKAMAI) and secondaryAuthRequired is true.

integer
≥ 1
Defaults to 3600

Secondary Auth Time To Live. Number of seconds before the authorization token expires. This field is required when the cdnType is set to Akamai(AKAMAI) and secondaryAuthRequired is true.

boolean
Defaults to false

Amazon Sign Url. It restrict access to requests that use a signed URL. This field is required when the cdnType is set to Amazon Web Services(AMAZON_S3).
Possible values are:
false
true

string

The CloudFront Access Key ID (keyPairId) is part of the credentials used to generate signed URLs for secure access to content in a CloudFront distribution. When using AWS, this key is paired with the CloudFront Secret Access Key to create the signed URL, ensuring that only authorized users can access specific content within a specified timeframe. This field is required when the cdnType is set to Amazon Web Services(AMAZON_S3) and requireSignedUrls is true.

integer
≥ 1
Defaults to 3600

Signed URL Expiration. Number of seconds before the signed URL expires, This field is required when the cdnType is set to Amazon Web Services(AMAZON_S3) and requireSignedUrls is true.

string

The CloudFront Private Key file is required when the cdnType is set to Amazon Web Services(AMAZON_S3) and requireSignedUrls parameter is enabled. This private key is used for signing URLs for restricted access to CloudFront-distributed content. The private key allows secure URL generation for signed URLs, ensuring that only authorized users can access certain content. The key must be uploaded in one of the following formats:

  • .pem: A Privacy-Enhanced Mail (PEM) file containing the private key in base64 encoded format.
  • .der: A Distinguished Encoding Rules (DER) encoded file, which is a binary format for the private key. The uploaded file should be kept secure, as it provides the ability to generate signed URLs with access to protected content.
Responses

Updated 2 months ago

Language
Credentials
Response 
 Choose an example:
application/json
Updated 2 months ago