Add a New Software Title Definition

Note

If you are creating a definition file for the first time, you can use the Patch-Starter-Script available on GitHub.

The examples provided below will reference this script.

POST /api/v1/titles

Create a new patch definition. The JSON payload should contain the data for the full patch definition.

POST /api/v1/titles
Content-Type: application/json

{
    "id": "",
    "name": "",
    "publisher": "",
    "appName": "",
    "bundleId": "",
    "requirements": [],
    "patches": [],
    "extensionAttributes": []
}

Response

On success you will receive a message stating the new title has been created.

201 Created
Content-Type: application/json

{
    "message": "Title '{ID}' created"
}

Examples

An example using curl and Patch-Starter-Script:

curl https://beta2.communitypatch.com/api/v1/titles \
    -X POST \
    -d "$(python patchstarter.py '/Applications/{APP}' -p '{PUBLISHER}')" \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer {API-KEY}'