Supported Search Methods

You can use a number of search methods when using the application search or the search field at the top of the JFrog Platform UI. The following search methods are available:

Search by Keywords

You can use the application search using a set of predefined keywords listed below. Searching by keywords help make your search more effective and enables you to search for specific filetypes like packages (pkg), repositories (repo) and more.

To search by keyword:

  • In the search box at the top of the platform UI window, type the keyword or multiple keywords from the below list within the search. For example, you can search for all Docker packages in the Docker-local repository by typing: pkgType:docker repo:docker-local.

The Advanced search filter is also based on these keywords. Selecting a filter in the Advanced search displays the keyword in the search bar.

The following table contains the full list of keywords.

Name

Description

pkg

Searches according to a package type.

For example: pkg:dockerreturns results for Docker packages.

repo

Searches according to the repository type: local, remote, virtual, or distribution.

For example: repo:docker-local type:package myApp returns results for packages in the docker-local.

checksum

Searches according to the checksum of the package or artifact.

For example: checksum:13f2ab8fa returns results for packages or artifacts containing the checksum number.

properties

Searches for artifacts that are annotated with properties.

For example: properties: passedQA=true,oss=true returns results for packages that have passed QA and are OSS.

before

Searches for resources that were created before the specified date.

For example: pkg:docker before:2019-01-03 returns results for Docker packages created before this date.

after

Searches for resources that were created after the specified date.

For example: pkg:docker after:2019-01-03 returns results for Docker packages created after this date.

cve

Searches for resources that have the specified issue.

For example: cve:CVE-2019-12 returns results for resources affected by CVE-2019-12.

license

Searches for resources containing the specified license.

For example: license:MIT returns results for resources containing the MIT license.

severity

Searches for resources contain a violation with a specific severity level.

For example: severity:medium,high returns results for resources containing security violations with Medium and High severity levels.

The following table contains dedicated artifact keywords:

Keyword by Search Type

Supported Package Type

Supported Values

Artifacts

searchType

Packages, Archive, Properties, Checksum, or Trash.

Artifacts > Packages

version

All Packages

Searches for artifacs according to a specific version.

category

Chef

Free text

platform

Chef and Conda

Free text

user

Conan

Free text

channel

Conan

Free text

os

Conan

Free text

arch

Conan, Conda, Debian, Opkg, RPM

Free text

buildType

Conan

Free text

compiler

Conan

Free text

priority

Debian, Opkg

Free text

maintainer

Debian, Opkg

Free text

dist

Debian

Free text

component

Debian

Free text

digest

Docker

Free text

v1

Docker

Free text

appVersion

Helm

Free text

groupID

Maven

Free text

artifactID

Maven

Free text

classifier

Maven

Free text

scope

npm

Free text

keywords

npm

Free text

boxProvider

Vagrant

Free text

Artifacts > Archive Entries

path

Free text

classResourcesOnly

Indicates whether to search according to class resources only.

Possible values: true, false

Default value: false

excludeInnerClasses

Indicates whether to exclude inner classes are part of the search.

Possible values: true, false

Default value: false

checksumSearch

Indicates whether the search pattern needs to be searched as a checksum

Possible values: true, false

Default value: false

Free-Text Search

You can search by using one or more words, terms that include wildcard symbols and Boolean expressions.

To search using free text:

  • In the search box at the top of the platform UI window, type a string that reflects the name of the item you are searching for. You can use wildcard symbols such as * (all), and Boolean expressions. Then click Enter. The search results are displayed.

Advanced Search Using Filters

You can narrow down your search results for complex searches by setting filters in the the advanced filtered search. The search contains filters that apply to all the resources, for example, name and data range, and resource-specific filters in your docker-local repository that have a specific Docker tag. For example you can search for all the Docker images in yourdocker-localrepository that have a specific Docker tag.

To use advanced search filters:

  1. From the left-hand side of the search box at the top of the platform UI, select a resource type, for example, Packages.

  2. Click Advanced Search to the right of the search field. Advanced Search options are displayed for that resource type.

  3. Configure Advanced Search options for the resource type you have selected. Click a resource type to see its options:

Example

If ​Packages​ is chosen from the list to the left of the search field, you can click the Advanced Search button ​​​to display the advanced filtering options for packages. For example, a Type field appears listing package types, from which you can choose ​Docker​​, for example. JFrog then adds the ​pkgType:docker​​ keyword to the search bar to search for a Docker package.

Package Search

Package Search allows you to search for packages using a number of parameters. For important information that will help you better search for Packages and Artifacts, see Understanding how to Search for Artifacts and Packages

To search for packages:

  1. From the left of the search field at the top of the platform UI, select Packages.

  2. From the right of the search field, click Advanced Search . Advanced Search options are displayed.

  3. Configure Advanced Search options using any of the parameters described below.

FieldDescription
TypeSelect the package from the Type list.
NameType the package name.
DescriptionSearch for keywords in the package description for supported packages.
KeywordsSearch for keywords in the package metadata, for supported packages. Keywords may be called 'tags' or 'labels' for different packages types.

Build Search

Build Search allows you to search for builds using a number of parameters.

To search for builds:

  1. From the left of the search field at the top of the platform UI, select Builds.

  2. From the right of the search field, click Advanced Search . Advanced Search options are displayed.

    search_builds (1).png
  3. Configure Advanced Search options using any of the parameters described below.

FieldDescription
NameThe build name.
Created After/Created BeforeSelect the date range between two dates in which the build was deployed.

Artifacts Search

Artifact Search offers a number of search parameters based on the type of artifact you're searching for. Each search type offers a set of input fields corresponding to the search type you selected to help narrow down your search.

To search for artifacts:

  1. From the left of the search field at the top of the platform UI, select Artifacts.

  2. From the right of the search field, click Advanced Search . Advanced Search options are displayed.

  3. Select a Type. Advanced search options vary depending on the type of artifact you are searching for. The following artifact types are available. Click for more information on what is offered in each, then complete the fields as needed:

  4. Take action on an artifact, if required. Several actions are available based on the resource, by clicking the arrow on the far right, as follows:

Quick Search

Using Quick Search you can search for artifacts by name and repositories. From the search type dropdown, select Quick, enter your search terms, and click Search.

To run a quick search:

  1. From the left of the search field at the top of the JDP window, select Artifacts.

  2. From the right of the search field, click Advanced Search . Advanced Search options are displayed.

    quick search artifacts.png
  3. From the Type menu, select Quick. Quick search options are displayed.

  4. Configure as needed and run your search. You can specify the following parameters for your search:

ParameterDescription
NameType the name of the artifact. You can use ? and * as wildcards
RepositoriesSelect specific repositories from the Repositories list to narrow down your search

Artifact Package Search

Package search enables you to run a search based on a specific packaging type. For each type, you can specify search parameters based on the relevant metadata for the selected package type. For example, Helm search is suitable for searching through Helm Chart repositories.

📘

Under the hood

Package search is based on standard properties that Artifactory attaches to packages according to their type. For example, when searching for NuGet packages, Artifactory is actually matching the search terms to the values for the nuget.id and nuget.version properties that should be attached to every NuGet package.

📘

Limitation

Package search does not currently work on remote repository caches for RubyGems, Debian, and PHP Composer repositories.

To run a package search:

The following table displays the parameters you may use for each package type:

  1. From the left of the search field at the top of the JDP window, select Artifacts.

  2. From the right of the search field, click Advanced Search . Advanced Search options are displayed.

    search_artifacts_by_packages (1).png
  3. From the Type menu, select Package. Package options are displayed.

  4. Select one of the following package types you want to base the search on:

Search TypeSearch Parameters
AlpinePackage name, Version, Repositories, Checksum
BowerPackage name, Version
ChefName, Version, Category, Platform
CocoaPodsPackage name, Version
ComposerPackage name, Version
ConanPackage name, Version, User , Channel, OS, Architecture, Build Type, Compiler
CondaPackage Name, Version, Arch, Platform
CRANPackage Name, Version
DebianFile name (without the .deb extension), Distribution, Component, Architecture
DockerFull Image Namespace, Image Tag, Image Digest
GemsPackage name, Version
GoPackage Name, Version
HelmHelm Chart Name, Helm Chart Version, App Version
Maven GAVCGroup ID, Artifact ID, Version, Classifier
NpmPackage name, Version, Scope
NuGetPackage ID, Version
OpkgPackage name, Version, Architecture, Priority, Maintainer
PyPIPackage name, Version
RPMPackage name, Version, Architecture, Release
VagrantBox Name, Version, Provider

All these search fields support the ? and * wildcard characters.

Package search as an AQL query

For most package formats, package search is implemented as an AQL query. After searching, click the AQL Query button to view the AQL query used in the search. You may also click the Copy icon in the AQL code snippet to copy the query to your clipboard.

📘

Limit search to specific repositories

When limiting search to specific repositories, you can select repositories with the corresponding package type. Package search depends on those repositories having the correct layout. Searching through repositories with the wrong layout will have unpredictable and unreliable results.

The example below shows the results of searching for any Docker image with latest in its name:

search type package latest (1).png

Property Search

📘

Note

The Property Search requires an Artifactory Pro license and above.

You can search for artifacts or folders based on properties assigned to them, whether they are standard properties assigned by Artifactory, or custom properties which you can freely assign yourself.

To run a property search:

  1. From the left of the search field at the top of the JDP window, select Artifacts.

  2. From the right of the search field, click Advanced Search . Advanced Search options are displayed.

    property_search (1).png
  3. From the Type menu, select Property. Property search options are displayed.

  4. Click Add Property and in the Key field, type the name of the property to search for, or select one from the list provided.

  5. In the Value field, set the value you are searching for in the specified property.

  6. Add more properties to the search use the Add Property as required, then click Search. The search is run. You can repeat this process to specify any number of properties and values for your search.

Wildcards can be used in the Property Value field

You can use the ? or * wildcards in the Value field.

Combining Properties and Values

Properties can be combined using the AND operator.

Different values assigned to a specific property can also combined using the AND operator.

This means that only artifacts that meet all the search criteria specified will be found.

The following example shows a search for artifacts that have a build.number property with a value of 2.

property_search_example (1).png

Checksum Search

You can search for artifacts based on their MD5, SHA1 or SHA2 checksum value. This can be especially useful if you want to identify an artifact whose name has been changed.

To run a checksum search:

  1. From the left of the search field at the top of the JDP window, select Artifacts.
  2. From the right of the search field, click Advanced Search . Advanced Search options are displayed.
  3. From the Type menu, select Checksum. Checksum search options are displayed.
  4. Copy and paste a checksum, then select a repository to search in and click Search. Wildcard characters are not supported in Checksum Search, so the term entered in the search field must be a valid MD5 or SHA1 value.

The following example shows a search for an artifact using its SHA1 checksum.

checksum filter (1).png

Trash Search

Trash Search is a search type that can be selected as part Searching Artifacts.

To run a Trash search:

  1. From the left of the search field at the top of the JDP window, select Artifacts.

  2. From the right of the search field, click Advanced Search . Advanced Search options are displayed.

    trash npm (1).png
  3. From the Type menu, select Trash. The Trash search options are displayed.

  4. Enter the artifact's name in the Query field, or select Checksum Search and type the artifact's checksum.

  5. Click Search. The search results are displayed.

Release Bundles Search

📘

Note

The Release Bundles Search requires JFrog Distribution be installed with an Enterprise+ license.

The Release Bundles search enables you to search for distributable and received Release Bundles (v1 and v2) within a specified time page.

To search for Release Bundles:

  1. From the left of the search field at the top of the platform UI, select Release Bundles.

  2. From the right of the search field, click Advanced Search . Advanced Search options are displayed.

  3. Configure Advanced Search options using any of the below parameters.

    • Name: Type the name of the Release Bundle.
    • Release Bundle Version: Click V1 or V2. For more information, see Types of Release Bundles.
    • Created After: Pick a date after which the Release Bundle was created (start date).
    • Created Before: Pick a date before which the Release Bundle was created (end date).
  4. Click Search. The search is run and results are displayed below.