Skip to main content
Table of contents

Application: hmrc-manuals-api

API for HMRC to publish manuals to GOV.UK


#govuk-platform-health owns the application and is responsible for updating its dependencies.


The production version of this application is hosted on AWS.

SSH Access (AWS)

gds govuk connect ssh -e integration backend
gds govuk connect ssh -e staging aws/backend
gds govuk connect ssh -e production aws/backend

Run a rake task

Relevant manual pages

Example pages published by hmrc-manuals-api


Warning The content below is pulled in directly from the repository.
Links might not function properly.

This app provides URLs for pushing HMRC manuals to the GOV.UK Publishing API.


Adding a new slug

Before adding a new manual through the api, the slug for the manual must be added to /config/initializers/known_manual_slugs.rb and the application re-deployed.

The workflow for this is likely to be initiated by a zendesk ticket raised by HMRC with the new slug. A developer can then add the slug and re-deploy the application and inform HMRC that the slug is ready to be published against.

Technical documentation

Provides an API for a system built by HMRC to publish tax manuals onto GOV.UK. In many ways it is analogous to a backend/admin app for publishing on GOV.UK. Content which passes validation and checks for unsanitary content is submitted to the GOV.UK Publishing API application. The application does not have a database itself. An HMRC manual consists of two document types: the manual itself and manual sections.

See the extended documentation for details:


Running the application


This runs bundle install to install dependencies and runs the app on port 3071.

When using the GOV.UK development VM use bowl hmrc-manuals-api in the Dev VM development directory. The app will be available at

Running the test suite

bundle exec rake

Any deviations from idiomatic Rails/Go etc.

The application does not have a database itself, it sends on requests to the Publishing API.

Example API output

Responses to PUT requests


MIT License