Wikis

Use this API to manage group wikis. An API for project wikis is also available.

Comments on a wiki page are called notes. To interact with them, use the notes API.

List all wiki pages for a group

GET /api/v4/groups/{id}/wikis

Lists all wiki pages for a specified group.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the group or project
`with_content` Query	Boolean	If `true`, includes the content of each wiki page Default: `false`

Responses

Code	Description	Schema
`200`	OK	Array of APIEntitiesWikiPageBasic
`400`	Bad Request	—
`404`	Not found	—

Create a wiki page for a group

POST /api/v4/groups/{id}/wikis

Creates a wiki page for a specified group. Requests can define the title, slug, and content.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the group or project

Request body (application/json)

Property	Type	Description
`content` Required	String	Content of the wiki page
`format`	String	Format of the wiki page Allowed values: `markdown`, `rdoc`, `asciidoc`, `org` Default: `markdown`
`front_matter`	Object	YAML front matter of the wiki page
`front_matter.title`	String	Title in the front matter of the wiki page
`title` Required	String	Title of the wiki page

Responses

Code	Description	Schema
`201`	Created	APIEntitiesWikiPage
`400`	Validation error	—
`404`	Not found	—
`422`	Unprocessable entity	—

Upload an attachment to a group wiki

POST /api/v4/groups/{id}/wikis/attachments

Uploads a file to the uploads directory in a specified group wiki.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the group or project

Request body (multipart/form-data)

Property	Type	Description
`branch`	String	The name of the branch
`file` Required	String (binary)	The attachment file to be uploaded

Responses

Code	Description	Schema
`201`	Created	APIEntitiesWikiAttachment
`400`	Bad Request	—
`404`	Not found	—

Retrieve a wiki page for a group

GET /api/v4/groups/{id}/wikis/{slug}

Retrieves a specified wiki page for a group.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the group or project
`slug` Path, required	String	URL-encoded slug of the wiki page, a unique string such as `dir%2Fpage_name`
`version` Query	String	Version SHA of the wiki page
`render_html` Query	Boolean	If `true`, returns the rendered HTML of the wiki page Default: `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesWikiPage
`400`	Bad Request	—
`404`	Not found	—

Update a wiki page for a group

PUT /api/v4/groups/{id}/wikis/{slug}

Updates a specified wiki page for a group.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the group or project
`slug` Path, required	String	URL-encoded slug of the wiki page, a unique string such as `dir%2Fpage_name`

Request body (application/json)

Property	Type	Description
`content`	String	Content of the wiki page. At least one of `content`, `title`, `format` must be provided
`format`	String	Format of the wiki page. At least one of `content`, `title`, `format` must be provided Allowed values: `markdown`, `rdoc`, `asciidoc`, `org` Default: `markdown`
`front_matter`	Object	YAML front matter of the wiki page
`front_matter.title`	String	Title in the front matter of the wiki page
`title`	String	Title of the wiki page. At least one of `content`, `title`, `format` must be provided

Responses

Code	Description	Schema
`200`	OK	APIEntitiesWikiPage
`400`	Validation error	—
`404`	Not found	—
`422`	Unprocessable entity	—

Delete a wiki page for a group

DELETE /api/v4/groups/{id}/wikis/{slug}

Deletes a specified wiki page from a group.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the group or project
`slug` Path, required	String	URL-encoded slug of the wiki page, a unique string such as `dir%2Fpage_name`

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Validation error	—
`404`	Not found	—

List all wiki pages for a project

GET /api/v4/projects/{id}/wikis

Lists all wiki pages for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the group or project
`with_content` Query	Boolean	If `true`, includes the content of each wiki page Default: `false`

Responses

Code	Description	Schema
`200`	OK	Array of APIEntitiesWikiPageBasic
`400`	Bad Request	—
`404`	Not found	—

Create a wiki page for a project

POST /api/v4/projects/{id}/wikis

Creates a wiki page for a specified project. Requests can define the title, slug, and content.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the group or project

Request body (application/json)

Property	Type	Description
`content` Required	String	Content of the wiki page
`format`	String	Format of the wiki page Allowed values: `markdown`, `rdoc`, `asciidoc`, `org` Default: `markdown`
`front_matter`	Object	YAML front matter of the wiki page
`front_matter.title`	String	Title in the front matter of the wiki page
`title` Required	String	Title of the wiki page

Responses

Code	Description	Schema
`201`	Created	APIEntitiesWikiPage
`400`	Validation error	—
`404`	Not found	—
`422`	Unprocessable entity	—

Upload an attachment to a project wiki

POST /api/v4/projects/{id}/wikis/attachments

Uploads a file to the uploads directory in a specified project wiki.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the group or project

Request body (multipart/form-data)

Property	Type	Description
`branch`	String	The name of the branch
`file` Required	String (binary)	The attachment file to be uploaded

Responses

Code	Description	Schema
`201`	Created	APIEntitiesWikiAttachment
`400`	Bad Request	—
`404`	Not found	—

Retrieve a wiki page for a project

GET /api/v4/projects/{id}/wikis/{slug}

Retrieves a specified wiki page for a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the group or project
`slug` Path, required	String	URL-encoded slug of the wiki page, a unique string such as `dir%2Fpage_name`
`version` Query	String	Version SHA of the wiki page
`render_html` Query	Boolean	If `true`, returns the rendered HTML of the wiki page Default: `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesWikiPage
`400`	Bad Request	—
`404`	Not found	—

Update a wiki page for a project

PUT /api/v4/projects/{id}/wikis/{slug}

Updates a specified wiki page for a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the group or project
`slug` Path, required	String	URL-encoded slug of the wiki page, a unique string such as `dir%2Fpage_name`

Request body (application/json)

Property	Type	Description
`content`	String	Content of the wiki page. At least one of `content`, `title`, `format` must be provided
`format`	String	Format of the wiki page. At least one of `content`, `title`, `format` must be provided Allowed values: `markdown`, `rdoc`, `asciidoc`, `org` Default: `markdown`
`front_matter`	Object	YAML front matter of the wiki page
`front_matter.title`	String	Title in the front matter of the wiki page
`title`	String	Title of the wiki page. At least one of `content`, `title`, `format` must be provided

Responses

Code	Description	Schema
`200`	OK	APIEntitiesWikiPage
`400`	Validation error	—
`404`	Not found	—
`422`	Unprocessable entity	—

Delete a wiki page for a project

DELETE /api/v4/projects/{id}/wikis/{slug}

Deletes a specified wiki page from a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the group or project
`slug` Path, required	String	URL-encoded slug of the wiki page, a unique string such as `dir%2Fpage_name`

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Validation error	—
`404`	Not found	—

Schemas

Objects returned by the operations above and objects nested in their request bodies.

APIEntitiesWikiAttachment

Property	Type	Description
`branch`	String	Example: `main`
`file_name`	String	Example: `dk.png`
`file_path`	String	Example: `uploads/6a061c4cf9f1c28cb22c384b4b8d4e3c/dk.png`
`link`	Object	—
`link.markdown`	String	Example: `![dk](uploads/6a061c4cf9f1c28cb22c384b4b8d4e3c/dk.png)`
`link.url`	String	Example: `uploads/6a061c4cf9f1c28cb22c384b4b8d4e3c/dk.png`

APIEntitiesWikiPage

Property	Type	Description
`content`	String	Example: `Here is an instruction how to deploy this project.`
`encoding`	String	Example: `UTF-8`
`format`	String	Example: `markdown`
`front_matter`	Object	Example: `{"title":"deploy"}`
`slug`	String	Example: `deploy`
`title`	String	Example: `deploy`
`wiki_page_meta_id`	Integer (int64)	Example: `123`

APIEntitiesWikiPageBasic

Property	Type	Description
`format`	String	Example: `markdown`
`slug`	String	Example: `deploy`
`title`	String	Example: `deploy`
`wiki_page_meta_id`	Integer (int64)	Example: `123`

List all wiki pages for a group

Create a wiki page for a group

Upload an attachment to a group wiki

Retrieve a wiki page for a group

Update a wiki page for a group

Delete a wiki page for a group

List all wiki pages for a project

Create a wiki page for a project

Upload an attachment to a project wiki

Retrieve a wiki page for a project

Update a wiki page for a project

Delete a wiki page for a project

Schemas

APIEntitiesWikiAttachment

APIEntitiesWikiPage

APIEntitiesWikiPageBasic

Request trial access

Thank you

Error

Request callback

Thank you

Something went wrong

Book your sessions

Thank you

Error

Request demo

Thank you

Error

Get the PCI SSC compliance report

Thank you

Error

Request partner program details

Request received

Error