OPopen-policy-agent
Data API

Update a document

This API endpoint updates an existing document on the server by describing the changes required (using JSON patch operations)

patch/v1/data/{path}

Request

Request body

op'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test' required

JSON patch operation type

pathstring required

A JSON pointer to a location within the target document where the operation is performed.

The effective path is this value prefixed with the API call's path parameter.

The server will return a bad request (404) response if:

  • The parent of the effective path does not refer to an existing document
  • For remove and replace operations, the effective path does not refer to an existing document.
valueobject

The value to add, replace or test.

Example request

[
  {
    "op": "add",
    "path": "-"
  }
]

Response

Success

Changes

No recorded changes to this operation across all 6 revisions of this API.