Organization Transforms

created_at

string

description

string

id

string

managed_by

models.ManagedBy · enum

Enum values:

customer

internal

system

name

string

organization_id

string

ResourceReferences are the resources (e.g. secrets) referenced only via the override delta, tracked so deletion/rotation see them like component refs.

routes.GetTransformResponse

ShareDetails is set when the enrichment is involved in org-to-org sharing.

updated_at

string

version

integer

POST/v1/{organization_id}/transforms

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

Example Request Body

{}

json

Example Responses

{
  "config": {
    "operations": [
      {
        "arguments": {
          "key": {}
        },
        "description": "description",
        "operation": "operation"
      }
    ]
  },
  "created_at": "created_at",
  "description": "description",
  "id": "id",
  "managed_by": "customer",
  "name": "name",
  "organization_id": "organization_id",
  "references": {
    "secrets": [
      {
        "id": "id",
        "name": "name",
        "organization_id": "organization_id",
        "shared": true
      }
    ]
  },
  "share_details": {
    "owner_organization_id": "owner_organization_id",
    "owner_organization_name": "owner_organization_name",
    "shared_with_children": true,
    "shared_with_me": true
  },
  "updated_at": "updated_at",
  "version": 0
}

json

application/json

Get transform

GET

https://app.monad.com/api

/v1/{organization_id}/transforms/{transform_id}

Authorization (header)

x-api-key (header)

Required Permissions: transform:read

Get transform

Get transform › path Parameters

transform_id

string · required

Transform ID

organization_id

string · required

Organization ID

Get transform › Responses

Transform retrieved successfully

models.Pipeline[]

created_at

string

description

string

id

string

managed_by

models.ManagedBy · enum

Enum values:

customer

internal

system

name

string

organization_id

string

ResourceReferences are the resources (e.g. secrets) referenced only via the override delta, tracked so deletion/rotation see them like component refs.

routes.UpdateTransformRequest

ShareDetails is set when the enrichment is involved in org-to-org sharing.

updated_at

string

version

integer

GET/v1/{organization_id}/transforms/{transform_id}

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

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
        }
      },
      "tags": [
        "string"
      ],
      "updated_at": "updated_at"
    }
  ],
  "config": {
    "operations": [
      {
        "arguments": {
          "key": {}
        },
        "description": "description",
        "operation": "operation"
      }
    ]
  },
  "created_at": "created_at",
  "description": "description",
  "id": "id",
  "managed_by": "customer",
  "name": "name",
  "organization_id": "organization_id",
  "references": {
    "secrets": [
      {
        "id": "id",
        "name": "name",
        "organization_id": "organization_id",
        "shared": true
      }
    ]
  },
  "share_details": {
    "owner_organization_id": "owner_organization_id",
    "owner_organization_name": "owner_organization_name",
    "shared_with_children": true,
    "shared_with_me": true
  },
  "updated_at": "updated_at",
  "version": 0
}

json

application/json

Delete transform

DELETE

https://app.monad.com/api

/v1/{organization_id}/transforms/{transform_id}

Authorization (header)

x-api-key (header)

Required Permissions: transform:delete

Delete transform

Delete transform › path Parameters

organization_id

string · required

Organization ID

transform_id

string · required

Transform ID

Delete transform › Responses

Update transform

PATCH

https://app.monad.com/api

/v1/{organization_id}/transforms/{transform_id}

Authorization (header)

x-api-key (header)

Required Permissions: transform:write

Update transform

Update transform › path Parameters

organization_id

string · required

Organization ID

transform_id

string · required

Transform ID

Update transform › Request Body

Request body for updating a transform

routes.TransformConfig

description

string

name

string

Update transform › Responses

Transform updated successfully

created_at

string

description

string

id

string

managed_by

models.ManagedBy · enum

Enum values:

customer

internal

system

name

string

organization_id

string

ResourceReferences are the resources (e.g. secrets) referenced only via the override delta, tracked so deletion/rotation see them like component refs.

Transforms Transforms Repository

ShareDetails is set when the enrichment is involved in org-to-org sharing.

updated_at

string

version

integer

PATCH/v1/{organization_id}/transforms/{transform_id}

curl https://app.monad.com/api/v1/:organization_id/transforms/:transform_id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --data '{
  "config": {
    "operations": [
      {
        "arguments": {
          "key": {}
        },
        "description": "description",
        "operation": "operation",
        "secrets": {
          "key": {}
        }
      }
    ]
  },
  "description": "description",
  "name": "name"
}'

Example Request Body

{
  "config": {
    "operations": [
      {
        "arguments": {
          "key": {}
        },
        "description": "description",
        "operation": "operation",
        "secrets": {
          "key": {}
        }
      }
    ]
  },
  "description": "description",
  "name": "name"
}

json

Example Responses

{
  "config": {
    "operations": [
      {
        "arguments": {
          "key": {}
        },
        "description": "description",
        "operation": "operation"
      }
    ]
  },
  "created_at": "created_at",
  "description": "description",
  "id": "id",
  "managed_by": "customer",
  "name": "name",
  "organization_id": "organization_id",
  "references": {
    "secrets": [
      {
        "id": "id",
        "name": "name",
        "organization_id": "organization_id",
        "shared": true
      }
    ]
  },
  "share_details": {
    "owner_organization_id": "owner_organization_id",
    "owner_organization_name": "owner_organization_name",
    "shared_with_children": true,
    "shared_with_me": true
  },
  "updated_at": "updated_at",
  "version": 0
}

json

application/json

List configured transforms in a transform

GET

https://app.monad.com/api

/v1/{organization_id}/transforms

Authorization (header)

x-api-key (header)

Required Permissions: transform:read

List transforms

List configured transforms in a transform › path Parameters

organization_id

string · required

Organization ID

List configured transforms in a transform › query Parameters

limit

integer

Limit

offset

integer

Offset

List configured transforms in a transform › Responses

List of transforms

models.TransformList

github_com_monad-inc_core_pkg_types_models.Pagination

Pagination metadata.

models.Transform[]

Create transform

POST

https://app.monad.com/api

/v1/{organization_id}/transforms

Authorization (header)

x-api-key (header)

Required Permissions: transform:write

Create transform

Create transform › path Parameters

organization_id

string · required

Organization ID

Create transform › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object · requires: name

Properties for Variant 1:

Create transform › Responses

Transform created successfully

created_at

string

description

string

id

string

managed_by

models.ManagedBy · enum

Enum values:

customer

internal

system

name

string

organization_id

string

ResourceReferences are the resources (e.g. secrets) referenced only via the override delta, tracked so deletion/rotation see them like component refs.

routes.GetTransformResponse

ShareDetails is set when the enrichment is involved in org-to-org sharing.

updated_at

string

version

integer

Get transform

GET

https://app.monad.com/api

/v1/{organization_id}/transforms/{transform_id}

Authorization (header)

x-api-key (header)

Required Permissions: transform:read

Get transform

Get transform › path Parameters

transform_id

string · required

Transform ID

organization_id

string · required

Organization ID

Get transform › Responses

Transform retrieved successfully

models.Pipeline[]

created_at

string

description

string

id

string

managed_by

models.ManagedBy · enum

Enum values:

customer

internal

system

name

string

organization_id

string

ResourceReferences are the resources (e.g. secrets) referenced only via the override delta, tracked so deletion/rotation see them like component refs.

routes.UpdateTransformRequest

ShareDetails is set when the enrichment is involved in org-to-org sharing.

updated_at

string

version

integer

Delete transform

DELETE

https://app.monad.com/api

/v1/{organization_id}/transforms/{transform_id}

Authorization (header)

x-api-key (header)

Required Permissions: transform:delete

Delete transform

Delete transform › path Parameters

organization_id

string · required

Organization ID

transform_id

string · required

Transform ID

Delete transform › Responses

Update transform

PATCH

https://app.monad.com/api

/v1/{organization_id}/transforms/{transform_id}

Authorization (header)

x-api-key (header)

Required Permissions: transform:write

Update transform

Update transform › path Parameters

organization_id

string · required

Organization ID

transform_id

string · required

Transform ID

Update transform › Request Body

Request body for updating a transform

routes.TransformConfig

description

string

name

string

Update transform › Responses

Transform updated successfully

created_at

string

description

string

id

string

managed_by

models.ManagedBy · enum

Enum values:

customer

internal

system

name

string

organization_id

string

ResourceReferences are the resources (e.g. secrets) referenced only via the override delta, tracked so deletion/rotation see them like component refs.