Append Content

Request

POST

https://api.wiki.yandex.net/v1/pages/{idx}/append-content

Path parameters

Name	Description
idx	Type: integer

Query parameters

Name

Description

fields

Type: string

Example: ``

is_silent

Type: boolean

Do not send a page update notification to subscribers

Default: false

Body

application/json

{
  "content": "example",
  "body": {
    "location": "top"
  },
  "section": {
    "id": 0,
    "location": null
  },
  "anchor": {
    "name": "example",
    "fallback": false,
    "regex": false
  }
}

Name	Description
content	Type: string Min length: `1` Example: `example`
anchor	Type: PageAppendContentAnchorSchema Example `{ "name": "example", "fallback": false, "regex": false }`
body	Type: PageAppendContentBodySchema Example `{ "location": "top" }`
section	Type: PageAppendContentSectionSchema Example `{ "id": 0, "location": "top" }`

Location

An enumeration.

Type: string

Enum: top, bottom

PageAppendContentBodySchema

Name

Description

location

Type: Location

An enumeration.

Enum: top, bottom

Example

{
  "location": "top"
}

PageAppendContentSectionSchema

Name

Description

Type: integer

location

Type: Location

An enumeration.

Enum: top, bottom

Example

{
  "id": 0,
  "location": "top"
}

PageAppendContentAnchorSchema

Name	Description
name	Type: string Example: `example`
fallback	Type: boolean Default: `false`
regex	Type: boolean Default: `false`

Example

{
  "name": "example",
  "fallback": false,
  "regex": false
}

Responses

200 OK

Body

application/json

{
  "id": 0,
  "slug": "example",
  "title": "example",
  "page_type": "page",
  "redirect": {
    "page_id": 0,
    "redirect_target": {
      "id": 0,
      "slug": "example",
      "title": "example",
      "page_type": null
    }
  },
  "breadcrumbs": [
    {
      "id": 0,
      "title": "example",
      "slug": "example",
      "page_exists": true
    }
  ],
  "attributes": {
    "created_at": "2025-01-01T00:00:00Z",
    "modified_at": "2025-01-01T00:00:00Z",
    "lang": "example",
    "is_readonly": true,
    "comments_count": 0,
    "comments_enabled": true,
    "keywords": [
      "example"
    ],
    "is_collaborative": true,
    "is_draft": true
  },
  "content": "example",
  "access_policy": {
    "access_type": "inherited",
    "inherited_access_type": "all_staff",
    "all_staff_role": "reader",
    "has_external": true,
    "invite": {
      "status": null
    }
  },
  "access_lists": {
    "direct": [
      {
        "id": "example",
        "created_at": "2025-01-01T00:00:00Z",
        "user": null,
        "group": null,
        "role": null,
        "inheritance": null
      }
    ],
    "by_link": [
      null
    ],
    "inherited": [
      null
    ]
  },
  "owner": {
    "user": {
      "id": 0,
      "identity": null,
      "username": "example",
      "display_name": "example",
      "is_dismissed": true,
      "affiliation": "example"
    },
    "group": {
      "id": "example",
      "identity": null,
      "name": "example",
      "type": null,
      "metadata": null,
      "members_count": 0
    }
  }
}

Name	Description
id	Type: integer Unique page identifier
page_type	Type: string Page type Enum: `page`, `grid`, `wysiwyg`, `template`
slug	Type: string Page address (slug) Example: `example`
title	Type: string Page title Example: `example`
access_lists	All of 1 type PageAccessListsSchema Type: PageAccessListsSchema Page access lists Example `{ "direct": [ { "id": "example", "created_at": "2025-01-01T00:00:00Z", "user": { "id": 0, "identity": null, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }, "group": { "id": "example", "identity": null, "name": "example", "type": null, "metadata": null, "members_count": 0 }, "role": "reader", "inheritance": "inherited" } ], "by_link": [ null ], "inherited": [ null ] }` Not returned by default Specify `access_lists` in the `?fields=access_lists, ...` list to include it in the response. The page access lists Example `{ "direct": [ { "id": "example", "created_at": "2025-01-01T00:00:00Z", "user": null, "group": null, "role": "reader", "inheritance": "inherited" } ], "by_link": [ null ], "inherited": [ null ] }`
access_policy	All of 1 type PageAccessPolicySchema Type: PageAccessPolicySchema Page access policy Example `{ "access_type": "inherited", "inherited_access_type": "all_staff", "all_staff_role": "reader", "has_external": true, "invite": { "status": 0 } }` Not returned by default Specify `access_policy` in the `?fields=access_policy, ...` list to include it in the response. The page access settings Example `{ "access_type": "inherited", "inherited_access_type": "all_staff", "all_staff_role": "reader", "has_external": true, "invite": { "status": 0 } }`
attributes	All of 1 type PageAttributesSchema Type: PageAttributesSchema Additional page attributes Example `{ "created_at": "2025-01-01T00:00:00Z", "modified_at": "2025-01-01T00:00:00Z", "lang": "example", "is_readonly": true, "comments_count": 0, "comments_enabled": true, "keywords": [ "example" ], "is_collaborative": true, "is_draft": true }` Not returned by default Specify `attributes` in the `?fields=attributes, ...` list to include it in the response. Example `{ "created_at": "2025-01-01T00:00:00Z", "modified_at": "2025-01-01T00:00:00Z", "lang": "example", "is_readonly": true, "comments_count": 0, "comments_enabled": true, "keywords": [ "example" ], "is_collaborative": true, "is_draft": true }`
breadcrumbs	Type: BreadcrumbSchema[] Not returned by default Specify `breadcrumbs` in the `?fields=breadcrumbs, ...` list to include it in the response. Example `[ { "id": 0, "title": "example", "slug": "example", "page_exists": true } ]`
content	Type: string Not returned by default Specify `content` in the `?fields=content, ...` list to include it in the response. The page content as a string. Example: `example`
owner	All of 1 type PageOwnerSchema Type: PageOwnerSchema Page owner Example `{ "user": { "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }, "group": { "id": "example", "identity": { "src": null, "id": "example" }, "name": "example", "type": "wiki", "metadata": { "url": "example", "externals_count": 0 }, "members_count": 0 } }` Not returned by default Specify `owner` in the `?fields=owner, ...` list to include it in the response. The page owner Example `{ "user": { "id": 0, "identity": null, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }, "group": { "id": "example", "identity": null, "name": "example", "type": "wiki", "metadata": {}, "members_count": 0 } }`
redirect	All of 1 type RedirectSchema Type: RedirectSchema Information about the page redirect Example `{ "page_id": 0, "redirect_target": { "id": 0, "slug": "example", "title": "example", "page_type": "page" } }` Not returned by default Specify `redirect` in the `?fields=redirect, ...` list to include it in the response. If no redirect is set, `null` is returned Example `{ "page_id": 0, "redirect_target": { "id": 0, "slug": "example", "title": "example", "page_type": "page" } }`

PageType

Page type:

page — a regular page
grid — a page with a table
cloud_page — a cloud page
wysiwyg — a page with the visual editor
template — a page template

Type: string

Enum: page, grid, cloud_page, wysiwyg, template

PageDetailsSchema

Brief information about the page

Name	Description
id	Type: integer Page ID
page_type	All of 1 type PageType Type: PageType Page type: `page` — a regular page `grid` — a page with a table `cloud_page` — a cloud page `wysiwyg` — a page with the visual editor `template` — a page template Enum: `page`, `grid`, `cloud_page`, `wysiwyg`, `template` Page type Example: `page`
slug	Type: string Page address (slug) Example: `example`
title	Type: string Page title Example: `example`

Example

{
  "id": 0,
  "slug": "example",
  "title": "example",
  "page_type": "page"
}

RedirectSchema

Information about the page redirect

Name

Description

page_id

Type: integer

The ID of the page that the current page redirects to.

redirect_target

All of 1 type

PageDetailsSchema

Type: PageDetailsSchema

Brief information about the page

Example

{
  "id": 0,
  "slug": "example",
  "title": "example",
  "page_type": "page"
}

For example, given a redirect chain A->B->C->D, for A, B, and C this will be page D

Example

{
  "id": 0,
  "slug": "example",
  "title": "example",
  "page_type": "page"
}

Example

{
  "page_id": 0,
  "redirect_target": {
    "id": 0,
    "slug": "example",
    "title": "example",
    "page_type": "page"
  }
}

BreadcrumbSchema

A breadcrumb item (navigation trail)

Name	Description
page_exists	Type: boolean Whether the page exists
slug	Type: string Page address (slug) Example: `example`
title	Type: string Page title Example: `example`
id	Type: integer Page ID (if the page exists)

Example

{
  "id": 0,
  "title": "example",
  "slug": "example",
  "page_exists": true
}

PageAttributesSchema

Additional page attributes

Name	Description
comments_count	Type: integer Number of comments on the page
comments_enabled	Type: boolean Comments are enabled
created_at	Type: string<date-time> Date and time the page was created Example: `2025-01-01T00:00:00Z`
is_readonly	Type: boolean The page is read-only
lang	Type: string Page language (for example, `ru`, `en`) Example: `example`
modified_at	Type: string<date-time> Date and time the page was last modified Example: `2025-01-01T00:00:00Z`
is_collaborative	Type: boolean Collaborative editing is enabled
is_draft	Type: boolean The page is a draft
keywords	Type: string[] Page keywords Example `[ "example" ]`

Example

{
  "created_at": "2025-01-01T00:00:00Z",
  "modified_at": "2025-01-01T00:00:00Z",
  "lang": "example",
  "is_readonly": true,
  "comments_count": 0,
  "comments_enabled": true,
  "keywords": [
    "example"
  ],
  "is_collaborative": true,
  "is_draft": true
}

PageAccessTypeAPI

Page access type:

inherited — inherited from the parent page
all_staff — access for all staff members
custom — personal accesses

Type: string

Enum: inherited, all_staff, custom

AccessTypeInheritedAPI

Inherited access type:

all_staff — access for all staff members
custom — personal accesses

Type: string

Enum: all_staff, custom

RoleAllStaffAPI

Role for "all staff members" access:

reader — read
editor — edit
extra_editor — extended editing (access management)

Type: string

Enum: reader, editor, extra_editor

PageInviteStatus

Invitation link status:

0 — deleted
1 — enabled
2 — disabled

Type: integer

Enum: 0, 1, 2

AclPreviewInviteSchema

Information about the invitation link for page access

Name

Description

status

All of 1 type

PageInviteStatus

Type: PageInviteStatus

Invitation link status:
- 0 — deleted
- 1 — enabled
- 2 — disabled
Enum: 0, 1, 2

Example: 0

Link status:

0 - deleted (not returned by the API)
1 - enabled
2 - disabled

Example: 0

Example

{
  "status": 0
}

PageAccessPolicySchema

Page access policy

Name	Description
access_type	All of 1 type PageAccessTypeAPI Type: PageAccessTypeAPI Page access type: `inherited` — inherited from the parent page `all_staff` — access for all staff members `custom` — personal accesses Enum: `inherited`, `all_staff`, `custom` Access type Example: `inherited`
all_staff_role	All of 1 type RoleAllStaffAPI Type: RoleAllStaffAPI Role for "all staff members" access: `reader` — read `editor` — edit `extra_editor` — extended editing (access management) Enum: `reader`, `editor`, `extra_editor` Role for "all staff members" access Example: `reader`
has_external	Type: boolean Indicates that the page is accessible to external consultants. If None, the status is unknown
inherited_access_type	All of 1 type AccessTypeInheritedAPI Type: AccessTypeInheritedAPI Inherited access type: `all_staff` — access for all staff members `custom` — personal accesses Enum: `all_staff`, `custom` Inherited access type Example: `all_staff`
invite	All of 1 type AclPreviewInviteSchema Type: AclPreviewInviteSchema Information about the invitation link for page access Example `{ "status": 0 }` Information about the invitation link for page access Example `{ "status": 0 }`

Example

{
  "access_type": "inherited",
  "inherited_access_type": "all_staff",
  "all_staff_role": "reader",
  "has_external": true,
  "invite": {
    "status": 0
  }
}

UserIdentity

User identifier

Name

Description

cloud_uid

Type: string

User identifier in the cloud (for the external instance)

Example: example

uid

Type: string

User identifier in Yandex (for the internal instance)

Example: example

Example

{
  "uid": "example",
  "cloud_uid": "example"
}

UserSchema

Information about the user

Name	Description
affiliation	Type: string User affiliation (for example, `yandex`, `external`) Example: `example`
display_name	Type: string User display name Example: `example`
id	Type: integer Internal user identifier
is_dismissed	Type: boolean The user has been dismissed
username	Type: string User login Example: `example`
identity	All of 1 type UserIdentity Type: UserIdentity User identifier Example `{ "uid": "example", "cloud_uid": "example" }` User identifier in the system Example `{ "uid": "example", "cloud_uid": "example" }`

Example

{
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}

ComSource

Group identifier source:

dir — IAM
cloud — Yandex Cloud
com — local database
staff — Staff (internal employee directory)

Type: string

Enum: dir, cloud, com, staff

ComIdentitySchema

Group identifier

Name

Description

Type: string

Group identifier in the specified source

Example: example

src

All of 1 type

ComSource

Type: ComSource

Group identifier source:
- dir — IAM
- cloud — Yandex Cloud
- com — local database
- staff — Staff (internal employee directory)
Enum: dir, cloud, com, staff

Identifier source

Example: dir

Example

{
  "src": "dir",
  "id": "example"
}

GroupType

Group type:

wiki — a Wiki group
service — a service group
servicerole — a service role
group — a regular group
department — a department

Type: string

Enum: wiki, service, servicerole, group, department

IntranetGroupMetadata

Group metadata from the internal directory

Name

Description

externals_count

Type: integer

Number of external consultants in the group

url

Type: string

Group URL in the directory

Example: example

Example

{
  "url": "example",
  "externals_count": 0
}

IamGroupMetadata

Group metadata from IAM (Identity and Access Management)

Name

Description

dir_id

Type: string

Directory identifier

Example: example

Example

{
  "dir_id": "example"
}

GroupSchema

Information about the group

Name	Description
identity	All of 1 type ComIdentitySchema Type: ComIdentitySchema Group identifier Example `{ "src": "dir", "id": "example" }` Group identifier in the system Example `{ "src": "dir", "id": "example" }`
name	Type: string Group name Example: `example`
type	All of 1 type GroupType Type: GroupType Group type: `wiki` — a Wiki group `service` — a service group `servicerole` — a service role `group` — a regular group `department` — a department Enum: `wiki`, `service`, `servicerole`, `group`, `department` Group type Example: `wiki`
id	Type: string Group identifier. For the external instance, dir_id; for the internal instance, staff_id Example: `example`
members_count	Type: integer Number of group members Default: `0`
metadata	Any of 2 types IntranetGroupMetadata Type: IntranetGroupMetadata Group metadata from the internal directory Example `{ "url": "example", "externals_count": 0 }` IamGroupMetadata Type: IamGroupMetadata Group metadata from IAM (Identity and Access Management) Example `{ "dir_id": "example" }` Additional group metadata Example `{ "url": "example", "externals_count": 0 }`

Example

{
  "id": "example",
  "identity": {
    "src": "dir",
    "id": "example"
  },
  "name": "example",
  "type": "wiki",
  "metadata": {
    "url": "example",
    "externals_count": 0
  },
  "members_count": 0
}

RoleAPI

Page access role:

reader — read
editor — edit
extra_editor — extended editing (access management)
author — author (full access)

Type: string

Enum: reader, editor, extra_editor, author

InheritanceAPI

Access inheritance for subpages:

inherited — access is inherited by subpages
not_inherited — access is not inherited by subpages

Type: string

Enum: inherited, not_inherited

PageAccessItem

A personal page access item

Name	Description
id	Type: string Unique access identifier Example: `example`
role	All of 1 type RoleAPI Type: RoleAPI Page access role: `reader` — read `editor` — edit `extra_editor` — extended editing (access management) `author` — author (full access) Enum: `reader`, `editor`, `extra_editor`, `author` Access role Example: `reader`
created_at	Type: string<date-time> Date and time the access was created Example: `2025-01-01T00:00:00Z`
group	All of 1 type GroupSchema Type: GroupSchema Information about the group Example `{ "id": "example", "identity": { "src": "dir", "id": "example" }, "name": "example", "type": "wiki", "metadata": { "url": "example", "externals_count": 0 }, "members_count": 0 }` The group the access is granted to (populated if the access is granted to a group) Example `{ "id": "example", "identity": { "src": "dir", "id": "example" }, "name": "example", "type": "wiki", "metadata": { "url": "example", "externals_count": 0 }, "members_count": 0 }`
inheritance	All of 1 type InheritanceAPI Type: InheritanceAPI Access inheritance for subpages: `inherited` — access is inherited by subpages `not_inherited` — access is not inherited by subpages Enum: `inherited`, `not_inherited` Access inheritance setting for subpages Example: `inherited`
user	All of 1 type UserSchema Type: UserSchema Information about the user Example `{ "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }` The user the access is granted to (populated if the access is granted to a user) Example `{ "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }`

Example

{
  "id": "example",
  "created_at": "2025-01-01T00:00:00Z",
  "user": {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  },
  "group": {
    "id": "example",
    "identity": {
      "src": null,
      "id": "example"
    },
    "name": "example",
    "type": "wiki",
    "metadata": {
      "url": "example",
      "externals_count": 0
    },
    "members_count": 0
  },
  "role": "reader",
  "inheritance": "inherited"
}

PageAccessListsSchema

Page access lists

Name	Description
by_link	Type: PageAccessItem[] Accesses via the invitation link Example `[ { "id": "example", "created_at": "2025-01-01T00:00:00Z", "user": { "id": 0, "identity": null, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }, "group": { "id": "example", "identity": null, "name": "example", "type": "wiki", "metadata": {}, "members_count": 0 }, "role": "reader", "inheritance": "inherited" } ]`
direct	Type: PageAccessItem[] Direct personal accesses to the page Example `[ { "id": "example", "created_at": "2025-01-01T00:00:00Z", "user": { "id": 0, "identity": null, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }, "group": { "id": "example", "identity": null, "name": "example", "type": "wiki", "metadata": {}, "members_count": 0 }, "role": "reader", "inheritance": "inherited" } ]`
inherited	Type: PageAccessItem[] Accesses inherited from parent pages Example `[ { "id": "example", "created_at": "2025-01-01T00:00:00Z", "user": { "id": 0, "identity": null, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }, "group": { "id": "example", "identity": null, "name": "example", "type": "wiki", "metadata": {}, "members_count": 0 }, "role": "reader", "inheritance": "inherited" } ]`

Example

{
  "direct": [
    {
      "id": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "user": {
        "id": 0,
        "identity": null,
        "username": "example",
        "display_name": "example",
        "is_dismissed": true,
        "affiliation": "example"
      },
      "group": {
        "id": "example",
        "identity": null,
        "name": "example",
        "type": null,
        "metadata": null,
        "members_count": 0
      },
      "role": "reader",
      "inheritance": "inherited"
    }
  ],
  "by_link": [
    null
  ],
  "inherited": [
    null
  ]
}

PageOwnerSchema

Page owner

Name

Description

group

All of 1 type

GroupSchema

Type: GroupSchema

Information about the group

Example

{
  "id": "example",
  "identity": {
    "src": "dir",
    "id": "example"
  },
  "name": "example",
  "type": "wiki",
  "metadata": {
    "url": "example",
    "externals_count": 0
  },
  "members_count": 0
}

(not implemented) The group that owns the page

Example

{
  "id": "example",
  "identity": {
    "src": "dir",
    "id": "example"
  },
  "name": "example",
  "type": "wiki",
  "metadata": {
    "url": "example",
    "externals_count": 0
  },
  "members_count": 0
}

user

All of 1 type

UserSchema

Type: UserSchema

Information about the user

Example

{
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}

The user who owns the page

Example

{
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}

Example

{
  "user": {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  },
  "group": {
    "id": "example",
    "identity": {
      "src": null,
      "id": "example"
    },
    "name": "example",
    "type": "wiki",
    "metadata": {
      "url": "example",
      "externals_count": 0
    },
    "members_count": 0
  }
}

Was the article helpful?

Page Grids

Get Page Descendants