Apply redactions

POST/v1/docs/{docId}/layers/{layerName}/redactions/applyv3.0.0-next.15

Apply pending redactions, permanently removing content.

Authentication#

Any one of these credentials is accepted.

API token

The deployment's static root credential (CLOUDPDF_API_AUTH_TOKENS), valid on every surface.

Document token

Doc-scoped JWT, valid only on the /v1/docs/{docId} subtree it names, gated by the capability scopes it carries (each operation's x-required-capability).

Document capabilitydoc.pages.modifydoc.annotate.modifydoc.redact

Parameters#

docIdpathstringrequired

layerNamepathstringrequired

X-Document-Passwordheaderstring

Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

Idempotency-Keyheaderstring

Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.

Request body#

application/jsonDocRedactionsApplyRequestrequired

pagesPageRef[]

kind"objectNumber"required

objectNumberintegerrequired

annotationsAnnotationRef[]

kind =

kind"objectNumber"required

pagePageRefrequired

kind"objectNumber"required

objectNumberintegerrequired

A complete body for each shape. Strings stand in for your own values.

{
  "pages": [
    {
      "kind": "objectNumber",
      "objectNumber": 1
    }
  ],
  "annotations": {
    "kind": "objectNumber",
    "page": {
      "kind": "objectNumber",
      "objectNumber": 1
    },
    "objectNumber": 1
  }
}

SDK examples#

The selected SDK is remembered across the API reference. Values are examples; replace them with identifiers and input from your application.

import { CloudPDFClient } from "@cloudpdf/sdk";

const client = new CloudPDFClient({
  baseUrl: "https://yourhost.com/path/to/api",
  token: "<token>",
});

await client.doc.redactions.apply({
  docId: "docId",
  layerName: "layerName"
});

Responses#

200OK

application/jsonDocRedactionsApply200Response

scopeobject

pagesPageRef[]optional

kind"objectNumber"

objectNumberinteger

annotationsAnnotationRef[]optional

kind =

kind"objectNumber"

pagePageRef

kind"objectNumber"

objectNumberinteger

resultsobject[]

pagePageRef

kind"objectNumber"

objectNumberinteger

status"applied" | "unchanged"

removedAnnotationCountinteger

metaMutationMeta

affectedPagesPageRef[]

kind"objectNumber"

objectNumberinteger

cacheDeltaCacheDelta

opIdstring

undoableboolean

400Bad request

application/jsonDocRedactionsApply400Response

404Not found

application/jsonDocRedactionsApply404Response

defaultError

application/jsonEngineErrorPayload

name"EngineError"

messagestring

detailsobjectoptional