Retrieve the full configuration details of a CalDAV payload item

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

To get Caldav policy payload item

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/caldavpolicy/payloaditems/{payload_id}

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

payload_idstringMandatory

Unique identifier of the payload item. Obtain from the Get Payload Item IDs response

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/caldavpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
payload_idlong

Unique identifier of the payload item

account_namestring

Account Name

account_hostnamestring

Account Hostname

account_portinteger

Account Port. Default: 8843

principal_urlstring

Principal Url

account_usernamestring

Account Username

account_passwordstring

Account Password (sensitive - write-only)

account_password_idlong

Account Password Id

use_sslboolean

Use Ssl. Default: true

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of CalDAV payload item

Copied!
  {
    "payload_id": 9007199254741000,
    "account_hostname": "https://zylker.com",
    "account_password": "********",
    "principal_url": "https://zylker.com",
    "use_ssl": true,
    "account_name": "Zylker User",
    "account_username": "Zylker User",
    "account_password_id": 1,
    "account_port": 8843
  }
                
Show full

Duration: 1 minute | Threshold: 120 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.