DHIS2 Api/v1 API

The api/v1 API from DHIS2 — 12 operation(s) for api/v1.

GitHub OpenAPI

Operations 16

GET /api/v1/apps Get api V1Apps #
POST /api/v1/apps Post api V1Apps #
GET /api/v1/apps/all Get api V1Apps all #
GET /api/v1/apps/myapps Get api V1Apps myapps #
GET /api/v1/apps/{appId} Get api V1Apps appid #
DELETE /api/v1/apps/{appId} Delete api V1Apps appid #
PUT /api/v1/apps/{appId} Put api V1Apps appid #
GET /api/v1/apps/download/{organisation_slug}/{appver_slug}_{app_version}.zip Get api V1Apps download organisation slug appver slug app versionzip #
GET /api/v1/apps/media/{organisation_slug}/{app_id}/{app_media_id} Get api V1Apps media organisation slug app id app media id #
POST /api/v1/apps/{appId}/images Post api V1Apps appid images #
POST /api/v1/apps/{appId}/approval Post api V1Apps appid approval #
POST /api/v1/apps/{appId}/versions Post api V1Apps appid versions #
DELETE /api/v1/apps/{appId}/images/{appMediaId} Delete api V1Apps appid images appmediaid #
DELETE /api/v1/apps/{appId}/versions/{versionId} Delete api V1Apps appid versions versionid #
PUT /api/v1/apps/{appId}/versions/{versionId} Put api V1Apps appid versions versionid #
PUT /api/v1/apps/{appId}/images/{mediaId} Put api V1Apps appid images mediaid #

Specifications

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/dhis2:dhis2-api-v1-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

dhis2-api-v1-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: DHIS-2 App Hub API Documentation Api/v1 API
  version: 0.0.1
  description: .
servers:
- url: https://apps.dhis2.org/
tags:
- name: api/v1
paths:
  /api/v1/apps:
    get:
      operationId: getApiV1Apps
      tags:
      - api/v1
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model4'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: string
      summary: Get api V1Apps
      x-summary-source: derived
    post:
      operationId: postApiV1Apps
      tags:
      - api/v1
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                app:
                  type: string
                logo:
                  type: string
                file:
                  type: string
      summary: Post api V1Apps
      x-summary-source: derived
  /api/v1/apps/all:
    get:
      operationId: getApiV1AppsAll
      tags:
      - api/v1
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model6'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: string
      summary: Get api V1Apps all
      x-summary-source: derived
  /api/v1/apps/myapps:
    get:
      operationId: getApiV1AppsMyapps
      tags:
      - api/v1
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model7'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: string
      summary: Get api V1Apps myapps
      x-summary-source: derived
  /api/v1/apps/{appId}:
    get:
      operationId: getApiV1AppsAppid
      tags:
      - api/v1
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model3'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: string
      summary: Get api V1Apps appid
      x-summary-source: derived
    delete:
      operationId: deleteApiV1AppsAppid
      tags:
      - api/v1
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: string
      summary: Delete api V1Apps appid
      x-summary-source: derived
    put:
      operationId: putApiV1AppsAppid
      tags:
      - api/v1
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model15'
      summary: Put api V1Apps appid
      x-summary-source: derived
  /api/v1/apps/download/{organisation_slug}/{appver_slug}_{app_version}.zip:
    get:
      operationId: getApiV1AppsDownloadOrganisation_slugAppver_slug_app_versionzip
      tags:
      - api/v1
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      summary: Get api V1Apps download organisation slug appver slug app versionzip
      x-summary-source: derived
  /api/v1/apps/media/{organisation_slug}/{app_id}/{app_media_id}:
    get:
      operationId: getApiV1AppsMediaOrganisation_slugApp_idApp_media_id
      tags:
      - api/v1
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      summary: Get api V1Apps media organisation slug app id app media id
      x-summary-source: derived
  /api/v1/apps/{appId}/images:
    post:
      operationId: postApiV1AppsAppidImages
      tags:
      - api/v1
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      summary: Post api V1Apps appid images
      x-summary-source: derived
  /api/v1/apps/{appId}/approval:
    post:
      operationId: postApiV1AppsAppidApproval
      tags:
      - api/v1
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: string
      summary: Post api V1Apps appid approval
      x-summary-source: derived
  /api/v1/apps/{appId}/versions:
    post:
      operationId: postApiV1AppsAppidVersions
      tags:
      - api/v1
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                version:
                  type: string
                file:
                  type: string
      summary: Post api V1Apps appid versions
      x-summary-source: derived
  /api/v1/apps/{appId}/images/{appMediaId}:
    delete:
      operationId: deleteApiV1AppsAppidImagesAppmediaid
      tags:
      - api/v1
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      summary: Delete api V1Apps appid images appmediaid
      x-summary-source: derived
  /api/v1/apps/{appId}/versions/{versionId}:
    delete:
      operationId: deleteApiV1AppsAppidVersionsVersionid
      tags:
      - api/v1
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      summary: Delete api V1Apps appid versions versionid
      x-summary-source: derived
    put:
      operationId: putApiV1AppsAppidVersionsVersionid
      tags:
      - api/v1
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model17'
      summary: Put api V1Apps appid versions versionid
      x-summary-source: derived
  /api/v1/apps/{appId}/images/{mediaId}:
    put:
      operationId: putApiV1AppsAppidImagesMediaid
      tags:
      - api/v1
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      summary: Put api V1Apps appid images mediaid
      x-summary-source: derived
components:
  schemas:
    status:
      type: string
      enum:
      - PENDING
      - NOT_APPROVED
      - APPROVED
    Model17:
      type: object
      properties:
        demoUrl:
          type: string
          x-format:
            uri: true
        changeSummary:
          type: string
        version:
          type: string
        minDhisVersion:
          type: string
        maxDhisVersion:
          type: string
        channel:
          type: string
      required:
      - minDhisVersion
      - maxDhisVersion
    Model7:
      type: array
      items:
        $ref: '#/components/schemas/Model3'
    developer:
      type: object
      properties:
        address:
          type: string
        email:
          type: string
          x-format:
            email: true
        organisation:
          type: string
        organisation_slug:
          type: string
    Model6:
      type: array
      items:
        $ref: '#/components/schemas/Model3'
    Model3:
      type: object
      properties:
        appType:
          $ref: '#/components/schemas/appType'
        created:
          type: number
        description:
          type: string
        coreApp:
          type: boolean
        developer:
          $ref: '#/components/schemas/developer'
        images:
          $ref: '#/components/schemas/images'
        id:
          type: string
          x-format:
            guid: true
        lastUpdated:
          type: number
        name:
          type: string
          maxLength: 255
        owner:
          type: string
        reviews:
          $ref: '#/components/schemas/reviews'
        sourceUrl:
          type: string
          x-format:
            uri: true
        status:
          $ref: '#/components/schemas/status'
        versions:
          $ref: '#/components/schemas/versions'
        hasPlugin:
          type: boolean
          enum:
          - false
        hasChangelog:
          type: boolean
          enum:
          - false
        pluginType:
          type: string
        userCanEditApp:
          type: boolean
          enum:
          - false
      required:
      - appType
      - developer
      - images
      - id
      - name
      - owner
      - reviews
      - status
    Model1:
      type: object
      properties:
        caption:
          type: string
        created:
          type: number
        description:
          type: string
        id:
          type: string
        imageUrl:
          type: string
          x-format:
            uri: true
        lastUpdated:
          type: number
        logo:
          type: boolean
      required:
      - created
    Model14:
      type: object
      properties:
        address:
          type: string
        email:
          type: string
          x-format:
            email: true
        name:
          type: string
        organisation:
          type: string
    Model15:
      type: object
      properties:
        appType:
          $ref: '#/components/schemas/appType'
        description:
          type: string
        developer:
          $ref: '#/components/schemas/Model14'
        name:
          type: string
          maxLength: 100
        sourceUrl:
          type: string
        coreApp:
          type: boolean
    Model4:
      type: array
      items:
        $ref: '#/components/schemas/Model3'
    appType:
      type: string
      enum:
      - APP
      - DASHBOARD_WIDGET
      - TRACKER_DASHBOARD_WIDGET
    versions:
      type: array
      minItems: 1
      items:
        $ref: '#/components/schemas/Model2'
    images:
      type: array
      items:
        $ref: '#/components/schemas/Model1'
    Model2:
      type: object
      properties:
        version:
          type: string
        minDhisVersion:
          type: string
        maxDhisVersion:
          type: string
        lastUpdated:
          type: number
        created:
          type: number
        id:
          type: string
          x-format:
            guid:
              version: uuidv4
        downloadUrl:
          type: string
          x-format:
            uri: true
        demoUrl:
          type: string
          x-format:
            uri: true
        changeSummary:
          type: string
        channel:
          type: string
      required:
      - version
      - minDhisVersion
      - id
      - channel
    reviews:
      type: array
      items:
        type: string
x-alt-definitions:
  pager:
    type: object
    properties:
      page:
        type: number
      pageCount:
        type: number
      pageSize:
        type: number
      total:
        type: number
  status:
    type: string
    enum:
    - PENDING
    - NOT_APPROVED
    - APPROVED
  AppVersion:
    type: object
    properties:
      id:
        type: string
        x-format:
          guid:
            version: uuidv4
      updatedAt:
        type: string
        format: date
      createdAt:
        type: string
        format: date
      appId:
        type: string
        x-format:
          guid:
            version: uuidv4
      version:
        type: string
      channel:
        type: string
      demoUrl:
        type: string
        x-format:
          uri: true
      changeSummary:
        type: string
      downloadUrl:
        type: string
        x-format:
          uri: true
      downloadCount:
        type: number
        x-constraint:
          greater: -1
      minDhisVersion:
        type: string
      maxDhisVersion:
        type: string
      slug:
        type: string
      status:
        $ref: '#/x-alt-definitions/status'
      hasChangelog:
        type: boolean
    required:
    - channel
    - minDhisVersion
  result:
    type: array
    items:
      $ref: '#/x-alt-definitions/AppVersion'
  Model1:
    type: object
    properties:
      pager:
        $ref: '#/x-alt-definitions/pager'
      result:
        $ref: '#/x-alt-definitions/result'