Sign in
Manage projects and library content

Changed on

(Re)Deploy a form

Deploy a new form or re-deploy an existing one.

post/api/v2/assets/{uid_asset}/deployment/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

uid_assetstring required

Request body

activeboolean required

Response

backendstring required
activeboolean required
version_idstring required

Example response

{
  "asset": {
    "url": "https://kf.kobotoolbox.org/api/v2/assets/aBeA23YCYjkGTFvYVHuAyU/",
    "owner": "https://kf.kobotoolbox.org/api/v2/users/bob/",
    "parent": "https://kf.kobotoolbox.org/api/v2/assets/a3C9wWefqZVkChNLKqqXVZ/",
    "deployed_versions": {
      "results": [
        {
          "url": "https://kf.kobotoolbox.org/api/v2/assets/aBeA23YCYjkGTFvYVHuAyU/versions/vBeA23YCYjkGTFvYVHuAyU/"
        }
      ]
    },
    "xform_link": "https://kf.kobotoolbox.org/api/v2/assets/aBeA23YCYjkGTFvYVHuAyU/xform/",
    "hooks_link": "https://kf.kobotoolbox.org/api/v2/assets/aBeA23YCYjkGTFvYVHuAyU/hooks/",
    "xls_link": "https://kf.kobotoolbox.org/api/v2/assets/aBeA23YCYjkGTFvYVHuAyU.xls",
    "exports": "https://kf.kobotoolbox.org/api/v2/assets/aBeA23YCYjkGTFvYVHuAyU/exports/",
    "data": "https://kf.kobotoolbox.org/api/v2/assets/aBeA23YCYjkGTFvYVHuAyU/data/",
    "paired_data": "https://kf.kobotoolbox.org/api/v2/assets/aBeA23YCYjkGTFvYVHuAyU/paired-data/"
  }
}

Changes

  • v27f81278fee5aRevision changes
    • breaking

      the response property /// became nullable for the status

  • v241cb6ede9360Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status