PATCH Method

The PATCH HTTP method is used to modify the values of the resource properties.

The PATCH HTTP method requires a request body. The body of the request must contain representation of the JSON Patch operations that you want to perform on the resource. For details on available operations and structure of a request body, see RFC 6902.

For example, the following request changes the name of a reseller.

Request:

PATCH https://localhost:1280/api/v3/organizations/resellers/debcdb55-afbd-4772-bf99-5ea6a3249f43

 

Request Header:

Authorization: Bearer <Access-Token>

Content-Type: application/json

 

Request Body:

{

  "op": "replace",

  "path": "/name",

  "value": "Alpha"

}

Some operations that are performed using the POST HTTP method can also be performed using the PATCH HTTP method. For example, the following request runs a job.

Request:

PATCH https://<hostname>:1280/api/v3/infrastructure/backupServers/jobs/14513169-46c6-4ee1-9619-f218ada245a9

 

Request Header:

Authorization: Bearer <Access-Token>

Content-Type: application/json

 

Request Body:

{

  "op": "replace",

  "path": "/status",

  "value": "Running"

}

In case of success, the PATCH HTTP method returns the 200 OK response code.

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.