CKAN API

openapi: 3.1.0
info:
  title: CKAN API
  version: '2026-10-13'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-13: 7 operation(s) read from 6 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; CKAN has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 12
    documentation: -5
    pages-with-code: 6
    pages-read: 6
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-13'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.ckan.org/en/2.12/api/index.html
  - https://docs.ckan.org/en/2.12/api/legacy-api.html
  - https://docs.ckan.org/en/2.12/maintaining/filestore.html
  - https://docs.ckan.org/en/2.12/maintaining/datastore.html
  - https://docs.ckan.org/en/2.12/extensions/remote-config-update.html
  - https://docs.ckan.org/en/2.12/contributing/test.html
servers:
- url: http://demo.ckan.org
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://docs.ckan.org/en/2.12/api/index.html
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https : // demo . ckan . org / api / 3 / action / group_list \n Alternatively, for Python users, we recommend using the\
          \ ckanapi \nlibrary which provides a simpler and more robust way to interact with CKAN APIs.\nTo install it, run: \n pip install ckanapi\
          \ \n Then you can make the same API call with just a few lines of Python code: \n from ckanapi import RemoteCKAN \n ckan = RemoteCKAN\
          \ ( 'https://demo"
  /api/3/action/{actionid}:
    get:
      operationId: get_api_3_action_actionid
      tags:
      - Api
      summary: GET /api/3/action/am_following_user
      x-source: https://docs.ckan.org/en/2.12/api/index.html
      parameters:
      - name: actionid
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -H \"Authorization: XXX\" https://demo.ckan.org/api/3/action/am_following_user?id=markw\n (Replacing XXX with your API\
          \ token.) \n Or, to get the list of activities from your user dashboard on demo.ckan.org,\nrun this Python code: \n from ckanapi import\
          \ RemoteCKAN "
        collapsed_from: 5 example path(s) differing only at actionId
  /api/action/{actionid}:
    get:
      operationId: get_api_action_actionid
      tags:
      - Api
      summary: GET /api/action/package_search
      x-source: https://docs.ckan.org/en/2.12/api/index.html
      parameters:
      - name: actionid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiActionActionidResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl: curl 'http://demo.ckan.org/api/action/package_search?facet.field=\\[\"tags\"\\]&facet.limit=10&rows=0' \n ckanapi: ckanapi\
          \ -r http://demo.ckan.org action package_search facet.field='[\"tags\"]' facet.limit=10 rows=0 \n All datasets that have tag ‘economy’:\
          \ \n browser: http://demo.ckan.org/api/3/action/package_search?fq=tags:economy "
        collapsed_from: 3 example path(s) differing only at actionId
  /api/search/dataset:
    get:
      operationId: get_api_search_dataset
      tags:
      - Api
      summary: GET /api/search/dataset
      x-source: https://docs.ckan.org/en/2.12/api/legacy-api.html
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiSearchDatasetResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl 'http://thedatahub.org/api/search/dataset?qjson=\\{\"author\":\"The%20Stationery%20Office %20Li mited\"\\}' \n Revision\
          \ Parameters \n Param-Key \n Param-Value \n Example \n Notes \n since_time \n Date-Time \n since_time=2010-05-05T19:42:45.854533 \n\
          \ The time can be less precisely\nstated (e.g 2010-05-05). \n since_id \n Uuid \n since_id=6c9f32ef-1f93-4b2f-891b-fd01924ebe08 \n The\
          \ stated id will not be\nincluded i"
  /solr/admin:
    get:
      operationId: get_solr_admin
      tags:
      - Solr
      summary: GET /solr/admin
      x-source: https://docs.ckan.org/en/2.12/contributing/test.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl - s 'http://127.0.0.1:8983/solr/admin/' | grep SolrHome \n Configure Solr with the new core by editing solr.xml . The ‘cores’\
          \ section will have one ‘core’ in it already and needs the second one ‘ckan’ added so it looks like this: \n < cores adminPath = \"\
          /admin/cores\" defaultCoreName = \"collection1\" > \n < core name = \"collection1\" instanceDir = \".\" /> \n < core name = \"ckan\"\
          \ instanceDir = \"/etc/s"
  /solr/admin/:
    get:
      operationId: get_solr_admin
      tags:
      - Solr
      summary: Configure Solr Multi-core
      x-source: https://docs.ckan.org/en/2.12/contributing/test.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /solr/admin/cores:
    get:
      operationId: get_solr_admin_cores
      tags:
      - Solr
      summary: GET /solr/admin/cores
      x-source: https://docs.ckan.org/en/2.12/contributing/test.html
      parameters:
      - name: action
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl - s 'http://127.0.0.1:8983/solr/admin/cores?action=STATUS' | python - c 'import sys;import xml.dom.minidom;s=sys.stdin.read();print(xml.dom.minidom.parseString(s).toprettyxml())'\
          \ \n Each core will be within a child from the <lst name=\"status\" element, and contain a <str name=\"instanceDir\"> element. \n You\
          \ can also tell from your ckan config (assuming ckan is working): \n grep solr_url | ckan . i"
components:
  schemas:
    GetResponse:
      type: object
      properties:
        help:
          type: string
        success:
          type: boolean
        result:
          type: array
          items:
            type: string
    GetApiActionActionidResponse:
      type: object
      properties:
        type:
          type: string
    GetApiSearchDatasetResponse:
      type: object
      properties:
        ResultSet:
          type: object
          properties:
            Result:
              type: array
              items:
                type: object
                properties:
                  match_field:
                    type: string
                  match_displayed:
                    type: string
                  name:
                    type: string
                  title:
                    type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
security:
- apiKey: []
tags:
- name: Api
- name: Solr