Organization Inputs
Organization-specific input endpoints
List organization inputs
Required Permissions:
input:read
List configured inputs in organization
path Parameters
organization_idOrganization ID
query Parameters
limitLimit the number of organizations returned (default: DefaultLimit)
offsetOffset the organizations returned (default: 0)
List organization inputs › Responses
Inputs retrieved successfully
Get organization input
Required Permissions:
input:read
Get a configured input in organization
path Parameters
organization_idOrganization ID
input_idInput ID
Get organization input › Responses
Input retrieved successfully
created_atdescriptionidmanaged_bynameorganization_idResourceReferences are the resources (e.g. secrets) referenced only via the override delta, tracked so deletion/rotation see them like component refs.
ShareDetails is set when the enrichment is involved in org-to-org sharing.
typeupdated_atversionCreate input
Required Permissions:
input:write
Create a new input with configuration including secrets handling
path Parameters
organization_idOrganization ID
query Parameters
test_connectionTest connection before creating the input
Create input › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |
Create input › Responses
Input created successfully
created_atdescriptionidmanaged_bynameorganization_idResourceReferences are the resources (e.g. secrets) referenced only via the override delta, tracked so deletion/rotation see them like component refs.
ShareDetails is set when the enrichment is involved in org-to-org sharing.
typeupdated_atversionTest input connection
Required Permissions:
input:write
Tests the connection for a given input type and configuration
path Parameters
organization_idOrganization ID
Test input connection › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |
Test input connection › Responses
Connection test successful
messageReplace input
Required Permissions:
input:write
Replace an existing input with new configuration including secrets handling
path Parameters
organization_idOrganization ID
input_idInput ID
query Parameters
test_connectionTest connection before creating the input
Replace input › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |
Replace input › Responses
Input updated successfully
created_atdescriptionidmanaged_bynameorganization_idResourceReferences are the resources (e.g. secrets) referenced only via the override delta, tracked so deletion/rotation see them like component refs.
ShareDetails is set when the enrichment is involved in org-to-org sharing.
typeupdated_atversionUpdate input
Required Permissions:
input:write
Update an existing input with new configuration including secrets handling
path Parameters
organization_idOrganization ID
input_idInput ID
query Parameters
test_connectionTest connection before creating the input
Update input › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |
Update input › Responses
Input updated successfully
created_atdescriptionidmanaged_bynameorganization_idResourceReferences are the resources (e.g. secrets) referenced only via the override delta, tracked so deletion/rotation see them like component refs.
ShareDetails is set when the enrichment is involved in org-to-org sharing.
typeupdated_atversionPreview an input config change
Required Permissions:
input:write
Validate a proposed input config and, with impact=true, report the pipelines a save would affect. Persists nothing.
path Parameters
organization_idOrganization ID
input_idInput ID
query Parameters
impactInclude the affected-pipelines blast radius
Preview an input config change › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |
Preview an input config change › Responses
Configuration is valid
changed