Pipelines

Download schema

Pipeline management endpoints

deprecated

List pipelines

GET

https://app.monad.com/api

/v1/{organization_id}/pipelines

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:read

List pipelines

List pipelines › path Parameters

organization_id

string · required

Organization ID

List pipelines › query Parameters

limit

integer

Limit

offset

integer

Offset

List pipelines › Responses

List of pipelines

models.PipelineList

models.Pagination

models.Pipeline[]

GET/v1/{organization_id}/pipelines

curl https://app.monad.com/api/v1/:organization_id/pipelines \
  --header 'Authorization: <api-key>'

Example Responses

{
  "pagination": {
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "pipelines": [
    {
      "component_tier": 0,
      "created_at": "created_at",
      "cron_schedule": "cron_schedule",
      "description": "description",
      "enabled": true,
      "id": "id",
      "input_id": "input_id",
      "managed_by": "customer",
      "name": "name",
      "organization_id": "organization_id",
      "status": {
        "average_size_egressed": 0,
        "average_size_ingested": 0,
        "egress": {
          "bytes": 0,
          "records": 0
        },
        "errors": 0,
        "ingress": {
          "bytes": 0,
          "records": 0
        },
        "last_ingested_time": "last_ingested_time",
        "last_updated_at": "last_updated_at",
        "nodes": [
          {
            "avg_bytes_per_record_egress": 0,
            "avg_bytes_per_record_ingress": 0,
            "backpressure": {
              "bytes": 0,
              "records": 0
            },
            "component_type": "component_type",
            "component_type_id": "component_type_id",
            "egress": {
              "bytes": 0,
              "records": 0
            },
            "errors": 0,
            "ingress": {
              "bytes": 0,
              "records": 0
            },
            "last_ingested_time": "last_ingested_time",
            "last_record_processed_time": "last_record_processed_time",
            "last_updated_at": "last_updated_at",
            "node_id": "node_id",
            "node_slug": "node_slug",
            "progress": {
              "entries": [
                {
                  "label": "Last Processed",
                  "partition_key": "partition_key",
                  "ranges": [
                    {
                      "end": "end",
                      "start": "start"
                    }
                  ]
                }
              ]
            },
            "status": "Unknown"
          }
        ],
        "organization_id": "organization_id",
        "organization_name": "organization_name",
        "pipeline_id": "pipeline_id",
        "pipeline_name": "pipeline_name",
        "progress": {
          "entries": [
            {
              "label": "Last Processed",
              "partition_key": "partition_key",
              "ranges": [
                {
                  "end": "end",
                  "start": "start"
                }
              ]
            }
          ]
        },
        "status": "Unknown",
        "stream": {
          "bytes": 0,
          "records": 0
        }
      },
      "updated_at": "updated_at"
    }
  ]
}

json

application/json

deprecated

Get pipeline

GET

https://app.monad.com/api

/v1/{organization_id}/pipelines/{pipeline_id}

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:read

Get pipeline

Get pipeline › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

Get pipeline › Responses

Pipeline details

models.Pipeline

component_tier

integer

created_at

string

cron_schedule

string

description

string

enabled

boolean

id

string

input_id

string

managed_by

models.ManagedBy · enum

Enum values:

customer

internal

system

name

string

organization_id

string

models.PipelineStatus

updated_at

string

GET/v1/{organization_id}/pipelines/{pipeline_id}

curl https://app.monad.com/api/v1/:organization_id/pipelines/:pipeline_id \
  --header 'Authorization: <api-key>'

Example Responses

{
  "component_tier": 0,
  "created_at": "created_at",
  "cron_schedule": "cron_schedule",
  "description": "description",
  "enabled": true,
  "id": "id",
  "input_id": "input_id",
  "managed_by": "customer",
  "name": "name",
  "organization_id": "organization_id",
  "status": {
    "average_size_egressed": 0,
    "average_size_ingested": 0,
    "egress": {
      "bytes": 0,
      "records": 0
    },
    "errors": 0,
    "ingress": {
      "bytes": 0,
      "records": 0
    },
    "last_ingested_time": "last_ingested_time",
    "last_updated_at": "last_updated_at",
    "nodes": [
      {
        "avg_bytes_per_record_egress": 0,
        "avg_bytes_per_record_ingress": 0,
        "backpressure": {
          "bytes": 0,
          "records": 0
        },
        "component_type": "component_type",
        "component_type_id": "component_type_id",
        "egress": {
          "bytes": 0,
          "records": 0
        },
        "errors": 0,
        "ingress": {
          "bytes": 0,
          "records": 0
        },
        "last_ingested_time": "last_ingested_time",
        "last_record_processed_time": "last_record_processed_time",
        "last_updated_at": "last_updated_at",
        "node_id": "node_id",
        "node_slug": "node_slug",
        "progress": {
          "entries": [
            {
              "label": "Last Processed",
              "partition_key": "partition_key",
              "ranges": [
                {
                  "end": "end",
                  "start": "start"
                }
              ]
            }
          ]
        },
        "status": "Unknown"
      }
    ],
    "organization_id": "organization_id",
    "organization_name": "organization_name",
    "pipeline_id": "pipeline_id",
    "pipeline_name": "pipeline_name",
    "progress": {
      "entries": [
        {
          "label": "Last Processed",
          "partition_key": "partition_key",
          "ranges": [
            {
              "end": "end",
              "start": "start"
            }
          ]
        }
      ]
    },
    "status": "Unknown",
    "stream": {
      "bytes": 0,
      "records": 0
    }
  },
  "updated_at": "updated_at"
}

json

application/json

Delete pipeline

DELETE

https://app.monad.com/api

/v1/{organization_id}/pipelines/{pipeline_id}

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:delete

Delete pipeline

Delete pipeline › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

Delete pipeline › Responses

Pipeline deleted successfully

string

deprecated

Update pipeline

PATCH

https://app.monad.com/api

/v1/{organization_id}/pipelines/{pipeline_id}

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:write

Update pipeline

Update pipeline › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

Update pipeline › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Update pipeline › Responses

Response body for updating a pipeline

models.Pipeline

component_tier

integer

created_at

string

cron_schedule

string

description

string

enabled

boolean

id

string

input_id

string

managed_by

models.ManagedBy · enum

Enum values:

customer

internal

system

name

string

organization_id

string

models.PipelineStatus

updated_at

string

PATCH/v1/{organization_id}/pipelines/{pipeline_id}

curl https://app.monad.com/api/v1/:organization_id/pipelines/:pipeline_id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "component_tier": 0,
  "created_at": "created_at",
  "cron_schedule": "cron_schedule",
  "description": "description",
  "enabled": true,
  "id": "id",
  "input_id": "input_id",
  "managed_by": "customer",
  "name": "name",
  "organization_id": "organization_id",
  "status": {
    "average_size_egressed": 0,
    "average_size_ingested": 0,
    "egress": {
      "bytes": 0,
      "records": 0
    },
    "errors": 0,
    "ingress": {
      "bytes": 0,
      "records": 0
    },
    "last_ingested_time": "last_ingested_time",
    "last_updated_at": "last_updated_at",
    "nodes": [
      {
        "avg_bytes_per_record_egress": 0,
        "avg_bytes_per_record_ingress": 0,
        "backpressure": {
          "bytes": 0,
          "records": 0
        },
        "component_type": "component_type",
        "component_type_id": "component_type_id",
        "egress": {
          "bytes": 0,
          "records": 0
        },
        "errors": 0,
        "ingress": {
          "bytes": 0,
          "records": 0
        },
        "last_ingested_time": "last_ingested_time",
        "last_record_processed_time": "last_record_processed_time",
        "last_updated_at": "last_updated_at",
        "node_id": "node_id",
        "node_slug": "node_slug",
        "progress": {
          "entries": [
            {
              "label": "Last Processed",
              "partition_key": "partition_key",
              "ranges": [
                {
                  "end": "end",
                  "start": "start"
                }
              ]
            }
          ]
        },
        "status": "Unknown"
      }
    ],
    "organization_id": "organization_id",
    "organization_name": "organization_name",
    "pipeline_id": "pipeline_id",
    "pipeline_name": "pipeline_name",
    "progress": {
      "entries": [
        {
          "label": "Last Processed",
          "partition_key": "partition_key",
          "ranges": [
            {
              "end": "end",
              "start": "start"
            }
          ]
        }
      ]
    },
    "status": "Unknown",
    "stream": {
      "bytes": 0,
      "records": 0
    }
  },
  "updated_at": "updated_at"
}

json

application/json

Get pipeline metrics

GET

https://app.monad.com/api

/v2/{organization_id}/metrics/pipelines/{pipeline_id}

Authorization (header)

x-api-key (header)

Get time series metrics for a pipeline

Get pipeline metrics › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

Get pipeline metrics › query Parameters

metric

string · required

Metric to retrieve (ingress_bytes|egress_bytes|ingress_records|egress_records|errors)

start

string

ISO3339 start time, default 6 hours ago

end

string

ISO3339 end time, default now

resolution

string

Resolution of the data, default determined by time window

Get pipeline metrics › Responses

Pipeline metrics

models.PipelineMetrics

end_at

string

metric

string

node_id

string

node_slug

string

organization_id

string

organization_name

string

pipeline_id

string

pipeline_name

string

resolution

string

start_at

string

models.PipelineMetricsValue[]

Get pipeline node metrics

GET

https://app.monad.com/api

/v2/{organization_id}/metrics/pipelines/{pipeline_id}/{node_id}

Authorization (header)

x-api-key (header)

Get pipeline node metrics

Get pipeline node metrics › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

node_id

string · required

Node ID

Get pipeline node metrics › query Parameters

metric

string · required

Metric to retrieve (ingress_bytes|egress_bytes|ingress_records|egress_records|errors)

start

string

ISO3339 start time, default 6 hours ago

end

string

ISO3339 end time, default now

resolution

string

Resolution of the data, default determined by time window

Get pipeline node metrics › Responses

Pipeline node metrics

models.PipelineMetrics

end_at

string

metric

string

node_id

string

node_slug

string

organization_id

string

organization_name

string

pipeline_id

string

pipeline_name

string

resolution

string

start_at

string

models.PipelineMetricsValue[]

Get status of all pipelines for an organization

GET

https://app.monad.com/api

/v2/{organization_id}/pipeline_summary

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:read

Get status of all pipelines for an organization

Get status of all pipelines for an organization › path Parameters

organization_id

string · required

Organization ID

Get status of all pipelines for an organization › query Parameters

start

string

ISO3339 start time, default 24 hours ago

end

string

ISO3339 end time, default now

Get status of all pipelines for an organization › Responses

Organization Pipeline Summary

routesV2.getOrganizationSummaryResponse

organization_id

string · required

routesV2.pipelineStatus[]

routesV2.organizationOverview

GET/v2/{organization_id}/pipeline_summary

curl https://app.monad.com/api/v2/:organization_id/pipeline_summary \
  --header 'Authorization: <api-key>'

Example Responses

{
  "organization_id": "organization_id",
  "pipelines": [
    {
      "egress": {
        "bytes": 0,
        "records": 0
      },
      "errors": 0,
      "expired_messages": 0,
      "ingress": {
        "bytes": 0,
        "records": 0
      },
      "last_ingested_time": "last_ingested_time",
      "pipeline_id": "pipeline_id",
      "pipeline_name": "pipeline_name",
      "status": "status"
    }
  ],
  "summary": {
    "disabled": 0,
    "egress": {
      "bytes": 0,
      "records": 0
    },
    "errors": 0,
    "expired_messages": 0,
    "healthy": 0,
    "ingress": {
      "bytes": 0,
      "records": 0
    },
    "last_ingested_time": "last_ingested_time",
    "unhealthy": 0
  }
}

json

application/json

List pipelines

GET

https://app.monad.com/api

/v2/{organization_id}/pipelines

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:read

List pipelines

List pipelines › path Parameters

organization_id

string · required

Organization ID

List pipelines › query Parameters

limit

integer

Limit

offset

integer

Offset

include_status

boolean

Include the status of the pipeline nodes

List pipelines › Responses

List of pipelines

models.PipelineList

models.Pagination

models.Pipeline[]

GET/v2/{organization_id}/pipelines

curl https://app.monad.com/api/v2/:organization_id/pipelines \
  --header 'Authorization: <api-key>'

Example Responses

{
  "pagination": {
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "pipelines": [
    {
      "component_tier": 0,
      "created_at": "created_at",
      "cron_schedule": "cron_schedule",
      "description": "description",
      "enabled": true,
      "id": "id",
      "input_id": "input_id",
      "managed_by": "customer",
      "name": "name",
      "organization_id": "organization_id",
      "status": {
        "average_size_egressed": 0,
        "average_size_ingested": 0,
        "egress": {
          "bytes": 0,
          "records": 0
        },
        "errors": 0,
        "ingress": {
          "bytes": 0,
          "records": 0
        },
        "last_ingested_time": "last_ingested_time",
        "last_updated_at": "last_updated_at",
        "nodes": [
          {
            "avg_bytes_per_record_egress": 0,
            "avg_bytes_per_record_ingress": 0,
            "backpressure": {
              "bytes": 0,
              "records": 0
            },
            "component_type": "component_type",
            "component_type_id": "component_type_id",
            "egress": {
              "bytes": 0,
              "records": 0
            },
            "errors": 0,
            "ingress": {
              "bytes": 0,
              "records": 0
            },
            "last_ingested_time": "last_ingested_time",
            "last_record_processed_time": "last_record_processed_time",
            "last_updated_at": "last_updated_at",
            "node_id": "node_id",
            "node_slug": "node_slug",
            "progress": {
              "entries": [
                {
                  "label": "Last Processed",
                  "partition_key": "partition_key",
                  "ranges": [
                    {
                      "end": "end",
                      "start": "start"
                    }
                  ]
                }
              ]
            },
            "status": "Unknown"
          }
        ],
        "organization_id": "organization_id",
        "organization_name": "organization_name",
        "pipeline_id": "pipeline_id",
        "pipeline_name": "pipeline_name",
        "progress": {
          "entries": [
            {
              "label": "Last Processed",
              "partition_key": "partition_key",
              "ranges": [
                {
                  "end": "end",
                  "start": "start"
                }
              ]
            }
          ]
        },
        "status": "Unknown",
        "stream": {
          "bytes": 0,
          "records": 0
        }
      },
      "updated_at": "updated_at"
    }
  ]
}

json

application/json

Create pipeline

POST

https://app.monad.com/api

/v2/{organization_id}/pipelines

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:write

Create a new pipeline with specified configuration

Create pipeline › path Parameters

organization_id

string · required

Organization ID

Create pipeline › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object · requires: edges, name, nodes

Properties for Variant 1:

Create pipeline › Responses

Pipeline created successfully

models.PipelineConfigV2

billingAccountId

string

component_tier

integer

createdAt

string

cron_schedule

string

description

string

models.PipelineEdge[]

enabled

boolean

id

string

is_synthetic

boolean

managed_by

models.ManagedBy · enum

Enum values:

customer

internal

system

name

string

next_cron_run_at

string

models.PipelineNode[]

organizationId

string

organizationName

string

models.PipelineRetentionPolicy

models.PipelineStatus

updatedAt

string

POST/v2/{organization_id}/pipelines

curl https://app.monad.com/api/v2/:organization_id/pipelines \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "billingAccountId": "billingAccountId",
  "component_tier": 0,
  "createdAt": "createdAt",
  "cron_schedule": "cron_schedule",
  "description": "description",
  "edges": [
    {
      "conditions": {
        "conditions": [
          null
        ],
        "config": {
          "key": {}
        },
        "operator": "always",
        "type_id": "type_id"
      },
      "created_at": "created_at",
      "description": "description",
      "disabled": true,
      "from_node_instance_id": "from_node_instance_id",
      "id": "id",
      "name": "name",
      "organization_id": "organization_id",
      "pipeline_id": "pipeline_id",
      "schema_detection": true,
      "to_node_instance_id": "to_node_instance_id",
      "updated_at": "updated_at"
    }
  ],
  "enabled": true,
  "id": "id",
  "is_synthetic": true,
  "managed_by": "customer",
  "name": "name",
  "next_cron_run_at": "next_cron_run_at",
  "nodes": [
    {
      "component": {
        "config": {
          "key": {}
        },
        "description": "description",
        "id": "id",
        "name": "name",
        "references": {
          "secrets": [
            {
              "id": "id",
              "organization_id": "organization_id"
            }
          ]
        },
        "type": "type"
      },
      "component_house": "component_house",
      "component_id": "component_id",
      "component_sub_type": "component_sub_type",
      "component_type": "transform",
      "created_at": "created_at",
      "enabled": true,
      "id": "id",
      "organization_id": "organization_id",
      "pipeline_id": "pipeline_id",
      "slug": "slug",
      "status": {
        "avg_bytes_per_record_egress": 0,
        "avg_bytes_per_record_ingress": 0,
        "backpressure": {
          "bytes": 0,
          "records": 0
        },
        "component_type": "component_type",
        "component_type_id": "component_type_id",
        "egress": {
          "bytes": 0,
          "records": 0
        },
        "errors": 0,
        "ingress": {
          "bytes": 0,
          "records": 0
        },
        "last_ingested_time": "last_ingested_time",
        "last_record_processed_time": "last_record_processed_time",
        "last_updated_at": "last_updated_at",
        "node_id": "node_id",
        "node_slug": "node_slug",
        "progress": {
          "entries": [
            {
              "label": "Last Processed",
              "partition_key": "partition_key",
              "ranges": [
                {
                  "end": "end",
                  "start": "start"
                }
              ]
            }
          ]
        },
        "status": "Unknown"
      }
    }
  ],
  "organizationId": "organizationId",
  "organizationName": "organizationName",
  "retention_policy": {
    "stream_age_limit": 0,
    "stream_size_limit": "stream_size_limit"
  },
  "status": {
    "average_size_egressed": 0,
    "average_size_ingested": 0,
    "egress": {
      "bytes": 0,
      "records": 0
    },
    "errors": 0,
    "ingress": {
      "bytes": 0,
      "records": 0
    },
    "last_ingested_time": "last_ingested_time",
    "last_updated_at": "last_updated_at",
    "nodes": [
      {
        "avg_bytes_per_record_egress": 0,
        "avg_bytes_per_record_ingress": 0,
        "backpressure": {
          "bytes": 0,
          "records": 0
        },
        "component_type": "component_type",
        "component_type_id": "component_type_id",
        "egress": {
          "bytes": 0,
          "records": 0
        },
        "errors": 0,
        "ingress": {
          "bytes": 0,
          "records": 0
        },
        "last_ingested_time": "last_ingested_time",
        "last_record_processed_time": "last_record_processed_time",
        "last_updated_at": "last_updated_at",
        "node_id": "node_id",
        "node_slug": "node_slug",
        "progress": {
          "entries": [
            {
              "label": "Last Processed",
              "partition_key": "partition_key",
              "ranges": [
                {
                  "end": "end",
                  "start": "start"
                }
              ]
            }
          ]
        },
        "status": "Unknown"
      }
    ],
    "organization_id": "organization_id",
    "organization_name": "organization_name",
    "pipeline_id": "pipeline_id",
    "pipeline_name": "pipeline_name",
    "progress": {
      "entries": [
        {
          "label": "Last Processed",
          "partition_key": "partition_key",
          "ranges": [
            {
              "end": "end",
              "start": "start"
            }
          ]
        }
      ]
    },
    "status": "Unknown",
    "stream": {
      "bytes": 0,
      "records": 0
    }
  },
  "updatedAt": "updatedAt"
}

json

application/json

Get metrics for specific pipelines

GET

https://app.monad.com/api

/v2/{organization_id}/pipelines/metrics

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:read

Get aggregated ingress and egress metrics for specific pipelines

Get metrics for specific pipelines › path Parameters

organization_id

string · required

Organization ID

Get metrics for specific pipelines › query Parameters

pipeline_ids

string · required

Comma-separated list of pipeline IDs

resolution

string

Resolution for metrics (default: 5m)

Get metrics for specific pipelines › Responses

Pipeline metrics data

routesV2.MetricsResponse

routesV2.PipelineMetric[]

Get pipeline status

GET

https://app.monad.com/api

/v2/{organization_id}/pipelines/statuses

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:read

Retrieve the status of pipelines within an organization for a specified time period.

Get pipeline status › path Parameters

organization_id

string · required

Organization ID

Get pipeline status › query Parameters

limit

integer

Maximum number of pipelines to return (default is 10)

offset

integer

Offset for pagination (default is 0)

start

string

Start time (RFC3339 format) for status metrics (default: 24 hours ago)

end

string

End time (RFC3339 format) for status metrics (default: now)

Get pipeline status › Responses

List of pipelines with status

routesV2.pipelineWithStatus[]

routesV2.pipelineWithStatus

id

string · required

status

models.PipelineStatusValue · enum · required

Enum values:

Unknown

Pending

Initializing

Running

Disabled

Erroring

Throttled

last_ingested_time

string

Get pipeline configuration

GET

https://app.monad.com/api

/v2/{organization_id}/pipelines/{pipeline_id}

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:read

Retrieve a specific pipeline configuration by pipeline ID

Get pipeline configuration › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

Get pipeline configuration › query Parameters

include_status

boolean

Include the status of the pipeline nodes

Get pipeline configuration › Responses

Pipeline configuration retrieved successfully

models.PipelineConfigV2

billingAccountId

string

component_tier

integer

createdAt

string

cron_schedule

string

description

string

models.PipelineEdge[]

enabled

boolean

id

string

is_synthetic

boolean

managed_by

models.ManagedBy · enum

Enum values:

customer

internal

system

name

string

next_cron_run_at

string

models.PipelineNode[]

organizationId

string

organizationName

string

models.PipelineRetentionPolicy

models.PipelineStatus

updatedAt

string

GET/v2/{organization_id}/pipelines/{pipeline_id}

curl https://app.monad.com/api/v2/:organization_id/pipelines/:pipeline_id \
  --header 'Authorization: <api-key>'

Example Responses

{
  "billingAccountId": "billingAccountId",
  "component_tier": 0,
  "createdAt": "createdAt",
  "cron_schedule": "cron_schedule",
  "description": "description",
  "edges": [
    {
      "conditions": {
        "conditions": [
          null
        ],
        "config": {
          "key": {}
        },
        "operator": "always",
        "type_id": "type_id"
      },
      "created_at": "created_at",
      "description": "description",
      "disabled": true,
      "from_node_instance_id": "from_node_instance_id",
      "id": "id",
      "name": "name",
      "organization_id": "organization_id",
      "pipeline_id": "pipeline_id",
      "schema_detection": true,
      "to_node_instance_id": "to_node_instance_id",
      "updated_at": "updated_at"
    }
  ],
  "enabled": true,
  "id": "id",
  "is_synthetic": true,
  "managed_by": "customer",
  "name": "name",
  "next_cron_run_at": "next_cron_run_at",
  "nodes": [
    {
      "component": {
        "config": {
          "key": {}
        },
        "description": "description",
        "id": "id",
        "name": "name",
        "references": {
          "secrets": [
            {
              "id": "id",
              "organization_id": "organization_id"
            }
          ]
        },
        "type": "type"
      },
      "component_house": "component_house",
      "component_id": "component_id",
      "component_sub_type": "component_sub_type",
      "component_type": "transform",
      "created_at": "created_at",
      "enabled": true,
      "id": "id",
      "organization_id": "organization_id",
      "pipeline_id": "pipeline_id",
      "slug": "slug",
      "status": {
        "avg_bytes_per_record_egress": 0,
        "avg_bytes_per_record_ingress": 0,
        "backpressure": {
          "bytes": 0,
          "records": 0
        },
        "component_type": "component_type",
        "component_type_id": "component_type_id",
        "egress": {
          "bytes": 0,
          "records": 0
        },
        "errors": 0,
        "ingress": {
          "bytes": 0,
          "records": 0
        },
        "last_ingested_time": "last_ingested_time",
        "last_record_processed_time": "last_record_processed_time",
        "last_updated_at": "last_updated_at",
        "node_id": "node_id",
        "node_slug": "node_slug",
        "progress": {
          "entries": [
            {
              "label": "Last Processed",
              "partition_key": "partition_key",
              "ranges": [
                {
                  "end": "end",
                  "start": "start"
                }
              ]
            }
          ]
        },
        "status": "Unknown"
      }
    }
  ],
  "organizationId": "organizationId",
  "organizationName": "organizationName",
  "retention_policy": {
    "stream_age_limit": 0,
    "stream_size_limit": "stream_size_limit"
  },
  "status": {
    "average_size_egressed": 0,
    "average_size_ingested": 0,
    "egress": {
      "bytes": 0,
      "records": 0
    },
    "errors": 0,
    "ingress": {
      "bytes": 0,
      "records": 0
    },
    "last_ingested_time": "last_ingested_time",
    "last_updated_at": "last_updated_at",
    "nodes": [
      {
        "avg_bytes_per_record_egress": 0,
        "avg_bytes_per_record_ingress": 0,
        "backpressure": {
          "bytes": 0,
          "records": 0
        },
        "component_type": "component_type",
        "component_type_id": "component_type_id",
        "egress": {
          "bytes": 0,
          "records": 0
        },
        "errors": 0,
        "ingress": {
          "bytes": 0,
          "records": 0
        },
        "last_ingested_time": "last_ingested_time",
        "last_record_processed_time": "last_record_processed_time",
        "last_updated_at": "last_updated_at",
        "node_id": "node_id",
        "node_slug": "node_slug",
        "progress": {
          "entries": [
            {
              "label": "Last Processed",
              "partition_key": "partition_key",
              "ranges": [
                {
                  "end": "end",
                  "start": "start"
                }
              ]
            }
          ]
        },
        "status": "Unknown"
      }
    ],
    "organization_id": "organization_id",
    "organization_name": "organization_name",
    "pipeline_id": "pipeline_id",
    "pipeline_name": "pipeline_name",
    "progress": {
      "entries": [
        {
          "label": "Last Processed",
          "partition_key": "partition_key",
          "ranges": [
            {
              "end": "end",
              "start": "start"
            }
          ]
        }
      ]
    },
    "status": "Unknown",
    "stream": {
      "bytes": 0,
      "records": 0
    }
  },
  "updatedAt": "updatedAt"
}

json

application/json

Delete pipeline

DELETE

https://app.monad.com/api

/v2/{organization_id}/pipelines/{pipeline_id}

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:delete

Delete pipeline

Delete pipeline › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

Delete pipeline › Responses

Pipeline deleted successfully

string

Update pipeline

PATCH

https://app.monad.com/api

/v2/{organization_id}/pipelines/{pipeline_id}

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:write

Update an existing pipeline with the specified configuration

Update pipeline › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

Update pipeline › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Update pipeline › Responses

Pipeline updated successfully

models.PipelineConfigV2

billingAccountId

string

component_tier

integer

createdAt

string

cron_schedule

string

description

string

models.PipelineEdge[]

enabled

boolean

id

string

is_synthetic

boolean

managed_by

models.ManagedBy · enum

Enum values:

customer

internal

system

name

string

next_cron_run_at

string

models.PipelineNode[]

organizationId

string

organizationName

string

models.PipelineRetentionPolicy

models.PipelineStatus

updatedAt

string

PATCH/v2/{organization_id}/pipelines/{pipeline_id}

curl https://app.monad.com/api/v2/:organization_id/pipelines/:pipeline_id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "billingAccountId": "billingAccountId",
  "component_tier": 0,
  "createdAt": "createdAt",
  "cron_schedule": "cron_schedule",
  "description": "description",
  "edges": [
    {
      "conditions": {
        "conditions": [
          null
        ],
        "config": {
          "key": {}
        },
        "operator": "always",
        "type_id": "type_id"
      },
      "created_at": "created_at",
      "description": "description",
      "disabled": true,
      "from_node_instance_id": "from_node_instance_id",
      "id": "id",
      "name": "name",
      "organization_id": "organization_id",
      "pipeline_id": "pipeline_id",
      "schema_detection": true,
      "to_node_instance_id": "to_node_instance_id",
      "updated_at": "updated_at"
    }
  ],
  "enabled": true,
  "id": "id",
  "is_synthetic": true,
  "managed_by": "customer",
  "name": "name",
  "next_cron_run_at": "next_cron_run_at",
  "nodes": [
    {
      "component": {
        "config": {
          "key": {}
        },
        "description": "description",
        "id": "id",
        "name": "name",
        "references": {
          "secrets": [
            {
              "id": "id",
              "organization_id": "organization_id"
            }
          ]
        },
        "type": "type"
      },
      "component_house": "component_house",
      "component_id": "component_id",
      "component_sub_type": "component_sub_type",
      "component_type": "transform",
      "created_at": "created_at",
      "enabled": true,
      "id": "id",
      "organization_id": "organization_id",
      "pipeline_id": "pipeline_id",
      "slug": "slug",
      "status": {
        "avg_bytes_per_record_egress": 0,
        "avg_bytes_per_record_ingress": 0,
        "backpressure": {
          "bytes": 0,
          "records": 0
        },
        "component_type": "component_type",
        "component_type_id": "component_type_id",
        "egress": {
          "bytes": 0,
          "records": 0
        },
        "errors": 0,
        "ingress": {
          "bytes": 0,
          "records": 0
        },
        "last_ingested_time": "last_ingested_time",
        "last_record_processed_time": "last_record_processed_time",
        "last_updated_at": "last_updated_at",
        "node_id": "node_id",
        "node_slug": "node_slug",
        "progress": {
          "entries": [
            {
              "label": "Last Processed",
              "partition_key": "partition_key",
              "ranges": [
                {
                  "end": "end",
                  "start": "start"
                }
              ]
            }
          ]
        },
        "status": "Unknown"
      }
    }
  ],
  "organizationId": "organizationId",
  "organizationName": "organizationName",
  "retention_policy": {
    "stream_age_limit": 0,
    "stream_size_limit": "stream_size_limit"
  },
  "status": {
    "average_size_egressed": 0,
    "average_size_ingested": 0,
    "egress": {
      "bytes": 0,
      "records": 0
    },
    "errors": 0,
    "ingress": {
      "bytes": 0,
      "records": 0
    },
    "last_ingested_time": "last_ingested_time",
    "last_updated_at": "last_updated_at",
    "nodes": [
      {
        "avg_bytes_per_record_egress": 0,
        "avg_bytes_per_record_ingress": 0,
        "backpressure": {
          "bytes": 0,
          "records": 0
        },
        "component_type": "component_type",
        "component_type_id": "component_type_id",
        "egress": {
          "bytes": 0,
          "records": 0
        },
        "errors": 0,
        "ingress": {
          "bytes": 0,
          "records": 0
        },
        "last_ingested_time": "last_ingested_time",
        "last_record_processed_time": "last_record_processed_time",
        "last_updated_at": "last_updated_at",
        "node_id": "node_id",
        "node_slug": "node_slug",
        "progress": {
          "entries": [
            {
              "label": "Last Processed",
              "partition_key": "partition_key",
              "ranges": [
                {
                  "end": "end",
                  "start": "start"
                }
              ]
            }
          ]
        },
        "status": "Unknown"
      }
    ],
    "organization_id": "organization_id",
    "organization_name": "organization_name",
    "pipeline_id": "pipeline_id",
    "pipeline_name": "pipeline_name",
    "progress": {
      "entries": [
        {
          "label": "Last Processed",
          "partition_key": "partition_key",
          "ranges": [
            {
              "end": "end",
              "start": "start"
            }
          ]
        }
      ]
    },
    "status": "Unknown",
    "stream": {
      "bytes": 0,
      "records": 0
    }
  },
  "updatedAt": "updatedAt"
}

json

application/json

Update pipeline edge

PATCH

https://app.monad.com/api

/v2/{organization_id}/pipelines/{pipeline_id}/edges/{edge_id}

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:write

Enable or disable a pipeline edge

Update pipeline edge › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

edge_id

string · required

Edge ID

Update pipeline edge › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Update pipeline edge › Responses

Edge updated successfully

No data returned

Force graduate schema state

POST

https://app.monad.com/api

/v2/{organization_id}/pipelines/{pipeline_id}/edges/{edge_id}/schema/graduate

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:write

Force an edge in learning mode to immediately graduate to detection mode

Force graduate schema state › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

edge_id

string · required

Edge ID

Force graduate schema state › Responses

Schema state graduated to detection mode

No data returned

Reset schema state

POST

https://app.monad.com/api

/v2/{organization_id}/pipelines/{pipeline_id}/edges/{edge_id}/schema/reset

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:write

Delete the current schema state for an edge and signal the sidecar to restart in learning mode

Reset schema state › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

edge_id

string · required

Edge ID

Reset schema state › Responses

Schema state reset successfully

No data returned

Get pipeline status

GET

https://app.monad.com/api

/v2/{organization_id}/pipelines/{pipeline_id}/status

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:read

Get pipeline status

Get pipeline status › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

Get pipeline status › query Parameters

metrics

string[]

start

string

ISO3339 start time, default 24 hours ago

end

string

ISO3339 end time, default now

Get pipeline status › Responses

Pipeline status

models.PipelineStatus

average_size_egressed

integer

average_size_ingested

integer

models.DataUsage

errors

integer

models.DataUsage

last_ingested_time

string

last_updated_at

string

models.PipelineNodeStatus[]

organization_id

string

organization_name

string

pipeline_id

string

pipeline_name

string

models.ProgressEntries

status

models.PipelineStatusValue · enum

Enum values:

Unknown

Pending

Initializing

Running

Disabled

Erroring

Throttled

models.PipelineStreamInfo

GET/v2/{organization_id}/pipelines/{pipeline_id}/status

curl https://app.monad.com/api/v2/:organization_id/pipelines/:pipeline_id/status \
  --header 'Authorization: <api-key>'

Example Responses

{
  "average_size_egressed": 0,
  "average_size_ingested": 0,
  "egress": {
    "bytes": 0,
    "records": 0
  },
  "errors": 0,
  "ingress": {
    "bytes": 0,
    "records": 0
  },
  "last_ingested_time": "last_ingested_time",
  "last_updated_at": "last_updated_at",
  "nodes": [
    {
      "avg_bytes_per_record_egress": 0,
      "avg_bytes_per_record_ingress": 0,
      "backpressure": {
        "bytes": 0,
        "records": 0
      },
      "component_type": "component_type",
      "component_type_id": "component_type_id",
      "egress": {
        "bytes": 0,
        "records": 0
      },
      "errors": 0,
      "ingress": {
        "bytes": 0,
        "records": 0
      },
      "last_ingested_time": "last_ingested_time",
      "last_record_processed_time": "last_record_processed_time",
      "last_updated_at": "last_updated_at",
      "node_id": "node_id",
      "node_slug": "node_slug",
      "progress": {
        "entries": [
          {
            "label": "Last Processed",
            "partition_key": "partition_key",
            "ranges": [
              {
                "end": "end",
                "start": "start"
              }
            ]
          }
        ]
      },
      "status": "Unknown"
    }
  ],
  "organization_id": "organization_id",
  "organization_name": "organization_name",
  "pipeline_id": "pipeline_id",
  "pipeline_name": "pipeline_name",
  "progress": {
    "entries": [
      {
        "label": "Last Processed",
        "partition_key": "partition_key",
        "ranges": [
          {
            "end": "end",
            "start": "start"
          }
        ]
      }
    ]
  },
  "status": "Unknown",
  "stream": {
    "bytes": 0,
    "records": 0
  }
}

json

application/json

Get pipeline node status

GET

https://app.monad.com/api

/v2/{organization_id}/pipelines/{pipeline_id}/status/{node_id}

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:read

Get pipeline node status

Get pipeline node status › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

node_id

string · required

Node ID

Get pipeline node status › query Parameters

metrics

string[]

start

string

ISO3339 start time, default 24 hours ago

end

string

ISO3339 end time, default now

Get pipeline node status › Responses

Pipeline Node status

models.PipelineNodeStatus

avg_bytes_per_record_egress

integer

avg_bytes_per_record_ingress

integer

models.NodeBackpressure

component_type

string

component_type_id

string

models.DataUsage

errors

integer

models.DataUsage

last_ingested_time

string

last_record_processed_time

string

last_updated_at

string

node_id

string

node_slug

string

models.ProgressEntries

status

models.PipelineStatusValue · enum

Enum values:

Unknown

Pending

Initializing

Running

Disabled

Erroring

Throttled

GET/v2/{organization_id}/pipelines/{pipeline_id}/status/{node_id}

curl https://app.monad.com/api/v2/:organization_id/pipelines/:pipeline_id/status/:node_id \
  --header 'Authorization: <api-key>'

Example Responses

{
  "avg_bytes_per_record_egress": 0,
  "avg_bytes_per_record_ingress": 0,
  "backpressure": {
    "bytes": 0,
    "records": 0
  },
  "component_type": "component_type",
  "component_type_id": "component_type_id",
  "egress": {
    "bytes": 0,
    "records": 0
  },
  "errors": 0,
  "ingress": {
    "bytes": 0,
    "records": 0
  },
  "last_ingested_time": "last_ingested_time",
  "last_record_processed_time": "last_record_processed_time",
  "last_updated_at": "last_updated_at",
  "node_id": "node_id",
  "node_slug": "node_slug",
  "progress": {
    "entries": [
      {
        "label": "Last Processed",
        "partition_key": "partition_key",
        "ranges": [
          {
            "end": "end",
            "start": "start"
          }
        ]
      }
    ]
  },
  "status": "Unknown"
}

json

application/json

Trigger pipeline manually

POST

https://app.monad.com/api

/v2/{organization_id}/pipelines/{pipeline_id}/trigger

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:write

Manually trigger a cron-scheduled pipeline to run

Trigger pipeline manually › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

Trigger pipeline manually › Responses

Pipeline triggered successfully

string

deprecated

Get pipeline node metrics

GET

https://app.monad.com/api

/v2/{organization_id}/pipelines/{pipeline_id}/{node_id}/metrics

Authorization (header)

x-api-key (header)

Required Permissions: pipeline:read

Get pipeline node metrics

Get pipeline node metrics › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

node_id

string · required

Node ID

Get pipeline node metrics › query Parameters

metric

string · required

Metric to retrieve (ingress_bytes|egress_bytes|ingress_records|egress_records|errors)

start

string

ISO3339 start time, default 6 hours ago

end

string

ISO3339 end time, default now

resolution

string

Resolution of the data, default determined by time window

Get pipeline node metrics › Responses

Pipeline node metrics

models.PipelineMetrics

end_at

string

metric

string

node_id

string

node_slug

string

organization_id

string

organization_name

string

pipeline_id

string

pipeline_name

string

resolution

string

start_at

string

models.PipelineMetricsValue[]

Conditional types for edge conditions

GET

https://app.monad.com/api

/v3/pipeline_edges/edge_condition_operator_types

Authorization (header)

x-api-key (header)

Required Permissions: None (authentication only)

Returns the conditional types for edge conditions

Conditional types for edge conditions › Responses

200

Conditions returned succesfully

string

Rules for edge conditions

GET

https://app.monad.com/api

/v3/pipeline_edges/edge_condition_rules

Authorization (header)

x-api-key (header)

Required Permissions: None (authentication only)

Returns the rules for edge conditions

Rules for edge conditions › Responses

200

Rules returned succesfully

string

Get schema state

GET

https://app.monad.com/api

/v3/{organization_id}/pipelines/{pipeline_id}/edges/{edge_id}/schema-detection

Authorization (header)

x-api-key (header)

Get the current schema state for a pipeline edge

Get schema state › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

edge_id

string · required

Edge ID

Get schema state › Responses

Current schema state

routesV3.schemaStateResponse

edge_id

string

learning_start

string

mode

string

pipeline_id

string

object

total_records_observed

integer

updated_at

string

List schema history

GET

https://app.monad.com/api

/v3/{organization_id}/pipelines/{pipeline_id}/edges/{edge_id}/schema-detection/events

Authorization (header)

x-api-key (header)

List schema drift events for a pipeline edge

List schema history › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

edge_id

string · required

Edge ID

List schema history › Responses

Schema history

routesV3.schemaHistoryEntryResponse[]

routesV3.schemaHistoryEntryResponse

created_at

string

edge_id

string

event_tags

string[]

id

string

object

Purge pipeline node data

POST

https://app.monad.com/api

/v3/{organization_id}/pipelines/{pipeline_id}/nodes/{node_id}/purge

Authorization (header)

x-api-key (header)

Purge messages destined for a specific pipeline node

Purge pipeline node data › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

node_id

string · required

Node ID

Purge pipeline node data › Responses

Purge completed

models.PipelinePurgeResponse

error

string

purged

boolean

Purge pipeline data

POST

https://app.monad.com/api

/v3/{organization_id}/pipelines/{pipeline_id}/purge

Authorization (header)

x-api-key (header)

Purge all messages from a pipeline's NATS stream

Purge pipeline data › path Parameters

organization_id

string · required

Organization ID

pipeline_id

string · required

Pipeline ID

Purge pipeline data › Responses

Purge completed

models.PipelinePurgeResponse

error

string

purged

boolean

Enrichment Sandbox Conditions