/api/application/appcatalog/publicregistry: GET

Queries the available docker images that match the unique query string from the hub.docker.com short description.

The following table shows which roles can access this REST API endpoint:
Table 1. Access by role
Data admin CollectionAdmin Data user Admin Service user
✓ ✓ ✓ ✓ ✓

Synopsis of the request URL

curl -k -H “Authorization: Bearer <token>” -H "Content-Type: application/json"  
https://<spectrum_discover_host>/api/application/appcatalog/publicregistry

Supported request types and response formats

Supported request types:
  • GET
Supported response formats:
  • JSON

Examples

The following example returns a listing of all available images.

Request: 
curl -X GET -k -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" https://<spectrum_discover_host>/api/application/appcatalog/publicregistry | jq
Response: 
{
  "success": "true",
  "message": "Successfully retrieved all applications.",
  "output": [
    {
      "repo_name": "ibmcom/spectrum-discover-example-application",
      "star_count": 0,
      "pull_count": 300,
      "created": "2019-11-08T21:08:36.522Z",
      "application_name": "",
      "company_name": null,
      "company_url": null,
      "description": "",
      "filetypes": "",
      "icon_url": null,
      "maintainer": null,
      "parameters": null,
      "version": "",
      "license": "",
      "installed": 0,
      "installed_version": null,
      "instances": null,
      "additional_info": null,
      "update": "2019-11-12T18:00:03.802Z"
    },
    {
      "repo_name": "ibmcom/spectrum-discover-exif-header-extractor",
      "star_count": 0,
      "pull_count": 296,
      "created": "2019-11-08T20:56:24.160Z",
      "application_name": "exif_header_extractor",
      "company_name": null,
      "company_url": null,
      "description": "Extracts exif header information for jpeg, tiff files",
      "filetypes": "jpg,jpeg,tiff",
      "icon_url": null,
      "maintainer": null,
      "parameters": null,
      "version": "1.0.0",
      "license": "mit",
      "installed": 0,
      "installed_version": null,
      "instances": null,
      "additional_info": null,
      "update": "2019-11-12T18:00:03.822Z"
    }
  ]
}

The following example returns a specific image.

Request: 
curl -X GET -k -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" https://<spectrum_discover_host>/api/application/appcatalog/publicregistry/ibmcom/spectrum-discover-exif-header-extractor | jq
Response: 
{
  "success": "true",
  "message": "Successfully retrieved application: ibmcom/spectrum-discover-exif-header-extractor.",
  "output": {
    "repo_name": "ibmcom/spectrum-discover-exif-header-extractor",
    "star_count": 0,
    "pull_count": 296,
    "created": "2019-11-08T20:56:24.160Z",
    "application_name": "exif_header_extractor",
    "company_name": null,
    "company_url": null,
    "description": "Extracts exif header information for jpeg, tiff files",
    "filetypes": "jpg,jpeg,tiff",
    "icon_url": null,
    "maintainer": null,
    "parameters": null,
    "version": "1.0.0",
    "license": "mit",
    "installed": 0,
    "installed_version": null,
    "instances": null,
    "additional_info": null,
    "update": "2019-11-12T18:00:03.822Z"
  }
}