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

# Create a DockItem


Creates a DockItem

> 📋 **Required privilege:** Create Dock Items

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Jamf Pro API",
    "termsOfService": "https://www.jamf.com/developer-resources/api-license-agreement",
    "version": "11.32.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/dock-items": {
      "post": {
        "tags": [
          "dock-items"
        ],
        "summary": "Create a DockItem\n",
        "description": "Creates a DockItem\n\n> 📋 **Required privilege:** Create Dock Items",
        "requestBody": {
          "description": "new DockItem to create. ids defined in this body will be ignored",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DockItem"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "DockItem created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HrefResponse"
                }
              }
            }
          },
          "409": {
            "description": "Duplicate",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        },
        "x-required-privileges": [
          "Create Dock Items"
        ]
      }
    }
  },
  "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"
          }
        }
      },
      "DockItem": {
        "required": [
          "name",
          "path",
          "type"
        ],
        "type": "object",
        "properties": {
          "id": {
            "minimum": 1,
            "type": "string",
            "readOnly": true,
            "example": "1"
          },
          "name": {
            "type": "string",
            "example": "DockItem Name"
          },
          "type": {
            "type": "string",
            "example": "FILE",
            "enum": [
              "APP",
              "FILE",
              "FOLDER"
            ]
          },
          "path": {
            "type": "string",
            "example": "file://localhost/Applications/iTunes.app"
          },
          "contents": {
            "type": "string",
            "readOnly": true,
            "example": "<dict><key>GUID</key><integer>-91117049</integer><key>tile-data</key><dict><key>file-data</key><dict><key>_CFURLString</key><string>file://localhost/Applications/iTunes.app</string><key>_CFURLStringType</key><integer>15</integer></dict><key>file-label</key><string>MyDockItem2</string></dict><key>tile-type</key><string>directory-tile</string></dict>"
          }
        }
      },
      "HrefResponse": {
        "type": "object",
        "properties": {
          "id": {
            "minLength": 1,
            "type": "string",
            "example": "1"
          },
          "href": {
            "type": "string",
            "example": "https://yourJamfProUrl.jamf/api/v1/resource/1"
          }
        }
      }
    },
    "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": {}
          }
        }
      }
    }
  }
}
```