Class RedactionsService

See

https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-redactions

Hierarchy

  • CommonHttpService
    • RedactionsService

Constructors

constructor

Methods

postRedactBlog postRedactPage initialize

Constructors

constructor

  • new RedactionsService(getClientInstance): RedactionsService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns RedactionsService

Methods

postRedactBlog

  • postRedactBlog(params): Promise<RedactionResponse>

  • Redacts sensitive content in a Confluence blog post by replacing specified text ranges with redaction markers. Each redaction in the response includes a unique UUID for restoration (except code block redactions). The response metadata items maintain the same order as the input redaction pointers, and completely overlapping redactions are merged into a single redaction with one UUID.

    Note: This endpoint requires Atlassian Guard Premium.

    Parameters

    • params: {
          id: number;
          requestBody: {
              body?: {
                  redactions?: RedactionPointer[];
              } & {
                  [key: string]: unknown;
              };
              cleanHistory?: null | boolean;
              createdAt: string;
              title?: {
                  redactions?: RedactionPointer[];
              } & {
                  [key: string]: unknown;
              };
              versionNumber?: null | number;
          } & {
              [key: string]: unknown;
          };
      }
      • id: number

        The ID of the blog post to redact content from.

      • requestBody: {
            body?: {
                redactions?: RedactionPointer[];
            } & {
                [key: string]: unknown;
            };
            cleanHistory?: null | boolean;
            createdAt: string;
            title?: {
                redactions?: RedactionPointer[];
            } & {
                [key: string]: unknown;
            };
            versionNumber?: null | number;
        } & {
            [key: string]: unknown;
        }

    Returns Promise<RedactionResponse>

    Redaction Accepted. The response contains details about the redactions that were applied.

    Path

    POST /blogposts/{id}/redact @scopes-current write:page:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-redactions#api-blogposts-id-redact-post

postRedactPage

  • postRedactPage(params): Promise<RedactionResponse>

  • Redacts sensitive content in a Confluence page by replacing specified text ranges with redaction markers. Each redaction in the response includes a unique UUID for restoration (except code block redactions). The response metadata items maintain the same order as the input redaction pointers, and completely overlapping redactions are merged into a single redaction with one UUID.

    Note: This endpoint requires Atlassian Guard Premium.

    Parameters

    • params: {
          id: number;
          requestBody: {
              body?: {
                  redactions?: RedactionPointer[];
              } & {
                  [key: string]: unknown;
              };
              cleanHistory?: null | boolean;
              createdAt: string;
              title?: {
                  redactions?: RedactionPointer[];
              } & {
                  [key: string]: unknown;
              };
              versionNumber?: null | number;
          } & {
              [key: string]: unknown;
          };
      }
      • id: number

        The ID of the page to redact content from.

      • requestBody: {
            body?: {
                redactions?: RedactionPointer[];
            } & {
                [key: string]: unknown;
            };
            cleanHistory?: null | boolean;
            createdAt: string;
            title?: {
                redactions?: RedactionPointer[];
            } & {
                [key: string]: unknown;
            };
            versionNumber?: null | number;
        } & {
            [key: string]: unknown;
        }

    Returns Promise<RedactionResponse>

    Redaction Accepted. The response contains details about the redactions that were applied.

    Path

    POST /pages/{id}/redact @scopes-current write:page:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-redactions#api-pages-id-redact-post

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods