Skip to main content
API docs by Redocly

Marmot API (0.1)

Download OpenAPI specification:Download

License: MIT

API for interacting with Marmot

admin

Get reindex status

Check whether a search reindex is currently running and whether Elasticsearch is configured.

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "es_configured": true,
  • "running": true
}

Start search reindex

Trigger a full reindex from PostgreSQL to Elasticsearch. The reindex runs asynchronously in the background. Only one reindex can run at a time.

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Reindex started",
  • "status": "accepted"
}

agents

Agent activity

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
asset_id
required
string

Agent asset id

query Parameters
period
string

Lookback window (e.g. 24h, 7d). Default 24h.

Responses

Response samples

Content type
application/json
{
  • "buckets": [
    ]
}

List agent runs

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
asset_id
required
string

Agent asset id

query Parameters
period
string

Lookback window (e.g. 24h, 7d). Default 24h.

limit
integer

Max number of runs to return

Responses

Response samples

Content type
application/json
{
  • "runs": [
    ],
  • "total": 0
}

Agent stats

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
asset_id
required
string

Agent asset id

query Parameters
period
string

Lookback window (e.g. 24h, 7d). Default 24h.

Responses

Response samples

Content type
application/json
{
  • "median_latency_ms": 0,
  • "p95_latency_ms": 0,
  • "run_count": 0,
  • "success_rate": 0,
  • "tokens_in": 0,
  • "tokens_out": 0
}

Record agent run

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Agent run record

agent_mrn
string
ended_at
string
error
string
model
string
observed_assets
Array of strings
run_id
string
started_at
string
status
string
tokens_in
integer
tokens_out
integer
Array of objects (ToolCallPayload)

Responses

Request samples

Content type
application/json
{
  • "agent_mrn": "string",
  • "ended_at": "string",
  • "error": "string",
  • "model": "string",
  • "observed_assets": [
    ],
  • "run_id": "string",
  • "started_at": "string",
  • "status": "string",
  • "tokens_in": 0,
  • "tokens_out": 0,
  • "tool_calls": [
    ]
}

Response samples

Content type
application/json
{
  • "agent_id": "string",
  • "created_at": "string",
  • "duration_ms": 0,
  • "ended_at": "string",
  • "error": "string",
  • "id": "string",
  • "model": "string",
  • "run_id": "string",
  • "started_at": "string",
  • "status": "string",
  • "tokens_in": 0,
  • "tokens_out": 0,
  • "tool_calls": [
    ]
}

asset-rules

Create an asset rule

Create a new asset rule that applies enrichments to matching assets

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Asset rule creation request

description
string
is_enabled
boolean
Array of objects (AssetRuleExternalLink)
metadata_field
string
name
string
pattern_type
string
pattern_value
string
priority
integer
query_expression
string
rule_type
string
term_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "is_enabled": true,
  • "links": [
    ],
  • "metadata_field": "string",
  • "name": "string",
  • "pattern_type": "string",
  • "pattern_value": "string",
  • "priority": 0,
  • "query_expression": "string",
  • "rule_type": "string",
  • "term_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "id": "string",
  • "is_enabled": true,
  • "last_reconciled_at": "string",
  • "links": [
    ],
  • "membership_count": 0,
  • "metadata_field": "string",
  • "name": "string",
  • "pattern_type": "string",
  • "pattern_value": "string",
  • "priority": 0,
  • "query_expression": "string",
  • "reconciliation_hash": "string",
  • "rule_type": "query",
  • "term_ids": [
    ],
  • "updated_at": "string"
}

Delete an asset rule

Delete an asset rule by ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Asset rule ID

Responses

Get an asset rule

Get an asset rule by ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Asset rule ID

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "id": "string",
  • "is_enabled": true,
  • "last_reconciled_at": "string",
  • "links": [
    ],
  • "membership_count": 0,
  • "metadata_field": "string",
  • "name": "string",
  • "pattern_type": "string",
  • "pattern_value": "string",
  • "priority": 0,
  • "query_expression": "string",
  • "reconciliation_hash": "string",
  • "rule_type": "query",
  • "term_ids": [
    ],
  • "updated_at": "string"
}

Update an asset rule

Update an existing asset rule

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Asset rule ID

Request Body schema: application/json
required

Asset rule update request

description
string
is_enabled
boolean
Array of objects (AssetRuleExternalLink)
metadata_field
string
name
string
pattern_type
string
pattern_value
string
priority
integer
query_expression
string
rule_type
string
term_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "is_enabled": true,
  • "links": [
    ],
  • "metadata_field": "string",
  • "name": "string",
  • "pattern_type": "string",
  • "pattern_value": "string",
  • "priority": 0,
  • "query_expression": "string",
  • "rule_type": "string",
  • "term_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "id": "string",
  • "is_enabled": true,
  • "last_reconciled_at": "string",
  • "links": [
    ],
  • "membership_count": 0,
  • "metadata_field": "string",
  • "name": "string",
  • "pattern_type": "string",
  • "pattern_value": "string",
  • "priority": 0,
  • "query_expression": "string",
  • "reconciliation_hash": "string",
  • "rule_type": "query",
  • "term_ids": [
    ],
  • "updated_at": "string"
}

Get assets matched by a rule

Get the list of asset IDs matched by an asset rule

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Asset rule ID

query Parameters
limit
integer
Default: 50

Number of items to return

offset
integer
Default: 0

Number of items to skip

Responses

Response samples

Content type
application/json
{ }

List asset rules

List all asset rules with pagination

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
limit
integer
Default: 50

Number of items to return

offset
integer
Default: 0

Number of items to skip

Responses

Response samples

Content type
application/json
{
  • "asset_rules": [
    ],
  • "total": 0
}

Preview an asset rule

Preview which assets would match a rule configuration

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Rule preview request

limit
integer
metadata_field
string
pattern_type
string
pattern_value
string
query_expression
string
rule_type
string

Responses

Request samples

Content type
application/json
{
  • "limit": 0,
  • "metadata_field": "string",
  • "pattern_type": "string",
  • "pattern_value": "string",
  • "query_expression": "string",
  • "rule_type": "string"
}

Response samples

Content type
application/json
{
  • "asset_count": 0,
  • "asset_ids": [
    ],
  • "errors": [
    ]
}

Search asset rules

Search asset rules by name

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
query
string

Search query

limit
integer
Default: 50

Number of items to return

offset
integer
Default: 0

Number of items to skip

Responses

Response samples

Content type
application/json
{
  • "asset_rules": [
    ],
  • "total": 0
}

assets

Create a new asset

Create a new asset in the system

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Asset creation request

description
string
object
Array of objects (AssetExternalLink)
object
name
required
string
providers
required
Array of strings
object
Array of objects (AssetSource)
tags
Array of strings
type
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "environments": {
    },
  • "external_links": [
    ],
  • "metadata": { },
  • "name": "string",
  • "providers": [
    ],
  • "schema": {
    },
  • "sources": [
    ],
  • "tags": [
    ],
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "environments": {
    },
  • "external_links": [
    ],
  • "has_run_history": true,
  • "id": "string",
  • "is_stub": true,
  • "last_sync_at": "string",
  • "metadata": { },
  • "mrn": "string",
  • "name": "string",
  • "parent_mrn": "string",
  • "providers": [
    ],
  • "query": "string",
  • "query_language": "string",
  • "schema": {
    },
  • "sources": [
    ],
  • "tags": [
    ],
  • "terms": [
    ],
  • "type": "string",
  • "updated_at": "string",
  • "user_description": "string"
}

Delete an asset

Delete an asset from the system

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Asset ID

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Get an asset by ID

Get detailed information about a specific asset

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Asset ID

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "environments": {
    },
  • "external_links": [
    ],
  • "has_run_history": true,
  • "id": "string",
  • "is_stub": true,
  • "last_sync_at": "string",
  • "metadata": { },
  • "mrn": "string",
  • "name": "string",
  • "parent_mrn": "string",
  • "providers": [
    ],
  • "query": "string",
  • "query_language": "string",
  • "schema": {
    },
  • "sources": [
    ],
  • "tags": [
    ],
  • "terms": [
    ],
  • "type": "string",
  • "updated_at": "string",
  • "user_description": "string"
}

Update an asset

Update an existing asset's information

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Asset ID

Request Body schema: application/json
required

Asset update request

description
string
object
Array of objects (AssetExternalLink)
object
name
string
providers
Array of strings
object
Array of objects (AssetSource)
tags
Array of strings
type
string
user_description
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "environments": {
    },
  • "external_links": [
    ],
  • "metadata": { },
  • "name": "string",
  • "providers": [
    ],
  • "schema": {
    },
  • "sources": [
    ],
  • "tags": [
    ],
  • "type": "string",
  • "user_description": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "environments": {
    },
  • "external_links": [
    ],
  • "has_run_history": true,
  • "id": "string",
  • "is_stub": true,
  • "last_sync_at": "string",
  • "metadata": { },
  • "mrn": "string",
  • "name": "string",
  • "parent_mrn": "string",
  • "providers": [
    ],
  • "query": "string",
  • "query_language": "string",
  • "schema": {
    },
  • "sources": [
    ],
  • "tags": [
    ],
  • "terms": [
    ],
  • "type": "string",
  • "updated_at": "string",
  • "user_description": "string"
}

Get assets by glossary term

Retrieve all assets associated with a specific glossary term

Authorizations:
ApiKeyAuthBearerAuth
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

Content type
application/json
{ }

Create asset documentation

Create or update documentation for an asset

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Documentation creation request

content
required
string
mrn
required
string
source
required
string

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "mrn": "string",
  • "source": "string"
}

Response samples

Content type
application/json
{
  • "content": "string",
  • "created_at": "string",
  • "global_docs": [
    ],
  • "id": "string",
  • "mrn": "string",
  • "source": "string",
  • "updated_at": "string"
}

Get asset documentation

Get documentation for a specific asset

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
mrn
required
string <url>

Asset MRN

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Batch create documentation

Create or update documentation for multiple assets

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Batch documentation request

required
Array of objects (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

Content type
application/json
{
  • "documentation": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Lookup asset by type, service, and name

Get an asset by its type, service (provider), and name

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
type
required
string

Asset type

service
required
string

Service/Provider name

name
required
string

Asset name

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "environments": {
    },
  • "external_links": [
    ],
  • "has_run_history": true,
  • "id": "string",
  • "is_stub": true,
  • "last_sync_at": "string",
  • "metadata": { },
  • "mrn": "string",
  • "name": "string",
  • "parent_mrn": "string",
  • "providers": [
    ],
  • "query": "string",
  • "query_language": "string",
  • "schema": {
    },
  • "sources": [
    ],
  • "tags": [
    ],
  • "terms": [
    ],
  • "type": "string",
  • "updated_at": "string",
  • "user_description": "string"
}

Match asset pattern

Find assets matching a pattern

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
pattern
required
string

Asset pattern to match

type
required
string

Asset type

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get user's assets

Get assets owned by the current user or their teams

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
limit
integer
Default: 20

Limit

offset
integer
Default: 0

Offset

Responses

Response samples

Content type
application/json
{
  • "assets": [
    ],
  • "filters": {
    },
  • "limit": 0,
  • "offset": 0,
  • "total": 0
}

Get preview data for an asset

Fetches sample data from the asset's data source. Requires assets:preview permission.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Asset ID

Responses

Response samples

Content type
application/json
{
  • "column_names": [
    ],
  • "rows": [
    ],
  • "total_rows": 0
}

Get an asset by qualified name

Get detailed information about a specific asset using its qualified name

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
name
required
string

Asset qualified name

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "environments": {
    },
  • "external_links": [
    ],
  • "has_run_history": true,
  • "id": "string",
  • "is_stub": true,
  • "last_sync_at": "string",
  • "metadata": { },
  • "mrn": "string",
  • "name": "string",
  • "parent_mrn": "string",
  • "providers": [
    ],
  • "query": "string",
  • "query_language": "string",
  • "schema": {
    },
  • "sources": [
    ],
  • "tags": [
    ],
  • "terms": [
    ],
  • "type": "string",
  • "updated_at": "string",
  • "user_description": "string"
}

Get asset run history histogram

Get histogram data for asset run history over specified period

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Asset ID

query Parameters
period
string
Default: "30d"

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

Responses

Response samples

Content type
application/json
{
  • "buckets": [
    ],
  • "period": "string"
}

Get asset run history

Get paginated run history for a specific asset

Authorizations:
ApiKeyAuthBearerAuth
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

Content type
application/json
{
  • "limit": 0,
  • "offset": 0,
  • "run_history": [
    ],
  • "total": 0
}

Search assets

Search for assets using query string and filters

Authorizations:
ApiKeyAuthBearerAuth
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

Content type
application/json
{
  • "assets": [
    ],
  • "filters": {
    },
  • "limit": 0,
  • "offset": 0,
  • "total": 0
}

Get metadata field suggestions

Get suggestions for metadata fields and their types

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get metadata value suggestions

Get suggestions for values of a specific metadata field

Authorizations:
ApiKeyAuthBearerAuth
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

Content type
application/json
[
  • {
    }
]

Get tag suggestions

Get suggestions for asset tags

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
prefix
string

Tag prefix to filter by

limit
integer
Default: 10

Maximum number of suggestions

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get asset summary

Get the total count of assets by type

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "providers": {
    },
  • "tags": {
    },
  • "types": {
    }
}

Remove tag from asset

Remove a tag from an existing asset

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Asset ID

Request Body schema: application/json
required

Tag to remove

tag
required
string

Responses

Request samples

Content type
application/json
{
  • "tag": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "environments": {
    },
  • "external_links": [
    ],
  • "has_run_history": true,
  • "id": "string",
  • "is_stub": true,
  • "last_sync_at": "string",
  • "metadata": { },
  • "mrn": "string",
  • "name": "string",
  • "parent_mrn": "string",
  • "providers": [
    ],
  • "query": "string",
  • "query_language": "string",
  • "schema": {
    },
  • "sources": [
    ],
  • "tags": [
    ],
  • "terms": [
    ],
  • "type": "string",
  • "updated_at": "string",
  • "user_description": "string"
}

Add tag to asset

Add a new tag to an existing asset

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Asset ID

Request Body schema: application/json
required

Tag to add

tag
required
string

Responses

Request samples

Content type
application/json
{
  • "tag": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "environments": {
    },
  • "external_links": [
    ],
  • "has_run_history": true,
  • "id": "string",
  • "is_stub": true,
  • "last_sync_at": "string",
  • "metadata": { },
  • "mrn": "string",
  • "name": "string",
  • "parent_mrn": "string",
  • "providers": [
    ],
  • "query": "string",
  • "query_language": "string",
  • "schema": {
    },
  • "sources": [
    ],
  • "tags": [
    ],
  • "terms": [
    ],
  • "type": "string",
  • "updated_at": "string",
  • "user_description": "string"
}

Remove glossary term from asset

Remove a glossary term association from an asset

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Asset ID

Request Body schema: application/json
required

Term ID to remove

term_id
required
string

Responses

Request samples

Content type
application/json
{
  • "term_id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get asset's glossary terms

Retrieve all glossary terms associated with an asset

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Asset ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add glossary terms to asset

Associate one or more glossary terms with an asset

Authorizations:
ApiKeyAuthBearerAuth
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

Content type
application/json
{
  • "term_ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

glossary

Create glossary term

Create a new glossary term with name, definition, and optional metadata

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Glossary term to create

definition
required
string
description
string
object
name
required
string
Array of objects (OwnerRequest)
parent_term_id
string

Responses

Request samples

Content type
application/json
{
  • "definition": "string",
  • "description": "string",
  • "metadata": { },
  • "name": "string",
  • "owners": [
    ],
  • "parent_term_id": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "definition": "string",
  • "deleted_at": "string",
  • "description": "string",
  • "id": "string",
  • "metadata": { },
  • "name": "string",
  • "owners": [
    ],
  • "parent_term_id": "string",
  • "tags": [
    ],
  • "updated_at": "string",
  • "user_definition": "string"
}

Delete glossary term

Delete a glossary term by its ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Glossary Term ID

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get glossary term

Retrieve a glossary term by its ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Glossary Term ID

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "definition": "string",
  • "deleted_at": "string",
  • "description": "string",
  • "id": "string",
  • "metadata": { },
  • "name": "string",
  • "owners": [
    ],
  • "parent_term_id": "string",
  • "tags": [
    ],
  • "updated_at": "string",
  • "user_definition": "string"
}

Update glossary term

Update an existing glossary term by its ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Glossary Term ID

Request Body schema: application/json
required

Glossary term update data

definition
string
description
string
object
name
string
Array of objects (OwnerRequest)
parent_term_id
string

Responses

Request samples

Content type
application/json
{
  • "definition": "string",
  • "description": "string",
  • "metadata": { },
  • "name": "string",
  • "owners": [
    ],
  • "parent_term_id": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "definition": "string",
  • "deleted_at": "string",
  • "description": "string",
  • "id": "string",
  • "metadata": { },
  • "name": "string",
  • "owners": [
    ],
  • "parent_term_id": "string",
  • "tags": [
    ],
  • "updated_at": "string",
  • "user_definition": "string"
}

Get ancestor terms

Retrieve all ancestor terms of a glossary term (parent chain)

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Term ID

Responses

Response samples

Content type
application/json
{ }

Get child terms

Retrieve all child terms of a glossary term

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Parent Term ID

Responses

Response samples

Content type
application/json
{ }

List glossary terms

Retrieve a paginated list of all glossary terms

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
limit
integer
Default: 20

Maximum number of terms to return

offset
integer
Default: 0

Number of terms to skip

Responses

Response samples

Content type
application/json
{
  • "terms": [
    ],
  • "total": 0
}

Search glossary terms

Search for glossary terms by query string and filters

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
q
string

Search query

parent_term_id
string

Filter by parent term ID

limit
integer
Default: 20

Maximum number of terms to return

offset
integer
Default: 0

Number of terms to skip

Responses

Response samples

Content type
application/json
{
  • "terms": [
    ],
  • "total": 0
}

ingestion

List ingestion job runs

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
schedule_id
string

Filter by schedule ID

status
string

Filter by status

limit
integer

Limit

offset
integer

Offset

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "offset": 0,
  • "runs": [
    ],
  • "total": 0
}

Get a job run by ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Job run ID

Responses

Response samples

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

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Job run ID

Responses

Get entities for a job run

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Job run ID

query Parameters
limit
integer

Limit

offset
integer

Offset

Responses

Response samples

Content type
application/json
{ }

List ingestion schedules

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
enabled
boolean

Filter by enabled status

limit
integer

Limit

offset
integer

Offset

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "offset": 0,
  • "schedules": [
    ],
  • "total": 0
}

Create a new ingestion schedule

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Schedule configuration

object
cron_expression
string
enabled
boolean
ingest_on_query
boolean

IngestOnQuery refreshes the source's catalog in the background after data queries, rate-limited per source.

name
string
plugin_id
string
queryable
boolean

Queryable lets agents and users query this source through Marmot; the plugin must support queries.

Responses

Request samples

Content type
application/json
{
  • "config": { },
  • "cron_expression": "string",
  • "enabled": true,
  • "ingest_on_query": true,
  • "name": "string",
  • "plugin_id": "string",
  • "queryable": true
}

Response samples

Content type
application/json
{
  • "config": { },
  • "created_at": "string",
  • "created_by": "string",
  • "cron_expression": "string",
  • "enabled": true,
  • "id": "string",
  • "ingest_on_query": true,
  • "last_run_at": "string",
  • "last_run_status": "string",
  • "managed_by": "string",
  • "name": "string",
  • "next_run_at": "string",
  • "plugin_id": "string",
  • "queryable": true,
  • "served_by_id": "string",
  • "served_by_type": "string",
  • "updated_at": "string"
}

Delete an ingestion schedule

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Schedule ID

Responses

Get an ingestion schedule by ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Schedule ID

Responses

Response samples

Content type
application/json
{
  • "config": { },
  • "created_at": "string",
  • "created_by": "string",
  • "cron_expression": "string",
  • "enabled": true,
  • "id": "string",
  • "ingest_on_query": true,
  • "last_run_at": "string",
  • "last_run_status": "string",
  • "managed_by": "string",
  • "name": "string",
  • "next_run_at": "string",
  • "plugin_id": "string",
  • "queryable": true,
  • "served_by_id": "string",
  • "served_by_type": "string",
  • "updated_at": "string"
}

Update an ingestion schedule

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Schedule ID

Request Body schema: application/json
required

Updated schedule configuration

object
cron_expression
string
enabled
boolean
ingest_on_query
boolean

IngestOnQuery refreshes the source's catalog in the background after data queries, rate-limited per source.

name
string
plugin_id
string
queryable
boolean

Queryable lets agents and users query this source through Marmot; the plugin must support queries.

Responses

Request samples

Content type
application/json
{
  • "config": { },
  • "cron_expression": "string",
  • "enabled": true,
  • "ingest_on_query": true,
  • "name": "string",
  • "plugin_id": "string",
  • "queryable": true
}

Response samples

Content type
application/json
{
  • "config": { },
  • "created_at": "string",
  • "created_by": "string",
  • "cron_expression": "string",
  • "enabled": true,
  • "id": "string",
  • "ingest_on_query": true,
  • "last_run_at": "string",
  • "last_run_status": "string",
  • "managed_by": "string",
  • "name": "string",
  • "next_run_at": "string",
  • "plugin_id": "string",
  • "queryable": true,
  • "served_by_id": "string",
  • "served_by_type": "string",
  • "updated_at": "string"
}

Manually trigger an ingestion schedule

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Schedule ID

Responses

Validate plugin configuration

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Config to validate

object
plugin_id
string

Responses

Request samples

Content type
application/json
{
  • "config": { },
  • "plugin_id": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "valid": true
}

lineage

Ingest OpenLineage event

Process OpenLineage run events and update assets/lineage accordingly

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

OpenLineage run event

eventTime
string
eventType
string
Array of objects (Dataset)
object (Job)
Array of objects (Dataset)
producer
string
object (LineageRun)
schemaURL
string

Responses

Request samples

Content type
application/json
{
  • "eventTime": "string",
  • "eventType": "string",
  • "inputs": [
    ],
  • "job": {
    },
  • "outputs": [
    ],
  • "producer": "string",
  • "run": {
    },
  • "schemaURL": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Get asset lineage

Get upstream and downstream lineage for a specific asset

Authorizations:
ApiKeyAuthBearerAuth
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)

exclude_types
string

Comma separated edge types to leave out, for example CONTAINS to see data flow without structure

Responses

Response samples

Content type
application/json
{
  • "edges": [
    ],
  • "nodes": [
    ]
}

Batch create lineage edges

Create lineage edges in batch

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Array of lineage edges to create

Array
id
string
job_mrn
string
last_seen_at
string
observation_count
integer
origin
string
source
string
target
string
type
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Create direct lineage

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

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Lineage edge to create

id
string
job_mrn
string
last_seen_at
string
observation_count
integer
origin
string
source
string
target
string
type
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "job_mrn": "string",
  • "last_seen_at": "string",
  • "observation_count": 0,
  • "origin": "string",
  • "source": "string",
  • "target": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "job_mrn": "string",
  • "last_seen_at": "string",
  • "observation_count": 0,
  • "origin": "string",
  • "source": "string",
  • "target": "string",
  • "type": "string"
}

Delete direct lineage

Delete a direct lineage connection by its ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string <uuid>

Edge ID

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Get direct lineage by ID

Get a specific direct lineage connection by its ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string <uuid>

Edge ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "job_mrn": "string",
  • "last_seen_at": "string",
  • "observation_count": 0,
  • "origin": "string",
  • "source": "string",
  • "target": "string",
  • "type": "string"
}

mcp

MCP endpoint

JSON-RPC 2.0 over the MCP Streamable HTTP transport. Requires assets:view, glossary:view and teams:view.

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

JSON-RPC 2.0 request

property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

metrics

Get metrics for UI

Get aggregated metrics for dashboard display

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
start
required
string

Start time (ISO 8601)

end
required
string

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

Content type
application/json
{
  • "metrics": [
    ],
  • "query": {
    }
}

Get assets by owner

Get asset counts grouped by owner

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "assets": {
    }
}

Get assets by provider

Get asset counts grouped by provider

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "assets": {
    }
}

Get assets by type

Get asset counts grouped by type

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "assets": {
    }
}

Get total assets count

Get the total number of assets

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Get assets with schemas count

Get the count of assets that have schemas defined

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "percentage": 0,
  • "total": 0
}

Get top viewed assets

Get the most viewed assets

Authorizations:
ApiKeyAuthBearerAuth
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

Content type
application/json
[
  • {
    }
]

Get top search queries

Get the most popular search queries

Authorizations:
ApiKeyAuthBearerAuth
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

Content type
application/json
[
  • {
    }
]

owners

Search owners

Search for asset owners (users and teams)

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
q
required
string

Search query

limit
integer
Default: 20

Maximum number of results

Responses

Response samples

Content type
application/json
{
  • "owners": [
    ]
}

roles

List all permissions

List all defined permissions grouped by resource type

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List roles

List all active roles with user counts and permissions

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a role

Create a new role with optional initial permissions, named by id or by resource_type:action key. The body may be JSON or YAML.

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema:
required

Role creation request

description
string
name
string
permission_ids
Array of strings
permission_keys
Array of strings

PermissionKeys names permissions as resource_type:action keys, the form a hand-written role document uses.

Responses

Request samples

Content type
{
  • "description": "string",
  • "name": "string",
  • "permission_ids": [
    ],
  • "permission_keys": [
    ]
}

Response samples

Content type
{
  • "created_at": "string",
  • "deleted_at": "string",
  • "description": "string",
  • "id": "string",
  • "is_system": true,
  • "name": "string",
  • "permission_keys": [
    ],
  • "permissions": [
    ],
  • "updated_at": "string",
  • "user_count": 0
}

Delete a role

Soft-delete a role. Fails if the role is a system role or has active user assignments.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Role ID

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Get a role

Get a role by ID with its permissions

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Role ID

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "deleted_at": "string",
  • "description": "string",
  • "id": "string",
  • "is_system": true,
  • "name": "string",
  • "permission_keys": [
    ],
  • "permissions": [
    ],
  • "updated_at": "string",
  • "user_count": 0
}

Update a role

Update a role's name or description. System roles cannot be renamed.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Role ID

Request Body schema: application/json
required

Role update request

description
string
name
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "deleted_at": "string",
  • "description": "string",
  • "id": "string",
  • "is_system": true,
  • "name": "string",
  • "permission_keys": [
    ],
  • "permissions": [
    ],
  • "updated_at": "string",
  • "user_count": 0
}

Replace role permissions

Atomically replace all permissions on a role, named by id or by resource_type:action key. System roles enforce a minimum permission floor.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Role ID

Request Body schema: application/json
required

Permission IDs to assign

permission_ids
Array of strings
permission_keys
Array of strings

PermissionKeys names permissions as resource_type:action keys. They are added to PermIDs.

Responses

Request samples

Content type
application/json
{
  • "permission_ids": [
    ],
  • "permission_keys": [
    ]
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "deleted_at": "string",
  • "description": "string",
  • "id": "string",
  • "is_system": true,
  • "name": "string",
  • "permission_keys": [
    ],
  • "permissions": [
    ],
  • "updated_at": "string",
  • "user_count": 0
}

Role document schema

The JSON Schema a role document follows, for editors and tooling.

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{ }

Validate a role document

Checks a role document, in JSON or YAML, without saving it, and lists every problem found with where it is, so an editor can mark each one. Pass id to check an edit to an existing role, so it keeping its own name is not reported as a clash.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
id
string

ID of the role being edited

Request Body schema:
required

Role document

description
string
name
string
permission_ids
Array of strings
permission_keys
Array of strings

PermissionKeys names permissions as resource_type:action keys, the form a hand-written role document uses.

Responses

Request samples

Content type
{
  • "description": "string",
  • "name": "string",
  • "permission_ids": [
    ],
  • "permission_keys": [
    ]
}

Response samples

Content type
application/json
{
  • "problems": [
    ],
  • "valid": true
}

pipelines

Destroy pipeline

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

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
pipelineName
required
string

Pipeline Name

Responses

Response samples

Content type
application/json
{
  • "assets_deleted": 0,
  • "deleted_entity_mrns": [
    ],
  • "documentation_deleted": 0,
  • "lineage_deleted": 0
}

plugins

List registered plugins

Responses

Response samples

Content type
application/json
{
  • "loading": true,
  • "plugins": [
    ]
}

Get AWS credential detection status

Detects if AWS credentials are available from environment or config files

Responses

Response samples

Content type
application/json
{
  • "available": true,
  • "error": "string",
  • "sources": [
    ]
}

products

Create data product

Create a new data product with owners and optional membership rules

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Data product to create

description
string
object
name
required
string
Array of objects (DataProductOwnerRequest)
Array of objects (DataProductRuleRequest)
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "metadata": { },
  • "name": "string",
  • "owners": [
    ],
  • "rules": [
    ],
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "asset_count": 0,
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "icon_url": "string",
  • "id": "string",
  • "manual_asset_count": 0,
  • "metadata": { },
  • "name": "string",
  • "owners": [
    ],
  • "rule_asset_count": 0,
  • "rules": [
    ],
  • "tags": [
    ],
  • "updated_at": "string"
}

Delete data product

Delete a data product by ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Data Product ID

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get data product

Get a data product by ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Data Product ID

Responses

Response samples

Content type
application/json
{
  • "asset_count": 0,
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "icon_url": "string",
  • "id": "string",
  • "manual_asset_count": 0,
  • "metadata": { },
  • "name": "string",
  • "owners": [
    ],
  • "rule_asset_count": 0,
  • "rules": [
    ],
  • "tags": [
    ],
  • "updated_at": "string"
}

Update data product

Update an existing data product

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Data Product ID

Request Body schema: application/json
required

Fields to update

description
string
object
name
string
Array of objects (DataProductOwnerRequest)
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "metadata": { },
  • "name": "string",
  • "owners": [
    ],
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "asset_count": 0,
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "icon_url": "string",
  • "id": "string",
  • "manual_asset_count": 0,
  • "metadata": { },
  • "name": "string",
  • "owners": [
    ],
  • "rule_asset_count": 0,
  • "rules": [
    ],
  • "tags": [
    ],
  • "updated_at": "string"
}

Get data product assets

Get the manually added assets of a data product

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Data Product ID

query Parameters
limit
integer
Default: 20

Maximum number of assets to return

offset
integer
Default: 0

Number of assets to skip

Responses

Response samples

Content type
application/json
{
  • "asset_ids": [
    ],
  • "total": 0
}

Add data product assets

Manually add assets to a data product

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Data Product ID

Request Body schema: application/json
required

Asset IDs to add

asset_ids
required
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "asset_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Remove data product asset

Remove a manually added asset from a data product

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Data Product ID

assetId
required
string

Asset ID

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

List product images

List all images for a data product

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Data Product ID

Responses

Response samples

Content type
application/json
{ }

Delete product image

Delete an icon or header image for a data product

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Data Product ID

purpose
required
string

Image purpose (icon or header)

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get product image

Get an icon or header image for a data product

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Data Product ID

purpose
required
string

Image purpose (icon or header)

Responses

Upload product image

Upload an icon or header image for a data product

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Data Product ID

purpose
required
string

Image purpose (icon or header)

Request Body schema: multipart/form-data
required
file
required
string <binary>

Image file

Responses

Response samples

Content type
application/json
{
  • "content_type": "string",
  • "created_at": "string",
  • "data_product_id": "string",
  • "filename": "string",
  • "id": "string",
  • "purpose": "icon",
  • "size_bytes": 0,
  • "url": "string"
}

List data products

Retrieve a paginated list of data products

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
limit
integer
Default: 20

Maximum number of data products to return

offset
integer
Default: 0

Number of data products to skip

Responses

Response samples

Content type
application/json
{
  • "data_products": [
    ],
  • "total": 0
}

Get resolved data product assets

Get all assets of a data product, both manually added and matched by rules

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Data Product ID

query Parameters
limit
integer
Default: 20

Maximum number of assets to return

offset
integer
Default: 0

Number of assets to skip

Responses

Response samples

Content type
application/json
{
  • "all_assets": [
    ],
  • "dynamic_assets": [
    ],
  • "manual_assets": [
    ],
  • "total": 0
}

Preview data product rule

Preview which assets would match a rule configuration

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
limit
integer
Default: 20

Maximum number of matching assets to return

Request Body schema: application/json
required

Rule to preview

description
string
is_enabled
boolean
metadata_field
string
name
required
string
pattern_type
string
pattern_value
string
priority
integer
query_expression
string
rule_type
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "is_enabled": true,
  • "metadata_field": "string",
  • "name": "string",
  • "pattern_type": "string",
  • "pattern_value": "string",
  • "priority": 0,
  • "query_expression": "string",
  • "rule_type": "string"
}

Response samples

Content type
application/json
{
  • "asset_count": 0,
  • "asset_ids": [
    ],
  • "errors": [
    ]
}

Get data product rules

Get the membership rules of a data product

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Data Product ID

Responses

Response samples

Content type
application/json
{
  • "rules": [
    ],
  • "total": 0
}

Create data product rule

Create a membership rule for a data product

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Data Product ID

Request Body schema: application/json
required

Rule to create

description
string
is_enabled
boolean
metadata_field
string
name
required
string
pattern_type
string
pattern_value
string
priority
integer
query_expression
string
rule_type
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "is_enabled": true,
  • "metadata_field": "string",
  • "name": "string",
  • "pattern_type": "string",
  • "pattern_value": "string",
  • "priority": 0,
  • "query_expression": "string",
  • "rule_type": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "data_product_id": "string",
  • "description": "string",
  • "id": "string",
  • "is_enabled": true,
  • "matched_asset_count": 0,
  • "metadata_field": "string",
  • "name": "string",
  • "pattern_type": "string",
  • "pattern_value": "string",
  • "priority": 0,
  • "query_expression": "string",
  • "rule_type": "query",
  • "updated_at": "string"
}

Delete data product rule

Delete a membership rule from a data product

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Data Product ID

ruleId
required
string

Rule ID

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Update data product rule

Update a membership rule of a data product

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Data Product ID

ruleId
required
string

Rule ID

Request Body schema: application/json
required

Rule fields to update

description
string
is_enabled
boolean
metadata_field
string
name
required
string
pattern_type
string
pattern_value
string
priority
integer
query_expression
string
rule_type
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "is_enabled": true,
  • "metadata_field": "string",
  • "name": "string",
  • "pattern_type": "string",
  • "pattern_value": "string",
  • "priority": 0,
  • "query_expression": "string",
  • "rule_type": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "data_product_id": "string",
  • "description": "string",
  • "id": "string",
  • "is_enabled": true,
  • "matched_asset_count": 0,
  • "metadata_field": "string",
  • "name": "string",
  • "pattern_type": "string",
  • "pattern_value": "string",
  • "priority": 0,
  • "query_expression": "string",
  • "rule_type": "query",
  • "updated_at": "string"
}

Search data products

Search data products by name, description, and tags

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
q
string

Search query

tags
string

Comma-separated list of tags to filter by

limit
integer
Default: 20

Maximum number of data products to return

offset
integer
Default: 0

Number of data products to skip

Responses

Response samples

Content type
application/json
{
  • "data_products": [
    ],
  • "total": 0
}

query

List queries

Lists the query log, newest first. Callers without access:view only see their own queries.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
source
string

Source name

decision
string

allowed or denied

status
string

running, completed, failed or denied

mrn
string

Only queries that referenced this MRN

principal_type
string

Principal type

principal_id
string

Principal ID

mine
boolean

Only the caller's own queries

client
string

Comma-separated clients to include: api, mcp or cli

from
string

Only queries started at or after this time (RFC 3339)

to
string

Only queries started before this time (RFC 3339)

q
string

Matches the caller, source, statement or a referenced MRN

limit
integer
Default: 50

Page size

offset
integer
Default: 0

Page offset

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "offset": 0,
  • "queries": [
    ],
  • "total": 0
}

Get a query

Returns one query from the log, including the catalog context recorded when it ran. Callers without access:view can only read their own queries.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Query ID

Responses

Response samples

Content type
application/json
{
  • "audit_subject": "string",
  • "client": "string",
  • "completed_at": "string",
  • "context": [
    ],
  • "decision": "string",
  • "decision_detail": {
    },
  • "error": "string",
  • "id": "string",
  • "principal_id": "string",
  • "principal_type": "string",
  • "referenced_mrns": [
    ],
  • "rows_returned": 0,
  • "source_id": "string",
  • "source_name": "string",
  • "started_at": "string",
  • "statement": "string",
  • "status": "string",
  • "truncated": true
}

Run a query

Runs a read-only statement against a queryable source as the caller. The statement is planned first and refused unless the caller may query every table it references. Every attempt is recorded in the query log.

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Query

max_rows
integer
source
required
string
statement
required
string

Responses

Request samples

Content type
application/json
{
  • "max_rows": 0,
  • "source": "string",
  • "statement": "string"
}

Response samples

Content type
application/json
{
  • "columns": [
    ],
  • "context": [
    ],
  • "query_id": "string",
  • "referenced_mrns": [
    ],
  • "row_count": 0,
  • "rows": [
    ],
  • "truncated": true
}

List queryable sources

Pages through the sources that answer data queries, in name order. Use a source's name as the "source" of a query.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
q
string

Search by source name or plugin

limit
integer
Default: 50

Page size, at most 200

offset
integer
Default: 0

Page offset

Responses

Response samples

Content type
application/json
{
  • "sources": [
    ],
  • "total": 0
}

List a source's tables

Lists the catalogued tables a queryable source can reach, busiest first, each with a statement that previews it in the source's own dialect.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
name
required
string

Source name

query Parameters
q
string

Search by table name

limit
integer
Default: 25

At most 100

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Query statistics

Summarises data query activity over a window from hourly rollups: totals, a series and the busiest callers, sources and tables. Callers without access:view only see their own activity. The window defaults to the last 24 hours.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
from
string

Start of the window, RFC 3339

to
string

End of the window, RFC 3339

interval
string

hour or day; defaults by window length

limit
integer
Default: 6

Entries in each top list

Responses

Response samples

Content type
application/json
{
  • "from": "string",
  • "interval": "string",
  • "series": [
    ],
  • "to": "string",
  • "top_callers": [
    ],
  • "top_sources": [
    ],
  • "top_tables": [
    ],
  • "totals": {
    }
}

Query plugin instance status

Reports the long-running plugin processes that serve data queries.

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "instances": [
    ]
}

Enrol a serving plugin

Issues a short-lived client certificate for a plugin running outside Marmot to connect and serve queries for the named sources. The caller must hold ingestion:serve, and each source must be free or already served by the caller.

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Certificate request and sources

csr
string
Array of objects (pluginserve.EnrolSource)

Responses

Request samples

Content type
application/json
{
  • "csr": "string",
  • "sources": [
    ]
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "ca_bundle": "string",
  • "certificate": "string",
  • "enrolment_id": "string",
  • "expires_at": "string",
  • "instance_id": "string",
  • "port": "string",
  • "signing_keys": [
    ]
}

List serving key generations

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Rotate serving keys

Starts a new generation of the CA and query signing keys that secure serving plugins. A graceful rotation publishes the new keys, uses them after the overlap and then retires the old ones, without interrupting serving plugins. An immediate rotation is for a suspected compromise: it switches at once and serving plugins must be restarted.

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Rotation

ca_key_uri
string

CAKeyURI and SigningKeyURI name new KMS keys. Leave both empty to have Marmot generate keys it stores encrypted, which is refused when the current keys are in a KMS.

immediate
boolean

Immediate switches to the new keys at once and stops trusting the old ones, for a suspected compromise; serving plugins must then be restarted.

signing_key_uri
string

Responses

Request samples

Content type
application/json
{
  • "ca_key_uri": "string",
  • "immediate": true,
  • "signing_key_uri": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

runs

List runs

Get paginated list of runs with filtering

Authorizations:
ApiKeyAuthBearerAuth
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

Content type
application/json
{
  • "limit": 0,
  • "offset": 0,
  • "pipelines": [
    ],
  • "runs": [
    ],
  • "total": 0
}

Get run

Get a specific run by ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Run ID

Responses

Response samples

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": {
    }
}

Get run entities

Get paginated list of entities for a specific run

Authorizations:
ApiKeyAuthBearerAuth
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

Content type
application/json
{
  • "entities": [
    ],
  • "limit": 0,
  • "offset": 0,
  • "total": 0
}

Batch create assets

Create/update assets within a run

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Batch create request

required
Array of objects (RunCreateAssetRequest) non-empty
object (RawPluginConfig)
Array of objects (CreateDocRequest)
Array of objects (CreateGlossaryTermRequest)
Array of objects (CreateLineageRequest)
pipeline_name
required
string
Array of objects (CreateRunHistoryRequest)
run_id
required
string
source_name
required
string
Array of objects (CreateStatRequest)

Responses

Request samples

Content type
application/json
{
  • "assets": [
    ],
  • "config": { },
  • "documentation": [
    ],
  • "glossary_terms": [
    ],
  • "lineage": [
    ],
  • "pipeline_name": "string",
  • "run_history": [
    ],
  • "run_id": "string",
  • "source_name": "string",
  • "statistics": [
    ]
}

Response samples

Content type
application/json
{
  • "assets": [
    ],
  • "documentation": [
    ],
  • "lineage": [
    ],
  • "stale_entities_removed": [
    ]
}

Cleanup stale runs

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

Authorizations:
ApiKeyAuthBearerAuth

Responses

Complete run

Complete a run with results

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Complete run request

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

Responses

Request samples

Content type
application/json
{
  • "error": "string",
  • "run_id": "string",
  • "status": "running",
  • "summary": {
    }
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Start run

Start a new run for tracking

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Start run request

object (RawPluginConfig)
pipeline_name
required
string
source_name
required
string

Responses

Request samples

Content type
application/json
{
  • "config": { },
  • "pipeline_name": "string",
  • "source_name": "string"
}

Response samples

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": {
    }
}

search

Unified search

Search across assets, glossary terms, teams, and users

Authorizations:
ApiKeyAuthBearerAuth
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

Content type
application/json
{
  • "facets": {
    },
  • "limit": 0,
  • "offset": 0,
  • "results": [
    ],
  • "total": 0
}

service_accounts

List service accounts

Get all service accounts

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create service account

Create a new service account

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Service account

description
string
name
string
role_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "role_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "active": true,
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "roles": [
    ],
  • "updated_at": "string"
}

Delete service account

Soft-delete a service account

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Service account ID

Responses

Get service account

Get a service account by ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Service account ID

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "roles": [
    ],
  • "updated_at": "string"
}

Update service account

Update a service account

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Service account ID

Request Body schema: application/json
required

Update fields

active
boolean
description
string
name
string
role_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "description": "string",
  • "name": "string",
  • "role_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "active": true,
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "roles": [
    ],
  • "updated_at": "string"
}

List API keys for a service account

Get all API keys for a service account

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Service account ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create API key for a service account

Create a new API key. The plaintext key is only returned once.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Service account ID

Request Body schema: application/json
required

API key details

expires_in_days
integer
name
string

Responses

Request samples

Content type
application/json
{
  • "expires_in_days": 0,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "expires_at": "string",
  • "id": "string",
  • "key": "string",
  • "last_used_at": "string",
  • "name": "string",
  • "service_account_id": "string"
}

Delete an API key

Delete an API key for a service account

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Service account ID

keyId
required
string

API key ID

Responses

auth

List configured SSO providers (admin)

Read-only view of SSO providers wired via server config. Editing is done in config.yaml.

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "providers": [
    ]
}

Get auth configuration

Returns the enabled auth providers without sensitive data

Responses

Response samples

Content type
application/json
{
  • "enabled_providers": [
    ]
}

Handle OAuth callback

Processes the OAuth callback from any provider

path Parameters
provider
required
string

OAuth provider (okta, google, github, etc.)

query Parameters
code
required
string

Authorization code

state
required
string

State parameter for CSRF protection

Responses

Response samples

Content type
application/json
"string"

Initiate OAuth login

Redirects the user to the OAuth provider for authentication

path Parameters
provider
required
string

OAuth provider (okta, google, github, etc.)

Responses

Response samples

Content type
application/json
"string"

OAuth token endpoint

Handles authorization_code grants (with PKCE) and token exchange (RFC 8693). For token-exchange, supported subject_token_type values are urn:ietf:params:oauth:token-type:id_token and urn:ietf:params:oauth:token-type:access_token.

Request Body schema: application/x-www-form-urlencoded
required
grant_type
required
string

authorization_code or urn:ietf:params:oauth:grant-type:token-exchange

subject_token
string

Token to exchange (token-exchange grant only)

subject_token_type
string

id_token or access_token URI (token-exchange grant only)

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "expires_in": 0,
  • "issued_token_type": "string",
  • "token_type": "string"
}

sso

List SSO team mappings

Get a list of SSO group to team mappings

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
provider
string

Filter by SSO provider

Responses

Response samples

Content type
application/json
{
  • "mappings": [
    ]
}

Create an SSO team mapping

Create a new SSO group to team mapping

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

SSO mapping creation request

member_role
string
provider
string
sso_group_name
string
team_id
string

Responses

Request samples

Content type
application/json
{
  • "member_role": "string",
  • "provider": "string",
  • "sso_group_name": "string",
  • "team_id": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "id": "string",
  • "member_role": "string",
  • "provider": "string",
  • "sso_group_name": "string",
  • "team_id": "string",
  • "updated_at": "string"
}

Delete an SSO team mapping

Delete an SSO team mapping by its ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

SSO mapping ID

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get an SSO team mapping

Get an SSO team mapping by its ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

SSO mapping ID

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "id": "string",
  • "member_role": "string",
  • "provider": "string",
  • "sso_group_name": "string",
  • "team_id": "string",
  • "updated_at": "string"
}

Update an SSO team mapping

Update an SSO team mapping by its ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

SSO mapping ID

Request Body schema: application/json
required

SSO mapping update request

member_role
string
team_id
string

Responses

Request samples

Content type
application/json
{
  • "member_role": "string",
  • "team_id": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

teams

List teams

Get a paginated list of teams

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
limit
integer
Default: 50

Number of items to return

offset
integer
Default: 0

Number of items to skip

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "offset": 0,
  • "teams": [
    ],
  • "total": 0
}

Create a team

Create a new team

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Team creation request

description
string
name
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "created_by": "string",
  • "created_via_sso": true,
  • "description": "string",
  • "id": "string",
  • "metadata": { },
  • "name": "string",
  • "sso_provider": "string",
  • "tags": [
    ],
  • "updated_at": "string"
}

Delete a team

Delete a team by its ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Team ID

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get a team

Get a team by its ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Team ID

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "created_by": "string",
  • "created_via_sso": true,
  • "description": "string",
  • "id": "string",
  • "metadata": { },
  • "name": "string",
  • "sso_provider": "string",
  • "tags": [
    ],
  • "updated_at": "string"
}

Update a team

Update a team's fields by its ID

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Team ID

Request Body schema: application/json
required

Team update request

description
string
object
name
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "metadata": { },
  • "name": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string"
}

List team members

Get the members of a team

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Team ID

Responses

Response samples

Content type
application/json
{
  • "members": [
    ]
}

Add a team member

Add a user as a member of a team

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Team ID

Request Body schema: application/json
required

Member addition request

role
string
user_id
string

Responses

Request samples

Content type
application/json
{
  • "role": "string",
  • "user_id": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Remove a team member

Remove a user from a team

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Team ID

userId
required
string

User ID

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Convert member to manual

Convert an SSO-managed team member to a manually managed member

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Team ID

userId
required
string

User ID

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Update member role

Update the role of a team member

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Team ID

userId
required
string

User ID

Request Body schema: application/json
required

Role update request

role
string

Responses

Request samples

Content type
application/json
{
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

ui

Get UI configuration

Get UI configuration including banner settings

Responses

Response samples

Content type
application/json
{
  • "allow_unencrypted": true,
  • "banner": {
    },
  • "default_language": "string",
  • "encryption_configured": true,
  • "table_preview_enabled": true
}

users

List users

Get a list of users with optional filtering

Authorizations:
ApiKeyAuthBearerAuth
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

Content type
application/json
{
  • "limit": 0,
  • "offset": 0,
  • "total": 0,
  • "users": [
    ]
}

Create a new user

Create a new user in the system

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

User creation request

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

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "oauth_provider": "string",
  • "oauth_provider_data": { },
  • "oauth_provider_id": "string",
  • "password": "stringst",
  • "profile_picture": "string",
  • "role_names": [
    ],
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "active": true,
  • "created_at": "string",
  • "id": "string",
  • "identities": [
    ],
  • "must_change_password": true,
  • "name": "string",
  • "preferences": { },
  • "profile_picture": "string",
  • "roles": [
    ],
  • "sessions_invalidated_at": "string",
  • "updated_at": "string",
  • "username": "string"
}

Delete a user

Delete a user from the system

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

User ID

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Get a user by ID

Get detailed information about a specific user

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

User ID

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "created_at": "string",
  • "id": "string",
  • "identities": [
    ],
  • "must_change_password": true,
  • "name": "string",
  • "preferences": { },
  • "profile_picture": "string",
  • "roles": [
    ],
  • "sessions_invalidated_at": "string",
  • "updated_at": "string",
  • "username": "string"
}

Update a user

Update user information

Authorizations:
ApiKeyAuthBearerAuth
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
profile_picture
string
role_names
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "email": "string",
  • "name": "string",
  • "password": "stringst",
  • "preferences": { },
  • "profile_picture": "string",
  • "role_names": [
    ]
}

Response samples

Content type
application/json
{
  • "active": true,
  • "created_at": "string",
  • "id": "string",
  • "identities": [
    ],
  • "must_change_password": true,
  • "name": "string",
  • "preferences": { },
  • "profile_picture": "string",
  • "roles": [
    ],
  • "sessions_invalidated_at": "string",
  • "updated_at": "string",
  • "username": "string"
}

List API keys

Get all API keys for a user

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create API key

Create a new API key for a user

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

API key creation request

expires_in_days
integer
name
required
string

Responses

Request samples

Content type
application/json
{
  • "expires_in_days": 0,
  • "name": "string"
}

Response samples

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

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

API key ID

Responses

Response samples

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

Content type
application/json
{
  • "password": "string",
  • "username": "string"
}

Response samples

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:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "created_at": "string",
  • "id": "string",
  • "identities": [
    ],
  • "must_change_password": true,
  • "name": "string",
  • "preferences": { },
  • "profile_picture": "string",
  • "roles": [
    ],
  • "sessions_invalidated_at": "string",
  • "updated_at": "string",
  • "username": "string"
}

Unlink OAuth account

Unlink an OAuth account from a user

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

User ID

provider
required
string

OAuth provider

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Update user preferences

Update preferences for the current user

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

User preferences

property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "error": "string"
}

Sign a user out of all sessions

Rejects every token issued to the user before now. Their password and API keys are untouched, so this is the response to a leaked or overexposed token rather than a lost credential.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

User ID

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Update user password

Update current user's password

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Password update request

new_password
required
string >= 8 characters

Responses

Request samples

Content type
application/json
{
  • "new_password": "stringst"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "expires_in": 0,
  • "requires_password_change": true,
  • "token_type": "string"
}