Organization Inputs

Endpointhttps://app.monad.com/api

Download schema

Organization-specific input endpoints

List organization inputs

GET

https://app.monad.com/api

/v1/{organization_id}/inputs

Authorization (header)

x-api-key (header)

List configured inputs in organization

List organization inputs › path Parameters

organization_id

string · required

Organization ID

List organization inputs › query Parameters

limit

integer

Limit the number of organizations returned (default: DefaultLimit)

offset

integer

Offset the organizations returned (default: 0)

List organization inputs › Responses

200

Inputs retrieved successfully

object[]

object

Get organization input

GET

https://app.monad.com/api

/v1/{organization_id}/inputs/{input_id}

Authorization (header)

x-api-key (header)

Get a configured input in organization

Get organization input › path Parameters

organization_id

string · required

Organization ID

input_id

string · required

Input ID

Get organization input › Responses

200

Input retrieved successfully

object[]

object

created_at

string

description

string

id

string

managed_by

string · enum

Enum values:

customer

internal

system

name

string

organization_id

string

type

string

updated_at

string

GET/v1/{organization_id}/inputs/{input_id}

curl --request GET \
  --url https://app.monad.com/api/v1/:organization_id/inputs/:input_id

shell

Example Responses

{
  "component_of": [
    {
      "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"
    }
  ],
  "config": {
    "secrets": {
      "key": {}
    },
    "settings": {
      "key": {}
    }
  },
  "created_at": "created_at",
  "description": "description",
  "id": "id",
  "managed_by": "customer",
  "name": "name",
  "organization_id": "organization_id",
  "type": "type",
  "updated_at": "updated_at"
}

json

application/json

Delete input

DELETE

https://app.monad.com/api

/v1/{organization_id}/inputs/{input_id}

Authorization (header)

x-api-key (header)

Delete input

Delete input › path Parameters

organization_id

string · required

Organization ID

input_id

string · required

Input ID

Delete input › Responses

Create input

POST

https://app.monad.com/api

/v2/{organization_id}/inputs

Authorization (header)

x-api-key (header)

Create a new input with configuration including secrets handling

Create input › path Parameters

organization_id

string · required

Organization ID

Create input › query Parameters

test_connection

boolean

Test connection before creating the input

Create input › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Create input › Responses

Input created successfully

object

created_at

string

description

string

id

string

managed_by

string · enum

Enum values:

customer

internal

system

name

string

organization_id

string

type

string

updated_at

string

Test input connection

POST

https://app.monad.com/api

/v2/{organization_id}/inputs/test-connection

Authorization (header)

x-api-key (header)

Tests the connection for a given input type and configuration

Test input connection › path Parameters

organization_id

string · required

Organization ID

Test input connection › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Test input connection › Responses

Connection test successful

message

string

Replace input

PUT

https://app.monad.com/api

/v2/{organization_id}/inputs/{input_id}

Authorization (header)

x-api-key (header)

Replace an existing input with new configuration including secrets handling

Replace input › path Parameters

organization_id

string · required

Organization ID

input_id

string · required

Input ID

Replace input › query Parameters

test_connection

boolean

Test connection before creating the input

Replace input › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Replace input › Responses

Input updated successfully

object

created_at

string

description

string

id

string

managed_by

string · enum

Enum values:

customer

internal

system

name

string

organization_id

string

type

string

updated_at

string

Update input

PATCH

https://app.monad.com/api

/v2/{organization_id}/inputs/{input_id}

Authorization (header)

x-api-key (header)

Update an existing input with new configuration including secrets handling

Update input › path Parameters

organization_id

string · required

Organization ID

input_id

string · required

Input ID

Update input › query Parameters

test_connection

boolean

Test connection before creating the input

Update input › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Update input › Responses

Input updated successfully

object

created_at

string

description

string

id

string

managed_by

string · enum

Enum values:

customer

internal

system

name

string

organization_id

string

type

string

updated_at

string

Inputs Outputs

Monad API

Organization Inputs

Endpointhttps://app.monad.com/api

Download schema

Organization-specific input endpoints

List organization inputs

GET

https://app.monad.com/api

/v1/{organization_id}/inputs

Authorization (header)

x-api-key (header)

List configured inputs in organization

List organization inputs › path Parameters

organization_id

string · required

Organization ID

List organization inputs › query Parameters

limit

integer

Limit the number of organizations returned (default: DefaultLimit)

offset

integer

Offset the organizations returned (default: 0)

List organization inputs › Responses

200

Inputs retrieved successfully

object[]

object

Get organization input

GET

https://app.monad.com/api

/v1/{organization_id}/inputs/{input_id}

Authorization (header)

x-api-key (header)

Get a configured input in organization

Get organization input › path Parameters

organization_id

string · required

Organization ID

input_id

string · required

Input ID

Get organization input › Responses

200

Input retrieved successfully

object[]

object

created_at

string

description

string

id

string

managed_by

string · enum

Enum values:

customer

internal

system

name

string

organization_id

string

type

string

updated_at

string

GET/v1/{organization_id}/inputs/{input_id}

curl --request GET \
  --url https://app.monad.com/api/v1/:organization_id/inputs/:input_id

shell

Example Responses

{
  "component_of": [
    {
      "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"
    }
  ],
  "config": {
    "secrets": {
      "key": {}
    },
    "settings": {
      "key": {}
    }
  },
  "created_at": "created_at",
  "description": "description",
  "id": "id",
  "managed_by": "customer",
  "name": "name",
  "organization_id": "organization_id",
  "type": "type",
  "updated_at": "updated_at"
}

json

application/json

Delete input

DELETE

https://app.monad.com/api

/v1/{organization_id}/inputs/{input_id}

Authorization (header)

x-api-key (header)

Delete input

Delete input › path Parameters

organization_id

string · required

Organization ID

input_id

string · required

Input ID

Delete input › Responses

Create input

POST

https://app.monad.com/api

/v2/{organization_id}/inputs

Authorization (header)

x-api-key (header)

Create a new input with configuration including secrets handling

Create input › path Parameters

organization_id

string · required

Organization ID

Create input › query Parameters

test_connection

boolean

Test connection before creating the input

Create input › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Create input › Responses

Input created successfully

object

created_at

string

description

string

id

string

managed_by

string · enum

Enum values:

customer

internal

system

name

string

organization_id

string

type

string

updated_at

string

Test input connection

POST

https://app.monad.com/api

/v2/{organization_id}/inputs/test-connection

Authorization (header)

x-api-key (header)

Tests the connection for a given input type and configuration

Test input connection › path Parameters

organization_id

string · required

Organization ID

Test input connection › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Test input connection › Responses

Connection test successful

message

string

Replace input

PUT

https://app.monad.com/api

/v2/{organization_id}/inputs/{input_id}

Authorization (header)

x-api-key (header)

Replace an existing input with new configuration including secrets handling

Replace input › path Parameters

organization_id

string · required

Organization ID

input_id

string · required

Input ID

Replace input › query Parameters

test_connection

boolean

Test connection before creating the input

Replace input › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Replace input › Responses

Input updated successfully

object

created_at

string

description

string

id

string

managed_by

string · enum

Enum values:

customer

internal

system

name

string

organization_id

string

type

string

updated_at

string

Update input

PATCH

https://app.monad.com/api

/v2/{organization_id}/inputs/{input_id}

Authorization (header)

x-api-key (header)

Update an existing input with new configuration including secrets handling

Update input › path Parameters

organization_id

string · required

Organization ID

input_id

string · required

Input ID

Update input › query Parameters

test_connection

boolean

Test connection before creating the input

Update input › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Update input › Responses

Input updated successfully

object

created_at

string

description

string

id

string

managed_by

string · enum

Enum values:

customer

internal

system

name

string

organization_id

string

type

string

updated_at

string

Inputs Outputs