---
updatedAt: 2025-09-15T07:18:23.000Z
agentTools:
  siteIndex: https://developer.jamf.com/llms.txt
  projectIndex: https://developer.jamf.com/jamf-pro/v11.14.0/llms.txt
---

# Get the Cloud Distribution Point test connection details.

Verifies the connection to the Cloud Distribution Point after updating its configuration. 
This endpoint returns the connection status and a message indicating whether the connection is successful or failed.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Jamf Pro API",
    "termsOfService": "https://www.jamf.com/developer-resources/api-license-agreement",
    "version": "11.14.0"
  },
  "servers": [
    {
      "url": "https://yourServer.jamfcloud.com/api"
    }
  ],
  "x-readme": {
    "samples-languages": [
      "curl",
      "swift",
      "ruby",
      "python"
    ],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "security": [
    {
      "Bearer": []
    },
    {
      "ApiClient": []
    },
    {
      "BasicAuth": [
        "/v1/auth/token"
      ]
    }
  ],
  "paths": {
    "/v1/cloud-distribution-point/test-connection": {
      "get": {
        "tags": [
          "cloud-distribution-point"
        ],
        "summary": "Get the Cloud Distribution Point test connection details.\n",
        "description": "Verifies the connection to the Cloud Distribution Point after updating its configuration. \nThis endpoint returns the connection status and a message indicating whether the connection is successful or failed.\n",
        "responses": {
          "200": {
            "description": "This response indicates the test connection of the Cloud Distribution Point (CDP). \nThe response includes the following details:\n   - **hasConnectionSucceeded**: A status indicating whether the connection test was successful or failed. \n        This will be either `true` or `false`, based on the outcome of the connection test.\n   - **message**: A detailed message providing additional context regarding the test result. \n        For example, if the connection failed, the message might contain an error description.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CloudDistributionPointTestConnection"
                }
              }
            }
          }
        },
        "x-required-privileges": [
          "Read Cloud Distribution Point"
        ],
        "x-authentication-required": true
      }
    }
  },
  "components": {
    "schemas": {
      "CloudDistributionPointTestConnection": {
        "required": [
          "hasConnectionSucceeded",
          "message"
        ],
        "type": "object",
        "properties": {
          "hasConnectionSucceeded": {
            "type": "boolean",
            "description": "Indicates whether the connection to the Cloud Distribution Point was successful. \nIf `true`, the connection was successful. If `false`, the connection failed.<br/>\nPossible values are:<br/>\nfalse <br/>\ntrue\n",
            "example": false,
            "default": false
          },
          "message": {
            "type": "string",
            "description": "A message detailing the result of the connection test. This could be a success message\nor an error message if the connection failed.\n",
            "example": "Cannot contact JCDS"
          }
        }
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "BasicAuth": {
        "type": "http",
        "description": "Basic auth is used only for obtaining bearer tokens from the /v1/auth/token endpoint",
        "scheme": "basic"
      },
      "ApiClient": {
        "type": "oauth2",
        "description": "Jamf Pro API Roles and Clients provide a client ID and secret for obtaining access tokens using the OAuth2 client_credentials grant type",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "/api/v1/oauth/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "x-si-base": "swagger.json",
  "x-github-repo": "jamf/Jamf-Pro-API-Schema",
  "x-github-sha": "5f8b85a61ce288205f7b44d478a117fb1acea0c6"
}
```