---
updatedAt: 2026-06-15T13:51:20.000Z
agentTools:
  siteIndex: https://developer.jamf.com/llms.txt
  projectIndex: https://developer.jamf.com/jamf-pro/llms.txt
---

# Register a Jamf Protect API configuration with Jamf Pro

Register a Jamf Protect API configuration with Jamf Pro

> 📋 **Required privilege:** Update Jamf Protect Settings

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Jamf Pro API",
    "termsOfService": "https://www.jamf.com/developer-resources/api-license-agreement",
    "version": "11.33.0"
  },
  "servers": [
    {
      "url": "https://yourServer.jamfcloud.com/api"
    }
  ],
  "x-readme": {
    "samples-languages": [
      "curl",
      "swift",
      "ruby",
      "python"
    ],
    "explorer-enabled": false
  },
  "security": [
    {
      "Bearer": []
    },
    {
      "ApiClient": []
    },
    {
      "BasicAuth": [
        "/v1/auth/token"
      ]
    }
  ],
  "paths": {
    "/v1/jamf-protect/register": {
      "post": {
        "tags": [
          "jamf-protect"
        ],
        "summary": "Register a Jamf Protect API configuration with Jamf Pro",
        "description": "Register a Jamf Protect API configuration with Jamf Pro\n\n> 📋 **Required privilege:** Update Jamf Protect Settings",
        "requestBody": {
          "description": "Jamf Protect API connection information",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProtectRegistrationRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Successful registration.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProtectSettingsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Cloud Services Connection has not been established.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "x-required-privileges": [
          "Update Jamf Protect Settings"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ApiError": {
        "type": "object",
        "properties": {
          "httpStatus": {
            "type": "integer",
            "description": "HTTP status of the response",
            "example": 400
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ApiErrorCause"
            }
          }
        }
      },
      "ApiErrorCause": {
        "required": [
          "field"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Error-specific code that can be used to identify localization string, etc.",
            "example": "8675309"
          },
          "field": {
            "type": "string",
            "description": "Name of the field that caused the error.",
            "example": "Name"
          },
          "description": {
            "type": "string",
            "description": "A general description of error for troubleshooting/debugging. Generally this text should not be displayed to a user; instead refer to errorCode and it's localized text",
            "example": "I've just picked up a fault in the AE35 unit. It's going to go 100% failure in 72 hours"
          },
          "id": {
            "type": "string",
            "description": "id of object with error. Optional.",
            "nullable": true,
            "example": "3"
          }
        }
      },
      "ProtectRegistrationRequest": {
        "required": [
          "clientId",
          "password",
          "protectUrl"
        ],
        "type": "object",
        "properties": {
          "protectUrl": {
            "type": "string",
            "example": "https://examplejamfprotect.jamfcloud.com/graphql"
          },
          "clientId": {
            "type": "string",
            "example": "uzPJXlArmzTAmPRQtZEnQ2OFtNw8qQV"
          },
          "password": {
            "type": "string",
            "format": "password",
            "writeOnly": true,
            "example": "7fyP6BphUUQ5B_zoLrkYhM5j1HTcf-4PxshettZbK0ZcnzV57gyHwF23U3F96F"
          }
        },
        "description": "Create an API Client in the Jamf Protect web console to obtain these values."
      },
      "ProtectSettingsResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": false,
            "example": "1"
          },
          "apiClientId": {
            "type": "string",
            "example": "esgzYzYBqN7wCImwyusbQcXob2qalGMN"
          },
          "apiClientName": {
            "type": "string",
            "description": "display name used when creating the API Client in the Jamf Protect web console",
            "example": "Jamf Pro integration"
          },
          "registrationId": {
            "type": "string",
            "description": "ID used when making requests to identify this particular Protect registration.",
            "example": "6f250316-2cfb-4521-8cb7-bfaf46497bc5"
          },
          "protectUrl": {
            "type": "string",
            "example": "https://examplejamfprotect.jamfcloud.com/graphql"
          },
          "platformPlanSync": {
            "type": "boolean",
            "description": "determines whether Protect Platform Plan syncing is enabled",
            "example": true
          },
          "lastSyncTime": {
            "type": "string",
            "example": "2003-01-05T18:00:14.885Z"
          },
          "syncStatus": {
            "type": "string",
            "example": "COMPLETED",
            "enum": [
              "IN_PROGRESS",
              "COMPLETED",
              "ERROR",
              "UNKNOWN"
            ]
          },
          "autoInstall": {
            "type": "boolean",
            "description": "determines whether the Jamf Protect agent will be automatically installed on client computers",
            "example": true
          }
        }
      }
    },
    "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": {}
          }
        }
      }
    }
  }
}
```