ResourcesProject Searches
Project Searches
Authorization
ApiKey Authorization<token>
In: header
Path Parameters
owner*string
Owner of the namespace
entity*string
Entity: project name, hub name, registry name, ...
uuid*string
Uuid identifier of the sub-entity
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/string/string/searches/string"{ "uuid": "string", "name": "string", "description": "string", "user": "string", "project": "string", "tags": [ "string" ], "live_state": 0, "spec": { "query": "string", "sort": "string", "limit": 0, "offset": 0, "groupby": "string", "columns": "string", "layout": "string", "sections": "string", "compares": "string", "heat": "string", "events": { "sections": [ { "name": "string", "is_minimized": true, "is_frozen": true, "columns": 0, "height": 0, "xaxis": "string", "smoothing": 0, "step": 0, "ignore_outliers": true, "sample_size": 0, "widgets": [ {} ], "page_index": 0, "page_size": 0 } ], "xaxis": "string", "smoothing": 0, "step": 0, "ignore_outliers": true, "sample_size": 0 }, "histograms": {}, "trends": {}, "analytics": { "view": "string", "trunc": "string", "groupby": "string", "frequency": "string" } }, "level": "entity", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}{}{}{}{ "error": "string", "code": 0, "message": "string", "details": [ { "type_url": "string", "value": "string" } ]}Authorization
ApiKey Authorization<token>
In: header
Path Parameters
owner*string
Owner of the namespace
entity*string
Entity: project name, hub name, registry name, ...
uuid*string
Uuid identifier of the sub-entity
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/api/v1/string/string/searches/string"Empty
{}{}{}{ "error": "string", "code": 0, "message": "string", "details": [ { "type_url": "string", "value": "string" } ]}Authorization
ApiKey Authorization<token>
In: header
Path Parameters
owner*string
Owner of the namespace
entity*string
Entity: project name, hub name, registry name, ...
uuid*string
Uuid identifier of the sub-entity
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/string/string/searches/string/promote" \ -H "Content-Type: application/json" \ -d '{}'Empty
{}{}{}{ "error": "string", "code": 0, "message": "string", "details": [ { "type_url": "string", "value": "string" } ]}Authorization
ApiKey Authorization<token>
In: header
Path Parameters
owner*string
Owner of the namespace
name*string
Entity managing the resource
Query Parameters
offset?integer
Pagination offset.
limit?integer
Limit size.
sort?string
Sort to order the search.
query?string
Query filter the search.
bookmarks?boolean
Filter by bookmarks.
mode?string
Mode of the search.
no_page?boolean
No pagination.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/string/string/searches"{ "count": 0, "results": [ { "uuid": "string", "name": "string", "description": "string", "user": "string", "project": "string", "tags": [ "string" ], "live_state": 0, "spec": { "query": "string", "sort": "string", "limit": 0, "offset": 0, "groupby": "string", "columns": "string", "layout": "string", "sections": "string", "compares": "string", "heat": "string", "events": { "sections": [ { "name": "string", "is_minimized": true, "is_frozen": true, "columns": 0, "height": 0, "xaxis": "string", "smoothing": 0, "step": 0, "ignore_outliers": true, "sample_size": 0, "widgets": [ {} ], "page_index": 0, "page_size": 0 } ], "xaxis": "string", "smoothing": 0, "step": 0, "ignore_outliers": true, "sample_size": 0 }, "histograms": {}, "trends": {}, "analytics": { "view": "string", "trunc": "string", "groupby": "string", "frequency": "string" } }, "level": "entity", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "previous": "string", "next": "string"}{}{}{}{ "error": "string", "code": 0, "message": "string", "details": [ { "type_url": "string", "value": "string" } ]}Authorization
ApiKey Authorization<token>
In: header
Path Parameters
owner*string
Owner of the namespace
name*string
Entity managing the resource
Query Parameters
offset?integer
Pagination offset.
limit?integer
Limit size.
sort?string
Sort to order the search.
query?string
Query filter the search.
bookmarks?boolean
Filter by bookmarks.
mode?string
Mode of the search.
no_page?boolean
No pagination.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/string/string/searches/names"{ "count": 0, "results": [ { "uuid": "string", "name": "string", "description": "string", "user": "string", "project": "string", "tags": [ "string" ], "live_state": 0, "spec": { "query": "string", "sort": "string", "limit": 0, "offset": 0, "groupby": "string", "columns": "string", "layout": "string", "sections": "string", "compares": "string", "heat": "string", "events": { "sections": [ { "name": "string", "is_minimized": true, "is_frozen": true, "columns": 0, "height": 0, "xaxis": "string", "smoothing": 0, "step": 0, "ignore_outliers": true, "sample_size": 0, "widgets": [ {} ], "page_index": 0, "page_size": 0 } ], "xaxis": "string", "smoothing": 0, "step": 0, "ignore_outliers": true, "sample_size": 0 }, "histograms": {}, "trends": {}, "analytics": { "view": "string", "trunc": "string", "groupby": "string", "frequency": "string" } }, "level": "entity", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "previous": "string", "next": "string"}{}{}{}{ "error": "string", "code": 0, "message": "string", "details": [ { "type_url": "string", "value": "string" } ]}Authorization
ApiKey Authorization<token>
In: header
Path Parameters
owner*string
Owner of the namespace
project*string
Project under namespace
Request Body
application/json
Search body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/string/string/searches" \ -H "Content-Type: application/json" \ -d '{}'{ "uuid": "string", "name": "string", "description": "string", "user": "string", "project": "string", "tags": [ "string" ], "live_state": 0, "spec": { "query": "string", "sort": "string", "limit": 0, "offset": 0, "groupby": "string", "columns": "string", "layout": "string", "sections": "string", "compares": "string", "heat": "string", "events": { "sections": [ { "name": "string", "is_minimized": true, "is_frozen": true, "columns": 0, "height": 0, "xaxis": "string", "smoothing": 0, "step": 0, "ignore_outliers": true, "sample_size": 0, "widgets": [ {} ], "page_index": 0, "page_size": 0 } ], "xaxis": "string", "smoothing": 0, "step": 0, "ignore_outliers": true, "sample_size": 0 }, "histograms": {}, "trends": {}, "analytics": { "view": "string", "trunc": "string", "groupby": "string", "frequency": "string" } }, "level": "entity", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}{}{}{}{ "error": "string", "code": 0, "message": "string", "details": [ { "type_url": "string", "value": "string" } ]}Authorization
ApiKey Authorization<token>
In: header
Path Parameters
owner*string
Owner of the namespace
project*string
Project under namespace
search.uuid*string
UUID
Request Body
application/json
Search body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/api/v1/string/string/searches/string" \ -H "Content-Type: application/json" \ -d '{}'{ "uuid": "string", "name": "string", "description": "string", "user": "string", "project": "string", "tags": [ "string" ], "live_state": 0, "spec": { "query": "string", "sort": "string", "limit": 0, "offset": 0, "groupby": "string", "columns": "string", "layout": "string", "sections": "string", "compares": "string", "heat": "string", "events": { "sections": [ { "name": "string", "is_minimized": true, "is_frozen": true, "columns": 0, "height": 0, "xaxis": "string", "smoothing": 0, "step": 0, "ignore_outliers": true, "sample_size": 0, "widgets": [ {} ], "page_index": 0, "page_size": 0 } ], "xaxis": "string", "smoothing": 0, "step": 0, "ignore_outliers": true, "sample_size": 0 }, "histograms": {}, "trends": {}, "analytics": { "view": "string", "trunc": "string", "groupby": "string", "frequency": "string" } }, "level": "entity", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}{}{}{}{ "error": "string", "code": 0, "message": "string", "details": [ { "type_url": "string", "value": "string" } ]}Authorization
ApiKey Authorization<token>
In: header
Path Parameters
owner*string
Owner of the namespace
project*string
Project under namespace
search.uuid*string
UUID
Request Body
application/json
Search body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/api/v1/string/string/searches/string" \ -H "Content-Type: application/json" \ -d '{}'{ "uuid": "string", "name": "string", "description": "string", "user": "string", "project": "string", "tags": [ "string" ], "live_state": 0, "spec": { "query": "string", "sort": "string", "limit": 0, "offset": 0, "groupby": "string", "columns": "string", "layout": "string", "sections": "string", "compares": "string", "heat": "string", "events": { "sections": [ { "name": "string", "is_minimized": true, "is_frozen": true, "columns": 0, "height": 0, "xaxis": "string", "smoothing": 0, "step": 0, "ignore_outliers": true, "sample_size": 0, "widgets": [ {} ], "page_index": 0, "page_size": 0 } ], "xaxis": "string", "smoothing": 0, "step": 0, "ignore_outliers": true, "sample_size": 0 }, "histograms": {}, "trends": {}, "analytics": { "view": "string", "trunc": "string", "groupby": "string", "frequency": "string" } }, "level": "entity", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}{}{}{}{ "error": "string", "code": 0, "message": "string", "details": [ { "type_url": "string", "value": "string" } ]}