Flume Console API
The REST API for Relay by Flume Health. Manages Accounts, Account Contracts, Connections, Endpoints and their per-protocol secrets and tests (API, cloud storage, database, SFTP, Snowflake, Flume Lakehouse), Endpoint Maps, Shards, Transactions, Source Files, Business Objects and Instances, Users, Flags, Worker Sizes, Reports, Telemetry, and v2 trade/automap jobs — plus the Context Discovery, Context Graph, and Context Knowledge surfaces. Swagger 2.0, 153 operations across 108 paths, OAuth 2.0 / OIDC bearer auth, account scoping via the X-Flume-Account-ID header, and pageToken/pageSize cursor pagination.
The identity and technical contract details declared by the specification.
account.AccountConfigColors
object
3 properties
account.BlobConfig
object
5 properties
account.ListResponse
object
2 properties
account.ReadAccountConfigModel
object
5 properties
account.ReadModel
object
6 properties
account.UpdateAccountConfigModel
object
3 properties
account.UpdateModel
object
4 properties
account.WriteModel
object
4 properties
1 required
accountcontract.ListResponse
object
2 properties
accountcontract.ReadModel
object
7 properties
accountcontract.UpdateModel
object
5 properties
accountcontract.WriteModel
object
5 properties
3 required
api.ReadModel
object
3 properties
api.UpdateModel
object
3 properties
api.WriteModel
object
3 properties
automapjob.ConfidenceLevel
string
automapjob.FieldMapping
object
6 properties
3 required
automapjob.FieldMappingUpdate
object
6 properties
automapjob.FieldStatus
string
automapjob.ListResponse
object
2 properties
automapjob.Maps
object
2 properties
automapjob.MapsUpdate
object
2 properties
automapjob.Outputs
object
2 properties
automapjob.OutputsUpdate
object
2 properties
automapjob.ReadModel
object
13 properties
automapjob.UpdateModel
object
9 properties
cloudstorage.ReadModel
object
8 properties
cloudstorage.UpdateModel
object
8 properties
cloudstorage.WriteModel
object
8 properties
cloudstoragecredentials.CloudStorageCredentials
object
cloudstoragecredentials.CredentialType
string
connection.ListResponse
object
2 properties
connection.PatchModel
object
3 properties
connection.ReadModel
object
5 properties
1 required
connection.WriteModel
object
3 properties
1 required
database.DatabaseMap
object
3 properties
database.ReadModel
object
11 properties
database.UpdateModel
object
11 properties
database.WriteModel
object
11 properties
datatypes.DataType
object
3 properties
datatypes.DataTypes
object
1 property
datatypes.Field
object
4 properties
datatypes.FieldType
object
3 properties
discovery.ApproverCreateRequest
object
4 properties
1 required
discovery.ApproverListResponse
object
2 properties
discovery.ApproverReadModel
object
13 properties
discovery.ApproverRevokeRequest
object
1 property
discovery.ConnectionListResponse
object
2 properties
discovery.ConnectionPatchModel
object
9 properties
discovery.ConnectionReadModel
object
14 properties
discovery.ConnectionTestResult
object
3 properties
discovery.ConnectionType
string
discovery.ConnectionWriteModel
object
9 properties
3 required
discovery.ExtractionCreateRequest
object
5 properties
3 required
discovery.ExtractionListResponse
object
2 properties
discovery.ExtractionReadModel
object
15 properties
discovery.ExtractionResultModel
object
17 properties
discovery.ExtractionStatus
string
discovery.ExtractionType
string
discovery.GrantType
string
discovery.SessionApproveRequest
object
1 property
discovery.SessionCancelRequest
object
1 property
discovery.SessionCreateRequest
object
Request to create a PAM session for database access or approver delegation.
7 properties
2 required
discovery.SessionDenyRequest
object
1 property
1 required
discovery.SessionExtendRequest
object
2 properties
2 required
discovery.SessionGrantReadModel
object
2 properties
discovery.SessionGrantRequest
object
Approver creates a pre-approved PAM session for another user.
5 properties
3 required
discovery.SessionLaunchRequest
object
Record of a single AI CLI tool launch under a subscriptionaccess session.
3 properties
discovery.SessionLaunchResponse
object
A recorded AI CLI tool launch under a subscriptionaccess session.
6 properties
discovery.SessionListResponse
object
2 properties
discovery.SessionReadModel
object
PAM session granting time-limited access to database connections.
19 properties
discovery.SessionRevokeRequest
object
1 property
discovery.SessionStatus
string
duckdb.Config
object
1 property
duckdb.File
object
2 properties
1 required
encryption.ReadModel
object
4 properties
encryption.UpdateModel
object
4 properties
encryption.WriteModel
object
4 properties
endpoint.ConnectionName
object
2 properties
endpoint.EndpointType
string
endpoint.Field
object
3 properties
endpoint.File
object
15 properties
endpoint.FileFilterType
string
endpoint.FileUpdate
object
14 properties
endpoint.LambdaList
object
2 properties
endpoint.LambdaResponse
object
2 properties
endpoint.ListResponse
object
2 properties
endpoint.LookbackModifiedByUser
object
3 properties
endpoint.LoopbackUnit
string
endpoint.Operation
string
endpoint.QueryEndpointRequest
object
1 property
endpoint.ReadModel
object
39 properties
4 required
endpoint.RecentTransactions
object
6 properties
endpoint.TransactionSummary
object
5 properties
endpoint.UpdateModel
object
29 properties
endpoint.WorkerSize
string
endpoint.WriteModel
object
29 properties
5 required
endpointmap.FieldType
string
endpointmap.ListResponse
object
2 properties
endpointmap.MapVersion
object
5 properties
endpointmap.ReadModel
object
6 properties
flag.Flag
object
2 properties
flag.ListReadModel
object
1 property
flitclient.IngestResponse
object
3 properties
flitclient.WriteResponse
object
3 properties
flumelakehouse.FlumeLakehouseMap
object
3 properties
flumelakehouse.ReadModel
object
3 properties
flumelakehouse.UpdateModel
object
3 properties
flumelakehouse.WriteModel
object
3 properties
flumelakehousecredentials.CatalogConfig
object
3 properties
flumelakehousecredentials.CredentialType
string
flumelakehousecredentials.FlumeLakehouseCredentials
object
1 property
graph.Meta
object
1 property
graph.QueryMeta
object
3 properties
graph.QueryRequest
object
1 property
1 required
graph.QueryResponse
object
3 properties
graph.SearchMeta
object
3 properties
graph.SearchResponse
object
2 properties
graph.StatusResponse
object
5 properties
job.EndpointSummary
object
6 properties
job.ListResponse
object
2 properties
job.ReadModel
object
13 properties
1 required
job.TestFile
object
2 properties
1 required
job.TestRequest
object
1 property
1 required
job.UpdateModel
object
7 properties
job.WriteModel
object
7 properties
1 required
knowledge.ApproveReviewItemRequest
object
2 properties
knowledge.AttachCandidate
object
4 properties
knowledge.AttachCandidatesResponse
object
2 properties
knowledge.ConflictEdgeRef
object
1 property
knowledge.ConflictWarningResp
object
3 properties
knowledge.CreateArtifactRequest
object
9 properties
1 required
knowledge.CreateArtifactResponse
object
1 property
knowledge.DisambiguationResponse
object
2 properties
knowledge.EntityArtifact
object
5 properties
knowledge.EntityAttachment
object
4 properties
knowledge.EntityBadges
object
5 properties
knowledge.EntityLifecycle
object
6 properties
knowledge.EntityProvenance
object
11 properties
knowledge.FeedbackEvent
object
5 properties
knowledge.FeedbackEventListResponse
object
1 property
knowledge.FeedbackRequest
object
4 properties
1 required
knowledge.FeedbackVote
string
knowledge.GateDecision
string
knowledge.GraphNodeBadges
object
4 properties
knowledge.GraphPeekAttachment
object
3 properties
knowledge.GraphPeekNode
object
9 properties
knowledge.InjectedItem
object
7 properties
knowledge.KnowledgeEntityPayload
object
16 properties
knowledge.KnowledgeGraphEdge
object
4 properties
knowledge.KnowledgeGraphNode
object
5 properties
knowledge.KnowledgeGraphResponse
object
2 properties
knowledge.KnowledgeListResponse
object
2 properties
knowledge.KnowledgePrefixBlock
object
2 properties
knowledge.KnowledgePrefixResponse
object
2 properties
knowledge.KnowledgeScope
object
2 properties
knowledge.LinkArtifactRequest
object
2 properties
2 required
knowledge.MergeReviewItemRequest
object
1 property
1 required
knowledge.Meta
object
1 property
knowledge.PatchKnowledgeRequest
object
9 properties
knowledge.PromotionArtifactCheck
object
4 properties
knowledge.PromotionArtifactFreshness
object
2 properties
knowledge.PromotionFreshnessVerdict
string
knowledge.PromotionPreflightResponse
object
4 properties
knowledge.ProposalListResponse
object
1 property
knowledge.ProposalPayload
object
12 properties
knowledge.RecallTraceItem
object
3 properties
knowledge.RejectReviewItemRequest
object
1 property
knowledge.ReviewItemPayload
object
7 properties
knowledge.ReviewQueueResponse
object
1 property
knowledge.SupersedeRequest
object
1 property
1 required
knowledge.SuppressedItem
object
4 properties
knowledge.SuppressionReason
string
knowledge.TurnKnowledgePayload
object
8 properties
knowledgemanager.AttachCandidate
object
4 properties
knowledgemanager.AttachInput
object
7 properties
1 required
knowledgemanager.AttachResult
object
3 properties
knowledgemanager.BulkItem
object
4 properties
1 required
knowledgemanager.BulkItemError
object
2 properties
knowledgemanager.BulkResult
object
3 properties
knowledgemanager.BulkWriteInput
object
2 properties
1 required
knowledgemanager.ConflictWarning
object
3 properties
knowledgemanager.CreateKnowledgeInput
object
19 properties
4 required
knowledgemanager.KnowledgeWriteError
object
3 properties
knowledgemanager.KnowledgeWriteErrorCode
string
knowledgemanager.NewBusinessTerm
object
2 properties
1 required
knowledgestore.AppliesToEdge
object
6 properties
knowledgestore.ArtifactKind
string
knowledgestore.FreshnessBand
string
knowledgestore.InheritanceMode
string
knowledgestore.KnowledgeEntity
object
29 properties
knowledgestore.KnowledgeResultBadge
object
2 properties
knowledgestore.KnowledgeScopeType
string
knowledgestore.KnowledgeStatus
string
knowledgestore.RecallPolicy
string
knowledgestore.ReviewItem
object
9 properties
knowledgestore.ReviewItemStatus
string
knowledgestore.ReviewItemType
string
knowledgestore.SearchResult
object
5 properties
object.CanonicalColumn
object
2 properties
2 required
object.ListResponse
object
2 properties
object.ReadModel
object
4 properties
2 required
object.UpdateModel
object
2 properties
object.WriteModel
object
2 properties
2 required
objectinstance.BulkWriteModel
object
1 property
objectinstance.CustomValue
object
2 properties
objectinstance.CustomValuesByConnection
object
objectinstance.ListResponse
object
2 properties
objectinstance.ObjectSummary
object
2 properties
objectinstance.ReadModel
object
7 properties
4 required
objectinstance.UpdateModel
object
5 properties
objectinstance.WriteModel
object
5 properties
4 required
report.GroupsTradedLine
object
4 properties
responses.ErrorResponse
object
3 properties
secret.ApiCloudCredSecret
object
2 properties
secret.ApiEncryptionSecret
object
2 properties
secret.ApiFlumeLakehouseSecret
object
2 properties
secret.ApiSecret
object
2 properties
sftp.ReadModel
object
14 properties
sftp.UpdateModel
object
14 properties
sftp.WriteModel
object
14 properties
shard.BulkWriteModel
object
1 property
shard.ReadModel
object
8 properties
1 required
shard.RecentTransactions
object
5 properties
shard.TransactionSummary
object
4 properties
shard.WriteModel
object
1 property
1 required
snowflake.Field
object
3 properties
2 required
snowflake.ReadModel
object
13 properties
snowflake.UpdateModel
object
13 properties
snowflake.WriteModel
object
13 properties
sourcefile.ArchiveType
string
sourcefile.BulkPatchModel
object
4 properties
2 required
sourcefile.BulkWriteModel
object
1 property
sourcefile.ControlFile
object
4 properties
sourcefile.ListResponse
object
2 properties
sourcefile.PatchModel
object
6 properties
sourcefile.ReadModel
object
19 properties
sourcefile.WriteModel
object
16 properties
4 required
telemetry.ReadModel
object
6 properties
transaction.FileDetail
object
10 properties
transaction.ListReadModel
object
2 properties
transaction.Operation
string
transaction.ReadModel
object
16 properties
transaction.Step
object
10 properties
transaction.Steps
object
3 properties
transaction.Trigger
string
transaction.WriteModel
object
9 properties
2 required
user.ListModel
object
2 properties
user.QueryEngineGrantRequest
object
2 properties
2 required
user.QueryEngineGrantResponse
object
4 properties
user.ReadModel
object
14 properties
user.SelfUser
object
6 properties
user.SelfUserPatchModel
object
1 property
user.WriteModel
object
6 properties
5 required
workersize.ListResponse
object
2 properties
workersize.ReadModel
object
4 properties
workersize.UpdateModel
object
2 properties
The full machine-readable OpenAPI contract behind this narrative.