Chapter 19. search
Conduct searches against all registry context.
19.1. conductRepoSearch Copy linkLink copied to clipboard!
Get a list of apps and repositories that match the specified query.
GET /api/v1/find/repositories
Authorizations:
Query parameters
| Type | Name | Description | Schema | 
|---|---|---|---|
|   query  |   
								includeUsage  |   Whether to include usage metadata  |   boolean  | 
|   query  |   
								page  |   The page.  |   integer  | 
|   query  |   
								query  |   The search query.  |   string  | 
Responses
| HTTP Code | Description | Schema | 
|---|---|---|
|   200  |   Successful invocation  | |
|   400  |   Bad Request  | |
|   401  |   Session required  | |
|   403  |   Unauthorized access  | |
|   404  |   Not found  | 
Example command
curl -X GET "https://quay-server.example.com/api/v1/find/repositories?query=<repo_name>&page=1&includeUsage=true" \ -H "Authorization: Bearer <bearer_token>"
$ curl -X GET "https://quay-server.example.com/api/v1/find/repositories?query=<repo_name>&page=1&includeUsage=true" \
  -H "Authorization: Bearer <bearer_token>"
19.2. conductSearch Copy linkLink copied to clipboard!
Get a list of entities and resources that match the specified query.
GET /api/v1/find/all
Authorizations: oauth2_implicit (repo:read)
Query parameters
| Type | Name | Description | Schema | 
|---|---|---|---|
|   query  |   
								query  |   The search query.  |   string  | 
Responses
| HTTP Code | Description | Schema | 
|---|---|---|
|   200  |   Successful invocation  | |
|   400  |   Bad Request  | |
|   401  |   Session required  | |
|   403  |   Unauthorized access  | |
|   404  |   Not found  | 
Example command
curl -X GET "https://quay-server.example.com/api/v1/find/all?query=<mysearchterm>" \ -H "Authorization: Bearer <bearer_token>"
$ curl -X GET "https://quay-server.example.com/api/v1/find/all?query=<mysearchterm>" \
  -H "Authorization: Bearer <bearer_token>"
19.3. getMatchingEntities Copy linkLink copied to clipboard!
Get a list of entities that match the specified prefix.
GET /api/v1/entities/{prefix}
Authorizations:
Path parameters
| Type | Name | Description | Schema | 
|---|---|---|---|
|   path  |   
								prefix  |   string  | 
Query parameters
| Type | Name | Description | Schema | 
|---|---|---|---|
|   query  |   
								includeOrgs  |   Whether to include orgs names.  |   boolean  | 
|   query  |   
								includeTeams  |   Whether to include team names.  |   boolean  | 
|   query  |   
								namespace  |   Namespace to use when querying for org entities.  |   string  | 
Responses
| HTTP Code | Description | Schema | 
|---|---|---|
|   200  |   Successful invocation  | |
|   400  |   Bad Request  | |
|   401  |   Session required  | |
|   403  |   Unauthorized access  | |
|   404  |   Not found  | 
Example command
curl -X GET "https://quay-server.example.com/api/v1/entities/<prefix>?includeOrgs=<true_or_false>&includeTeams=<true_or_false>&namespace=<namespace>" \ -H "Authorization: Bearer <bearer_token>"
$ curl -X GET "https://quay-server.example.com/api/v1/entities/<prefix>?includeOrgs=<true_or_false>&includeTeams=<true_or_false>&namespace=<namespace>" \
  -H "Authorization: Bearer <bearer_token>"