Skip to content

Update catalog entry

PATCH
/v1/admin/catalog/{id}
curl --request PATCH \
--url https://localhost:8080/v1/admin/catalog/example \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "metadata": { "additionalProperty": "example" }, "scan_policy": "example", "schema": "example", "summary": "example", "target_location": "example", "target_name": "example" }'

Updates metadata, schema, or target mapping for a catalog entry

id
required
string

Catalog entry ID

Catalog entry update payload

Media typeapplication/json
object
metadata
object
key
additional properties
scan_policy
string
schema
summary
string
target_location
string
target_name
string

Example generated

{
"metadata": {
"additionalProperty": "example"
},
"scan_policy": "example",
"schema": "example",
"summary": "example",
"target_location": "example",
"target_name": "example"
}

OK

Media typeapplication/json
object
data
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
success
boolean

Example generated

{
"data": {
"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"
},
"success": true
}

Bad Request

Media typeapplication/json
object
error
string
message
string
success
boolean

Example

{
"error": "",
"message": "Success",
"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
}

Not Found

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
}