Projects

Enabling Project Managed Encryption

Changed on

(introduced: version 0.6)

Project Managed Encryption can be enabled via the API. To do this, POST with the passphrase and optionally a reminder hint about the passphrase. If managed encryption is already enabled, a 409 error response will be returned.

Enabling managed encryption will modify all unencrypted forms in the project, and as a result the version of all forms within the project will also be modified. It is therefore best to enable managed encryption before devices are in the field. Any forms in the project that already have self-supplied encryption keys will be left alone.

post/v1/projects/{id}/key

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/projects/{id}/key
  • Auth
    none declared

Path parameters

idnumber required

The numeric ID of the Project

Request body */*

passphrasestring required

The encryption passphrase. If this passphrase is lost, the data will be irrecoverable.

hintstring

A reminder about the passphrase. This is primarily useful when multiple encryption keys and passphrases are being used, to tell them apart.

Example request

{
  "passphrase": "super duper secret",
  "hint": "it was a secret"
}

Response

OK

idnumber

The numerical ID of the Project.

namestring required

The name of the Project.

descriptionstring

The description of the Project, which is rendered as Markdown on Frontend.

keyIdnumber

If managed encryption is enabled on the project, the numeric ID of the encryption key as tracked by Central is given here.

archivedboolean

Whether the Project is archived or not. null is equivalent to false. All this does is sort the Project to the bottom of the list and disable management features in the web management application.

Changes