Skip to content

List catalog entries (admin)

GET
/v1/admin/catalog
curl --request GET \
--url https://localhost:8080/v1/admin/catalog \
--header 'Authorization: <Authorization>'

Returns paginated catalog entries with admin-only metadata

page
integer

Page number

limit
integer

Page size

datasource_id
string

Datasource ID filter

target_name
string

Target name filter

sort
string

Sort field

OK

Media typeapplication/json
object
data
object
entries
Array<object>
object
created_at
string
datasource_id
string
datasource_name
string
id
string
metadata
scan_policy
string
schema
summary
string
target_location
string
target_name
string
updated_at
string
limit
integer
offset
integer
total
integer
success
boolean

Example generated

{
"data": {
"entries": [
{
"created_at": "example",
"datasource_id": "example",
"datasource_name": "example",
"id": "example",
"metadata": "example",
"scan_policy": "example",
"schema": "example",
"summary": "example",
"target_location": "example",
"target_name": "example",
"updated_at": "example"
}
],
"limit": 1,
"offset": 1,
"total": 1
},
"success": true
}

Unauthorized

Media typeapplication/json
object
error
string
message
string
success
boolean

Example

{
"error": "",
"message": "Success",
"success": true
}

Forbidden

Media typeapplication/json
object
error
string
message
string
success
boolean

Example

{
"error": "",
"message": "Success",
"success": true
}

Internal Server Error

Media typeapplication/json
object
error
string
message
string
success
boolean

Example

{
"error": "",
"message": "Success",
"success": true
}