Marmot API (0.1)

Download OpenAPI specification:Download

License: MIT

API for interacting with Marmot

ingestion

List ingestion job runs

query Parameters

schedule_id	string Filter by schedule ID
status	string Filter by status
limit	integer Limit
offset	integer Offset

Responses

Response samples

200
401
500

Content type

application/json

{"limit": 0,
"offset": 0,
"runs": [{"assets_created": 0,
"assets_deleted": 0,
"assets_updated": 0,
"claimed_at": "string",
"claimed_by": "string",
"config": { },
"created_at": "string",
"created_by": "string",
"documentation_added": 0,
"error_message": "string",
"finished_at": "string",
"id": "string",
"lineage_created": 0,
"log": "string",
"pipeline_name": "string",
"plugin_run_id": "string",
"run_id": "string",
"schedule_id": "string",
"source_name": "string",
"started_at": "string",
"status": "string",
"updated_at": "string"
}
],
"total": 0
}

Get a job run by ID

path Parameters

id

required

string

Job run ID

Responses

Response samples

200
401
404
500

Content type

application/json

{"assets_created": 0,
"assets_deleted": 0,
"assets_updated": 0,
"claimed_at": "string",
"claimed_by": "string",
"config": { },
"created_at": "string",
"created_by": "string",
"documentation_added": 0,
"error_message": "string",
"finished_at": "string",
"id": "string",
"lineage_created": 0,
"log": "string",
"pipeline_name": "string",
"plugin_run_id": "string",
"run_id": "string",
"schedule_id": "string",
"source_name": "string",
"started_at": "string",
"status": "string",
"updated_at": "string"
}

Cancel a running job

path Parameters

id

required

string

Job run ID

Responses

Get entities for a job run

path Parameters

id

required

string

Job run ID

query Parameters

limit	integer Limit
offset	integer Offset

Responses

Response samples

200
401
404
500

Content type

application/json

{ }

List ingestion schedules

query Parameters

enabled	boolean Filter by enabled status
limit	integer Limit
offset	integer Offset

Responses

Response samples

200
401
500

Content type

application/json

{"limit": 0,
"offset": 0,
"schedules": [{"config": { },
"created_at": "string",
"created_by": "string",
"cron_expression": "string",
"enabled": true,
"id": "string",
"last_run_at": "string",
"last_run_status": "string",
"name": "string",
"next_run_at": "string",
"plugin_id": "string",
"updated_at": "string"
}
],
"total": 0
}

Create a new ingestion schedule

Request Body schema: application/json
required

Schedule configuration

	object
cron_expression	string
enabled	boolean
name	string
plugin_id	string

Responses

Request samples

Payload

Content type

application/json

{"config": { },
"cron_expression": "string",
"enabled": true,
"name": "string",
"plugin_id": "string"
}

Response samples

201
400
401
500

Content type

application/json

{"config": { },
"created_at": "string",
"created_by": "string",
"cron_expression": "string",
"enabled": true,
"id": "string",
"last_run_at": "string",
"last_run_status": "string",
"name": "string",
"next_run_at": "string",
"plugin_id": "string",
"updated_at": "string"
}

Delete an ingestion schedule

path Parameters

id

required

string

Schedule ID

Responses

Get an ingestion schedule by ID

path Parameters

id

required

string

Schedule ID

Responses

Response samples

200
401
404
500

Content type

application/json

{"config": { },
"created_at": "string",
"created_by": "string",
"cron_expression": "string",
"enabled": true,
"id": "string",
"last_run_at": "string",
"last_run_status": "string",
"name": "string",
"next_run_at": "string",
"plugin_id": "string",
"updated_at": "string"
}

Update an ingestion schedule

path Parameters

id

required

string

Schedule ID

Request Body schema: application/json
required

Updated schedule configuration

	object
cron_expression	string
enabled	boolean
name	string
plugin_id	string

Responses

Request samples

Payload

Content type

application/json

{"config": { },
"cron_expression": "string",
"enabled": true,
"name": "string",
"plugin_id": "string"
}

Response samples

200
400
401
404
500

Content type

application/json

{"config": { },
"created_at": "string",
"created_by": "string",
"cron_expression": "string",
"enabled": true,
"id": "string",
"last_run_at": "string",
"last_run_status": "string",
"name": "string",
"next_run_at": "string",
"plugin_id": "string",
"updated_at": "string"
}

Manually trigger an ingestion schedule

path Parameters

id

required

string

Schedule ID

Responses

Validate plugin configuration

Request Body schema: application/json
required

Config to validate

	object
plugin_id	string

Responses

Request samples

Payload

Content type

application/json

{"config": { },
"plugin_id": "string"
}

Response samples

200
400
401

Content type

application/json

{"errors": [{"field": "string",
"message": "string"
}
],
"valid": true
}

lineage

Ingest OpenLineage event

Process OpenLineage run events and update assets/lineage accordingly

Request Body schema: application/json
required

OpenLineage run event

eventTime	string
eventType	string
	Array of objects (lineage.Dataset)
	object (lineage.Job)
	Array of objects (lineage.Dataset)
producer	string
	object (lineage.Run)
schemaURL	string

Responses

Request samples

Payload

Content type

application/json

{"eventTime": "string",
"eventType": "string",
"inputs": [{"facets": { },
"inputFacets": { },
"name": "string",
"namespace": "string",
"outputFacets": { }
}
],
"job": {"facets": { },
"name": "string",
"namespace": "string"
},
"outputs": [{"facets": { },
"inputFacets": { },
"name": "string",
"namespace": "string",
"outputFacets": { }
}
],
"producer": "string",
"run": {"facets": { },
"runId": "string"
},
"schemaURL": "string"
}

Response samples

400
500

Content type

application/json

{"error": "string"
}

Get asset lineage

Get upstream and downstream lineage for a specific asset

path Parameters

id

required

string <uuid>

Asset ID

query Parameters

limit	integer Default: 10 Maximum depth of lineage graph
direction	string Default: "both" Enum: "upstream" "downstream" "both" Direction of lineage (upstream, downstream, or both)

Responses

Response samples

200
400
404
500

Content type

application/json

{"edges": [{"id": "string",
"job_mrn": "string",
"source": "string",
"target": "string",
"type": "string"
}
],
"nodes": [{"asset": {"created_at": "string",
"created_by": "string",
"description": "string",
"environments": {"property1": {"metadata": { },
"name": "string",
"path": "string"
},
"property2": {"metadata": { },
"name": "string",
"path": "string"
}
},
"external_links": [{"icon": "string",
"name": "string",
"url": "string"
}
],
"has_run_history": true,
"id": "string",
"is_stub": true,
"last_sync_at": "string",
"metadata": { },
"mrn": "string",
"name": "string",
"parent_mrn": "string",
"providers": ["string"
],
"query": "string",
"query_language": "string",
"schema": {"property1": "string",
"property2": "string"
},
"sources": [{"last_sync_at": "string",
"name": "string",
"priority": 0,
"properties": { }
}
],
"tags": ["string"
],
"type": "string",
"updated_at": "string",
"user_description": "string"
},
"depth": 0,
"id": "string",
"type": "string"
}
]
}

Batch create lineage edges

Create lineage edges in batch

Request Body schema: application/json
required

Array of lineage edges to create

Array

id	string
job_mrn	string
source	string
target	string
type	string

Responses

Request samples

Payload

Content type

application/json

[{"id": "string",
"job_mrn": "string",
"source": "string",
"target": "string",
"type": "string"
}
]

Response samples

200
400

Content type

application/json

[{"edge": {"id": "string",
"job_mrn": "string",
"source": "string",
"target": "string",
"type": "string"
},
"status": "string"
}
]

Create direct lineage

Create a direct lineage connection between two assets and returns the created edge

Request Body schema: application/json
required

Lineage edge to create

id	string
job_mrn	string
source	string
target	string
type	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"job_mrn": "string",
"source": "string",
"target": "string",
"type": "string"
}

Response samples

200
400
500

Content type

application/json

{"id": "string",
"job_mrn": "string",
"source": "string",
"target": "string",
"type": "string"
}

Delete direct lineage

Delete a direct lineage connection by its ID

path Parameters

id

required

string <uuid>

Edge ID

Responses

Response samples

400
500

Content type

application/json

{"error": "string"
}

Get direct lineage by ID

Get a specific direct lineage connection by its ID

path Parameters

id

required

string <uuid>

Edge ID

Responses

Response samples

200
404
500

Content type

application/json

{"id": "string",
"job_mrn": "string",
"source": "string",
"target": "string",
"type": "string"
}

metrics

Get metrics for UI

Get aggregated metrics for dashboard display

query Parameters

start required	string Example: start=2024-01-01T00:00:00Z Start time (ISO 8601)
end required	string Example: end=2024-01-02T00:00:00Z End time (ISO 8601)
metric_names	Array of strings Filter by metric names
aggregation	string Default: "avg" Enum: "avg" "sum" "max" "min" Aggregation type
bucket_size	string Enum: "1m" "5m" "1h" "1d" Time bucket size

Responses

Response samples

200
400
401

Content type

application/json

{"metrics": [{"aggregation_type": "string",
"bucket_end": "string",
"bucket_size": 1,
"bucket_start": "string",
"labels": {"property1": "string",
"property2": "string"
},
"name": "string",
"value": 0
}
],
"query": {"aggregation": "string",
"bucket_size": "string",
"end": "string",
"labels": {"property1": "string",
"property2": "string"
},
"metric_names": ["string"
],
"start": "string"
}
}

Get assets by owner

Get asset counts grouped by owner

Responses

Response samples

200

Content type

application/json

{"assets": {"property1": 0,
"property2": 0
}
}

Get assets by provider

Get asset counts grouped by provider

Responses

Response samples

200

Content type

application/json

{"assets": {"property1": 0,
"property2": 0
}
}

Get assets by type

Get asset counts grouped by type

Responses

Response samples

200

Content type

application/json

{"assets": {"property1": 0,
"property2": 0
}
}

Get total assets count

Get the total number of assets

Responses

Response samples

200

Content type

application/json

{"count": 0
}

Get assets with schemas count

Get the count of assets that have schemas defined

Responses

Response samples

200

Content type

application/json

{"count": 0,
"percentage": 0,
"total": 0
}

Get top viewed assets

Get the most viewed assets

query Parameters

start required	string Start time (ISO 8601)
end required	string End time (ISO 8601)
limit	integer Default: 10 Number of results

Responses

Response samples

200

Content type

application/json

[{"asset_id": "string",
"asset_name": "string",
"asset_provider": "string",
"asset_type": "string",
"count": 0
}
]

Get top search queries

Get the most popular search queries

query Parameters

start required	string Start time (ISO 8601)
end required	string End time (ISO 8601)
limit	integer Default: 10 Number of results

Responses

Response samples

200

Content type

application/json

[{"count": 0,
"query": "string",
"query_type": "string"
}
]

plugins

Get AWS credential detection status

Detects if AWS credentials are available from environment or config files

Responses

Response samples

200

Content type

application/json

{"available": true,
"error": "string",
"sources": ["string"
]
}

assets

Create a new asset

Create a new asset in the system

Request Body schema: application/json
required

Asset creation request

description	string
	object
	Array of objects (asset.ExternalLink)
	object
name required	string
providers required	Array of strings
	object
	Array of objects (asset.AssetSource)
tags	Array of strings
type required	string

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"environments": {"property1": {"metadata": { },
"name": "string",
"path": "string"
},
"property2": {"metadata": { },
"name": "string",
"path": "string"
}
},
"external_links": [{"icon": "string",
"name": "string",
"url": "string"
}
],
"metadata": { },
"name": "string",
"providers": ["string"
],
"schema": {"property1": "string",
"property2": "string"
},
"sources": [{"last_sync_at": "string",
"name": "string",
"priority": 0,
"properties": { }
}
],
"tags": ["string"
],
"type": "string"
}

Response samples

201
400
401
409

Content type

application/json

{"created_at": "string",
"created_by": "string",
"description": "string",
"environments": {"property1": {"metadata": { },
"name": "string",
"path": "string"
},
"property2": {"metadata": { },
"name": "string",
"path": "string"
}
},
"external_links": [{"icon": "string",
"name": "string",
"url": "string"
}
],
"has_run_history": true,
"id": "string",
"is_stub": true,
"last_sync_at": "string",
"metadata": { },
"mrn": "string",
"name": "string",
"parent_mrn": "string",
"providers": ["string"
],
"query": "string",
"query_language": "string",
"schema": {"property1": "string",
"property2": "string"
},
"sources": [{"last_sync_at": "string",
"name": "string",
"priority": 0,
"properties": { }
}
],
"tags": ["string"
],
"type": "string",
"updated_at": "string",
"user_description": "string"
}

Delete an asset

Delete an asset from the system

path Parameters

id

required

string

Asset ID

Responses

Response samples

404
409
500

Content type

application/json

{"error": "string"
}

Get an asset by ID

Get detailed information about a specific asset

path Parameters

id

required

string

Asset ID

Responses

Response samples

200
404
500

Content type

application/json

{"created_at": "string",
"created_by": "string",
"description": "string",
"environments": {"property1": {"metadata": { },
"name": "string",
"path": "string"
},
"property2": {"metadata": { },
"name": "string",
"path": "string"
}
},
"external_links": [{"icon": "string",
"name": "string",
"url": "string"
}
],
"has_run_history": true,
"id": "string",
"is_stub": true,
"last_sync_at": "string",
"metadata": { },
"mrn": "string",
"name": "string",
"parent_mrn": "string",
"providers": ["string"
],
"query": "string",
"query_language": "string",
"schema": {"property1": "string",
"property2": "string"
},
"sources": [{"last_sync_at": "string",
"name": "string",
"priority": 0,
"properties": { }
}
],
"tags": ["string"
],
"type": "string",
"updated_at": "string",
"user_description": "string"
}

Update an asset

Update an existing asset's information

path Parameters

id

required

string

Asset ID

Request Body schema: application/json
required

Asset update request

description	string
	object
	Array of objects (asset.ExternalLink)
	object
name	string
providers	Array of strings
	object
	Array of objects (asset.AssetSource)
tags	Array of strings
type	string
user_description	string

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"environments": {"property1": {"metadata": { },
"name": "string",
"path": "string"
},
"property2": {"metadata": { },
"name": "string",
"path": "string"
}
},
"external_links": [{"icon": "string",
"name": "string",
"url": "string"
}
],
"metadata": { },
"name": "string",
"providers": ["string"
],
"schema": {"property1": "string",
"property2": "string"
},
"sources": [{"last_sync_at": "string",
"name": "string",
"priority": 0,
"properties": { }
}
],
"tags": ["string"
],
"type": "string",
"user_description": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"created_at": "string",
"created_by": "string",
"description": "string",
"environments": {"property1": {"metadata": { },
"name": "string",
"path": "string"
},
"property2": {"metadata": { },
"name": "string",
"path": "string"
}
},
"external_links": [{"icon": "string",
"name": "string",
"url": "string"
}
],
"has_run_history": true,
"id": "string",
"is_stub": true,
"last_sync_at": "string",
"metadata": { },
"mrn": "string",
"name": "string",
"parent_mrn": "string",
"providers": ["string"
],
"query": "string",
"query_language": "string",
"schema": {"property1": "string",
"property2": "string"
},
"sources": [{"last_sync_at": "string",
"name": "string",
"priority": 0,
"properties": { }
}
],
"tags": ["string"
],
"type": "string",
"updated_at": "string",
"user_description": "string"
}

Get asset run history

Get paginated run history for a specific asset

path Parameters

id

required

string

Asset ID

query Parameters

limit	integer Default: 10 Number of items per page
offset	integer Default: 0 Number of items to skip

Responses

Response samples

200
400
404
500

Content type

application/json

{"limit": 0,
"offset": 0,
"run_history": [{"duration_ms": 0,
"end_time": "string",
"event_time": "string",
"id": "string",
"job_name": "string",
"job_namespace": "string",
"run_id": "string",
"start_time": "string",
"status": "string",
"type": "string"
}
],
"total": 0
}

Get asset run history histogram

Get histogram data for asset run history over specified period

path Parameters

id

required

string

Asset ID

query Parameters

period

string

Default: "30d"

Time period (7d, 30d, 90d)

Responses

Response samples

200
400
404
500

Content type

application/json

{"buckets": [{"abort": 0,
"complete": 0,
"date": "string",
"fail": 0,
"other": 0,
"running": 0,
"total": 0
}
],
"period": "string"
}

Remove tag from asset

Remove a tag from an existing asset

path Parameters

id

required

string

Asset ID

Request Body schema: application/json
required

Tag to remove

tag

required

string

Responses

Request samples

Payload

Content type

application/json

{"tag": "string"
}

Response samples

200
400
404

Content type

application/json

{"created_at": "string",
"created_by": "string",
"description": "string",
"environments": {"property1": {"metadata": { },
"name": "string",
"path": "string"
},
"property2": {"metadata": { },
"name": "string",
"path": "string"
}
},
"external_links": [{"icon": "string",
"name": "string",
"url": "string"
}
],
"has_run_history": true,
"id": "string",
"is_stub": true,
"last_sync_at": "string",
"metadata": { },
"mrn": "string",
"name": "string",
"parent_mrn": "string",
"providers": ["string"
],
"query": "string",
"query_language": "string",
"schema": {"property1": "string",
"property2": "string"
},
"sources": [{"last_sync_at": "string",
"name": "string",
"priority": 0,
"properties": { }
}
],
"tags": ["string"
],
"type": "string",
"updated_at": "string",
"user_description": "string"
}

Add tag to asset

Add a new tag to an existing asset

path Parameters

id

required

string

Asset ID

Request Body schema: application/json
required

Tag to add

tag

required

string

Responses

Request samples

Payload

Content type

application/json

{"tag": "string"
}

Response samples

200
400
404

Content type

application/json

{"created_at": "string",
"created_by": "string",
"description": "string",
"environments": {"property1": {"metadata": { },
"name": "string",
"path": "string"
},
"property2": {"metadata": { },
"name": "string",
"path": "string"
}
},
"external_links": [{"icon": "string",
"name": "string",
"url": "string"
}
],
"has_run_history": true,
"id": "string",
"is_stub": true,
"last_sync_at": "string",
"metadata": { },
"mrn": "string",
"name": "string",
"parent_mrn": "string",
"providers": ["string"
],
"query": "string",
"query_language": "string",
"schema": {"property1": "string",
"property2": "string"
},
"sources": [{"last_sync_at": "string",
"name": "string",
"priority": 0,
"properties": { }
}
],
"tags": ["string"
],
"type": "string",
"updated_at": "string",
"user_description": "string"
}

Remove glossary term from asset

Remove a glossary term association from an asset

path Parameters

id

required

string

Asset ID

Request Body schema: application/json
required

Term ID to remove

term_id

required

string

Responses

Request samples

Payload

Content type

application/json

{"term_id": "string"
}

Response samples

200
400
404

Content type

application/json

[{"created_at": "string",
"created_by": "string",
"created_by_username": "string",
"definition": "string",
"source": "string",
"term_id": "string",
"term_name": "string"
}
]

Get asset's glossary terms

Retrieve all glossary terms associated with an asset

path Parameters

id

required

string

Asset ID

Responses

Response samples

200
404

Content type

application/json

[{"created_at": "string",
"created_by": "string",
"created_by_username": "string",
"definition": "string",
"source": "string",
"term_id": "string",
"term_name": "string"
}
]

Add glossary terms to asset

Associate one or more glossary terms with an asset

path Parameters

id

required

string

Asset ID

Request Body schema: application/json
required

Term IDs to add

term_ids

required

Array of strings non-empty

Responses

Request samples

Payload

Content type

application/json

{"term_ids": ["string"
]
}

Response samples

200
400
404

Content type

application/json

[{"created_at": "string",
"created_by": "string",
"created_by_username": "string",
"definition": "string",
"source": "string",
"term_id": "string",
"term_name": "string"
}
]

Get assets by glossary term

Retrieve all assets associated with a specific glossary term

path Parameters

term_id

required

string

Glossary Term ID

query Parameters

limit	integer Default: 20 Maximum number of assets
offset	integer Default: 0 Pagination offset

Responses

Response samples

200
500

Content type

application/json

{ }

Create asset documentation

Create or update documentation for an asset

Request Body schema: application/json
required

Documentation creation request

content required	string
mrn required	string
source required	string

Responses

Request samples

Payload

Content type

application/json

{"content": "string",
"mrn": "string",
"source": "string"
}

Response samples

200
400
500

Content type

application/json

{"content": "string",
"created_at": "string",
"global_docs": ["string"
],
"id": "string",
"mrn": "string",
"source": "string",
"updated_at": "string"
}

Get asset documentation

Get documentation for a specific asset

path Parameters

mrn

required

string <url>

Asset MRN

Responses

Response samples

200
404
500

Content type

application/json

[{"content": "string",
"created_at": "string",
"global_docs": ["string"
],
"id": "string",
"mrn": "string",
"source": "string",
"updated_at": "string"
}
]

Batch create documentation

Create or update documentation for multiple assets

Request Body schema: application/json
required

Batch documentation request

required

Array of objects (assetdocs.Documentation) non-empty

Array (non-empty)

content	string
created_at	string
global_docs	Array of strings
id	string
mrn	string
source	string
updated_at	string

Responses

Request samples

Payload

Content type

application/json

{"documentation": [{"content": "string",
"created_at": "string",
"global_docs": ["string"
],
"id": "string",
"mrn": "string",
"source": "string",
"updated_at": "string"
}
]
}

Response samples

200
400
500

Content type

application/json

{"results": [{"documentation": {"content": "string",
"created_at": "string",
"global_docs": ["string"
],
"id": "string",
"mrn": "string",
"source": "string",
"updated_at": "string"
},
"error": "string",
"status": "string"
}
]
}

List assets with pagination

Get a paginated list of assets

query Parameters

offset	integer Offset for pagination
limit	integer Limit for pagination

Responses

Response samples

200
500

Content type

application/json

{"assets": [{"created_at": "string",
"created_by": "string",
"description": "string",
"environments": {"property1": {"metadata": { },
"name": "string",
"path": "string"
},
"property2": {"metadata": { },
"name": "string",
"path": "string"
}
},
"external_links": [{"icon": "string",
"name": "string",
"url": "string"
}
],
"has_run_history": true,
"id": "string",
"is_stub": true,
"last_sync_at": "string",
"metadata": { },
"mrn": "string",
"name": "string",
"parent_mrn": "string",
"providers": ["string"
],
"query": "string",
"query_language": "string",
"schema": {"property1": "string",
"property2": "string"
},
"sources": [{"last_sync_at": "string",
"name": "string",
"priority": 0,
"properties": { }
}
],
"tags": ["string"
],
"type": "string",
"updated_at": "string",
"user_description": "string"
}
],
"filters": {"providers": {"property1": 0,
"property2": 0
},
"tags": {"property1": 0,
"property2": 0
},
"types": {"property1": 0,
"property2": 0
}
},
"total": 0
}

Lookup asset by type and name

Get an asset using its type and name

path Parameters

type required	string Asset type
name required	string Asset name

Responses

Response samples

200
404
500

Content type

application/json

{"created_at": "string",
"created_by": "string",
"description": "string",
"environments": {"property1": {"metadata": { },
"name": "string",
"path": "string"
},
"property2": {"metadata": { },
"name": "string",
"path": "string"
}
},
"external_links": [{"icon": "string",
"name": "string",
"url": "string"
}
],
"has_run_history": true,
"id": "string",
"is_stub": true,
"last_sync_at": "string",
"metadata": { },
"mrn": "string",
"name": "string",
"parent_mrn": "string",
"providers": ["string"
],
"query": "string",
"query_language": "string",
"schema": {"property1": "string",
"property2": "string"
},
"sources": [{"last_sync_at": "string",
"name": "string",
"priority": 0,
"properties": { }
}
],
"tags": ["string"
],
"type": "string",
"updated_at": "string",
"user_description": "string"
}

Match asset pattern

Find assets matching a pattern

query Parameters

pattern required	string Asset pattern to match
type required	string Asset type

Responses

Response samples

200
400
500

Content type

application/json

[{"created_at": "string",
"created_by": "string",
"description": "string",
"environments": {"property1": {"metadata": { },
"name": "string",
"path": "string"
},
"property2": {"metadata": { },
"name": "string",
"path": "string"
}
},
"external_links": [{"icon": "string",
"name": "string",
"url": "string"
}
],
"has_run_history": true,
"id": "string",
"is_stub": true,
"last_sync_at": "string",
"metadata": { },
"mrn": "string",
"name": "string",
"parent_mrn": "string",
"providers": ["string"
],
"query": "string",
"query_language": "string",
"schema": {"property1": "string",
"property2": "string"
},
"sources": [{"last_sync_at": "string",
"name": "string",
"priority": 0,
"properties": { }
}
],
"tags": ["string"
],
"type": "string",
"updated_at": "string",
"user_description": "string"
}
]

Get user's assets

Get assets owned by the current user or their teams

query Parameters

limit	integer Default: 20 Limit
offset	integer Default: 0 Offset

Responses

Response samples

200
401
500

Content type

application/json

{"assets": [{"created_at": "string",
"created_by": "string",
"description": "string",
"environments": {"property1": {"metadata": { },
"name": "string",
"path": "string"
},
"property2": {"metadata": { },
"name": "string",
"path": "string"
}
},
"external_links": [{"icon": "string",
"name": "string",
"url": "string"
}
],
"has_run_history": true,
"id": "string",
"is_stub": true,
"last_sync_at": "string",
"metadata": { },
"mrn": "string",
"name": "string",
"parent_mrn": "string",
"providers": ["string"
],
"query": "string",
"query_language": "string",
"schema": {"property1": "string",
"property2": "string"
},
"sources": [{"last_sync_at": "string",
"name": "string",
"priority": 0,
"properties": { }
}
],
"tags": ["string"
],
"type": "string",
"updated_at": "string",
"user_description": "string"
}
],
"filters": {"providers": {"property1": 0,
"property2": 0
},
"tags": {"property1": 0,
"property2": 0
},
"types": {"property1": 0,
"property2": 0
}
},
"limit": 0,
"offset": 0,
"total": 0
}

Get an asset by qualified name

Get detailed information about a specific asset using its qualified name

path Parameters

qualifiedName

required

string

Asset qualified name

Responses

Response samples

200
404
500

Content type

application/json

{"created_at": "string",
"created_by": "string",
"description": "string",
"environments": {"property1": {"metadata": { },
"name": "string",
"path": "string"
},
"property2": {"metadata": { },
"name": "string",
"path": "string"
}
},
"external_links": [{"icon": "string",
"name": "string",
"url": "string"
}
],
"has_run_history": true,
"id": "string",
"is_stub": true,
"last_sync_at": "string",
"metadata": { },
"mrn": "string",
"name": "string",
"parent_mrn": "string",
"providers": ["string"
],
"query": "string",
"query_language": "string",
"schema": {"property1": "string",
"property2": "string"
},
"sources": [{"last_sync_at": "string",
"name": "string",
"priority": 0,
"properties": { }
}
],
"tags": ["string"
],
"type": "string",
"updated_at": "string",
"user_description": "string"
}

Search assets

Search for assets using query string and filters

query Parameters

q	string Search query
types	Array of strings Filter by asset types
services	Array of strings Filter by services
tags	Array of strings Filter by tags
limit	integer Default: 50 Number of items to return
offset	integer Default: 0 Number of items to skip
calculateCounts	boolean Default: false Calculate filter counts

Responses

Response samples

200
400
500

Content type

application/json

{"assets": [{"created_at": "string",
"created_by": "string",
"description": "string",
"environments": {"property1": {"metadata": { },
"name": "string",
"path": "string"
},
"property2": {"metadata": { },
"name": "string",
"path": "string"
}
},
"external_links": [{"icon": "string",
"name": "string",
"url": "string"
}
],
"has_run_history": true,
"id": "string",
"is_stub": true,
"last_sync_at": "string",
"metadata": { },
"mrn": "string",
"name": "string",
"parent_mrn": "string",
"providers": ["string"
],
"query": "string",
"query_language": "string",
"schema": {"property1": "string",
"property2": "string"
},
"sources": [{"last_sync_at": "string",
"name": "string",
"priority": 0,
"properties": { }
}
],
"tags": ["string"
],
"type": "string",
"updated_at": "string",
"user_description": "string"
}
],
"filters": {"providers": {"property1": 0,
"property2": 0
},
"tags": {"property1": 0,
"property2": 0
},
"types": {"property1": 0,
"property2": 0
}
},
"limit": 0,
"offset": 0,
"total": 0
}

Get metadata field suggestions

Get suggestions for metadata fields and their types

Responses

Response samples

200
500

Content type

application/json

[{"count": 0,
"example": null,
"field": "string",
"path_parts": ["string"
],
"type": "string",
"types": ["string"
]
}
]

Get metadata value suggestions

Get suggestions for values of a specific metadata field

query Parameters

field required	string Metadata field name
prefix	string Value prefix to filter by
limit	integer Default: 10 Maximum number of suggestions

Responses

Response samples

200
400
500

Content type

application/json

[{"count": 0,
"example": {"created_at": "string",
"created_by": "string",
"description": "string",
"environments": {"property1": {"metadata": { },
"name": "string",
"path": "string"
},
"property2": {"metadata": { },
"name": "string",
"path": "string"
}
},
"external_links": [{"icon": "string",
"name": "string",
"url": "string"
}
],
"has_run_history": true,
"id": "string",
"is_stub": true,
"last_sync_at": "string",
"metadata": { },
"mrn": "string",
"name": "string",
"parent_mrn": "string",
"providers": ["string"
],
"query": "string",
"query_language": "string",
"schema": {"property1": "string",
"property2": "string"
},
"sources": [{"last_sync_at": "string",
"name": "string",
"priority": 0,
"properties": { }
}
],
"tags": ["string"
],
"type": "string",
"updated_at": "string",
"user_description": "string"
},
"value": "string"
}
]

Get tag suggestions

Get suggestions for asset tags

query Parameters

prefix	string Tag prefix to filter by
limit	integer Default: 10 Maximum number of suggestions

Responses

Response samples

200
500

Content type

application/json

["string"
]

Get asset summary

Get the total count of assets by type

Responses

Response samples

200
500

Content type

application/json

{"services": {"property1": 0,
"property2": 0
},
"tags": {"property1": 0,
"property2": 0
},
"types": {"property1": 0,
"property2": 0
}
}

auth

Get auth configuration

Returns the enabled auth providers without sensitive data

Responses

Response samples

200

Content type

application/json

{"enabled_providers": ["string"
]
}

Handle Okta OAuth callback

Processes the OAuth callback from Okta

query Parameters

code required	string Authorization code
state required	string State parameter for CSRF protection

Responses

Response samples

307
400
500

Content type

application/json

"string"

Initiate Okta OAuth login

Redirects the user to Okta for authentication

Responses

Response samples

307
500

Content type

application/json

"string"

pipelines

Destroy pipeline

Delete all resources ever created by a pipeline (across all sources)

path Parameters

pipelineName

required

string

Pipeline Name

Responses

Response samples

200

Content type

application/json

{"assets_deleted": 0,
"deleted_entity_mrns": ["string"
],
"documentation_deleted": 0,
"lineage_deleted": 0
}

runs

List runs

Get paginated list of runs with filtering

query Parameters

pipelines	string Comma-separated list of pipeline names
statuses	string Comma-separated list of statuses
limit	integer Default: 50 Number of results per page
offset	integer Default: 0 Number of results to skip

Responses

Response samples

200

Content type

application/json

{"limit": 0,
"offset": 0,
"pipelines": ["string"
],
"runs": [{"completed_at": "string",
"config": { },
"created_by": "string",
"error_message": "string",
"id": "string",
"pipeline_name": "string",
"run_id": "string",
"source_name": "string",
"started_at": "string",
"status": "running",
"summary": {"assets_created": 0,
"assets_deleted": 0,
"assets_updated": 0,
"documentation_added": 0,
"duration_seconds": 0,
"errors_count": 0,
"lineage_created": 0,
"lineage_updated": 0,
"total_entities": 0
}
}
],
"total": 0
}

Get run

Get a specific run by ID

path Parameters

id

required

string

Run ID

Responses

Response samples

200

Content type

application/json

{"completed_at": "string",
"config": { },
"created_by": "string",
"error_message": "string",
"id": "string",
"pipeline_name": "string",
"run_id": "string",
"source_name": "string",
"started_at": "string",
"status": "running",
"summary": {"assets_created": 0,
"assets_deleted": 0,
"assets_updated": 0,
"documentation_added": 0,
"duration_seconds": 0,
"errors_count": 0,
"lineage_created": 0,
"lineage_updated": 0,
"total_entities": 0
}
}

Get run entities

Get paginated list of entities for a specific run

path Parameters

id

required

string

Run ID

query Parameters

entity_type	string Filter by entity type (asset, lineage, documentation)
status	string Filter by status (created, updated, deleted, failed)
limit	integer Default: 100 Number of results per page
offset	integer Default: 0 Number of results to skip

Responses

Response samples

200

Content type

application/json

{"entities": [{"created_at": "string",
"entity_mrn": "string",
"entity_name": "string",
"entity_type": "string",
"error_message": "string",
"id": "string",
"run_id": "string",
"status": "string"
}
],
"limit": 0,
"offset": 0,
"total": 0
}

Batch create assets

Create/update assets within a run

Request Body schema: application/json
required

Batch create request

required	Array of objects (runs.CreateAssetRequest) non-empty
	object (plugin.RawPluginConfig)
	Array of objects (runs.CreateDocRequest)
	Array of objects (runs.CreateLineageRequest)
pipeline_name required	string
run_id required	string
source_name required	string
	Array of objects (runs.CreateStatRequest)

Responses

Request samples

Payload

Content type

application/json

{"assets": [{"description": "string",
"external_links": [{"property1": "string",
"property2": "string"
}
],
"metadata": { },
"name": "string",
"providers": ["string"
],
"schema": { },
"sources": ["string"
],
"tags": ["string"
],
"type": "string"
}
],
"config": { },
"documentation": [{"asset_mrn": "string",
"content": "string",
"type": "string"
}
],
"lineage": [{"source": "string",
"target": "string",
"type": "string"
}
],
"pipeline_name": "string",
"run_id": "string",
"source_name": "string",
"statistics": [{"asset_mrn": "string",
"metric_name": "string",
"value": 0
}
]
}

Response samples

200

Content type

application/json

{"assets": [{"asset": null,
"error": "string",
"mrn": "string",
"name": "string",
"provider": "string",
"status": "string",
"type": "string"
}
],
"documentation": [{"asset_mrn": "string",
"error": "string",
"status": "string",
"type": "string"
}
],
"lineage": [{"error": "string",
"source": "string",
"status": "string",
"target": "string",
"type": "string"
}
],
"stale_entities_removed": ["string"
]
}

Cleanup stale runs

Mark runs as failed if they've been running too long without updates

Responses

Complete run

Complete a run with results

Request Body schema: application/json
required

Complete run request

error	string
run_id required	string
status required	string (plugin.RunStatus) Enum: "running" "completed" "failed" "cancelled"
	object (plugin.RunSummary)

Responses

Request samples

Payload

Content type

application/json

{"error": "string",
"run_id": "string",
"status": "running",
"summary": {"assets_created": 0,
"assets_deleted": 0,
"assets_updated": 0,
"documentation_added": 0,
"duration_seconds": 0,
"errors_count": 0,
"lineage_created": 0,
"lineage_updated": 0,
"total_entities": 0
}
}

Response samples

200

Content type

application/json

{"property1": "string",
"property2": "string"
}

Start run

Start a new run for tracking

Request Body schema: application/json
required

Start run request

	object (plugin.RawPluginConfig)
pipeline_name required	string
source_name required	string

Responses

Request samples

Payload

Content type

application/json

{"config": { },
"pipeline_name": "string",
"source_name": "string"
}

Response samples

200

Content type

application/json

{"completed_at": "string",
"config": { },
"created_by": "string",
"error_message": "string",
"id": "string",
"pipeline_name": "string",
"run_id": "string",
"source_name": "string",
"started_at": "string",
"status": "running",
"summary": {"assets_created": 0,
"assets_deleted": 0,
"assets_updated": 0,
"documentation_added": 0,
"duration_seconds": 0,
"errors_count": 0,
"lineage_created": 0,
"lineage_updated": 0,
"total_entities": 0
}
}

search

Unified search

Search across assets, glossary terms, teams, and users

query Parameters

q required	string Search query
types	Array of strings Filter by result types (asset, glossary, team, user)
limit	integer Default: 20 Limit
offset	integer Default: 0 Offset

Responses

Response samples

200
400
500

Content type

application/json

{"facets": {"asset_types": [{"count": 0,
"value": "string"
}
],
"providers": [{"count": 0,
"value": "string"
}
],
"tags": [{"count": 0,
"value": "string"
}
],
"types": {"property1": 0,
"property2": 0
}
},
"limit": 0,
"offset": 0,
"results": [{"description": "string",
"id": "string",
"metadata": { },
"name": "string",
"rank": 0,
"type": "asset",
"updated_at": "string",
"url": "string"
}
],
"total": 0
}

ui

Get UI configuration

Get UI configuration including banner settings

Responses

Response samples

200

Content type

application/json

{"banner": {"dismissible": true,
"enabled": true,
"id": "string",
"message": "string",
"variant": "string"
}
}

users

List users

Get a list of users with optional filtering

query Parameters

limit	integer Default: 50 Number of items to return
offset	integer Default: 0 Number of items to skip
query	string Search query for username or email
role_ids	Array of strings Filter by role IDs
active	boolean Filter by active status

Responses

Response samples

200
500

Content type

application/json

{"limit": 0,
"offset": 0,
"total": 0,
"users": [{"active": true,
"created_at": "string",
"id": "string",
"must_change_password": true,
"name": "string",
"preferences": { },
"roles": [{"description": "string",
"id": "string",
"name": "string",
"permissions": [{"action": "string",
"description": "string",
"id": "string",
"name": "string",
"resource_type": "string"
}
]
}
],
"updated_at": "string",
"username": "string"
}
]
}

Create a new user

Create a new user in the system

Request Body schema: application/json
required

User creation request

name required	string
oauth_provider	string
	object
oauth_provider_id	string
password	string >= 8 characters
role_names required	Array of strings non-empty
username required	string [ 3 .. 255 ] characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"oauth_provider": "string",
"oauth_provider_data": { },
"oauth_provider_id": "string",
"password": "stringst",
"role_names": ["string"
],
"username": "string"
}

Response samples

200
400
409

Content type

application/json

{"active": true,
"created_at": "string",
"id": "string",
"must_change_password": true,
"name": "string",
"preferences": { },
"roles": [{"description": "string",
"id": "string",
"name": "string",
"permissions": [{"action": "string",
"description": "string",
"id": "string",
"name": "string",
"resource_type": "string"
}
]
}
],
"updated_at": "string",
"username": "string"
}

Delete a user

Delete a user from the system

path Parameters

id

required

string

User ID

Responses

Response samples

404
500

Content type

application/json

{"error": "string"
}

Get a user by ID

Get detailed information about a specific user

path Parameters

id

required

string

User ID

Responses

Response samples

200
404
500

Content type

application/json

{"active": true,
"created_at": "string",
"id": "string",
"must_change_password": true,
"name": "string",
"preferences": { },
"roles": [{"description": "string",
"id": "string",
"name": "string",
"permissions": [{"action": "string",
"description": "string",
"id": "string",
"name": "string",
"resource_type": "string"
}
]
}
],
"updated_at": "string",
"username": "string"
}

Update a user

Update user information

path Parameters

id

required

string

User ID

Request Body schema: application/json
required

User update request

active	boolean
email	string
name	string
password	string >= 8 characters
	object
role_names	Array of strings non-empty

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"email": "string",
"name": "string",
"password": "stringst",
"preferences": { },
"role_names": ["string"
]
}

Response samples

200
400
404

Content type

application/json

{"active": true,
"created_at": "string",
"id": "string",
"must_change_password": true,
"name": "string",
"preferences": { },
"roles": [{"description": "string",
"id": "string",
"name": "string",
"permissions": [{"action": "string",
"description": "string",
"id": "string",
"name": "string",
"resource_type": "string"
}
]
}
],
"updated_at": "string",
"username": "string"
}

List API keys

Get all API keys for a user

Responses

Response samples

200
500

Content type

application/json

[{"created_at": "string",
"expires_at": "string",
"id": "string",
"key": "string",
"last_used_at": "string",
"name": "string",
"user_id": "string"
}
]

Create API key

Create a new API key for a user

Request Body schema: application/json
required

API key creation request

expires_in_days	integer
name required	string

Responses

Request samples

Payload

Content type

application/json

{"expires_in_days": 0,
"name": "string"
}

Response samples

200
400

Content type

application/json

{"created_at": "string",
"expires_at": "string",
"id": "string",
"key": "string",
"last_used_at": "string",
"name": "string",
"user_id": "string"
}

Delete API key

Delete an API key

path Parameters

id

required

string

API key ID

Responses

Response samples

400

Content type

application/json

{"error": "string"
}

Login user

Authenticate a user with username/email and password

Request Body schema: application/json
required

Login credentials

password required	string
username required	string

Responses

Request samples

Payload

Content type

application/json

{"password": "string",
"username": "string"
}

Response samples

200
400
401

Content type

application/json

{"access_token": "string",
"expires_in": 0,
"requires_password_change": true,
"token_type": "string"
}

Get current user profile

Get detailed information about the currently authenticated user

Authorizations:

None

Responses

Response samples

200
401

Content type

application/json

{"active": true,
"created_at": "string",
"id": "string",
"must_change_password": true,
"name": "string",
"preferences": { },
"roles": [{"description": "string",
"id": "string",
"name": "string",
"permissions": [{"action": "string",
"description": "string",
"id": "string",
"name": "string",
"resource_type": "string"
}
]
}
],
"updated_at": "string",
"username": "string"
}

Link OAuth account

Link an OAuth account to an existing user

Request Body schema: application/json
required

OAuth account link request

provider required	string
provider_user_id required	string
user_id required	string
required	object

Responses

Request samples

Payload

Content type

application/json

{"provider": "string",
"provider_user_id": "string",
"user_id": "string",
"user_info": { }
}

Response samples

400

Content type

application/json

{"error": "string"
}

Unlink OAuth account

Unlink an OAuth account from a user

path Parameters

id required	string User ID
provider required	string OAuth provider

Responses

Response samples

400

Content type

application/json

{"error": "string"
}

Update user preferences

Update preferences for the current user

Request Body schema: application/json
required

User preferences

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

400

Content type

application/json

{"error": "string"
}

Update user password

Update current user's password

Request Body schema: application/json
required

Password update request

new_password

required

string >= 8 characters

Responses

Request samples

Payload

Content type

application/json

{"new_password": "stringst"
}

Response samples

200
400
401

Content type

application/json

{"access_token": "string",
"expires_in": 0,
"requires_password_change": true,
"token_type": "string"
}

Marmot API (0.1)

ingestion

List ingestion job runs

query Parameters

Responses

Response samples

Get a job run by ID

path Parameters

Responses

Response samples

Cancel a running job

path Parameters

Responses

Get entities for a job run

path Parameters

query Parameters

Responses

Response samples

List ingestion schedules

query Parameters

Responses

Response samples

Create a new ingestion schedule

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete an ingestion schedule

path Parameters

Responses

Get an ingestion schedule by ID

path Parameters

Responses

Response samples

Update an ingestion schedule

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Manually trigger an ingestion schedule

path Parameters

Responses

Validate plugin configuration

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

lineage

Ingest OpenLineage event

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get asset lineage

path Parameters

query Parameters

Responses

Response samples

Batch create lineage edges

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create direct lineage

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete direct lineage

path Parameters

Responses

Response samples

Get direct lineage by ID

path Parameters

Responses

Response samples

metrics

Get metrics for UI

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required