Flume Health

Flume Health Endpoints API

The Endpoints API from Flume Health — 23 operation(s) for endpoints.

GitHub OpenAPI

Operations 29

GET /api/v1/endpoints List Endpoints #
POST /api/v1/endpoints Create Endpoint #
GET /api/v1/endpoints/datatypes Get Endpoint Datatypes #
GET /api/v1/endpoints/datatypes/{datatype} Get Endpoint Datatype #
GET /api/v1/endpoints/lambdas List Endpoint Lambdas #
GET /api/v1/endpoints/{id} Get Endpoint #
PATCH /api/v1/endpoints/{id} Update Endpoint #
POST /api/v1/endpoints/{id}/datalake-ingest Stream CSV Ingest to DataLake Endpoint #
POST /api/v1/endpoints/{id}/datalake-query Query DataLake Endpoint #
POST /api/v1/endpoints/{id}/datalake-write Execute Write Query on DataLake Endpoint #
GET /api/v1/endpoints/{id}/secrets/api Get Endpoint Api Secrets #
GET /api/v1/endpoints/{id}/secrets/cloudstorage Get Endpoint Cloud Storage Secrets #
GET /api/v1/endpoints/{id}/secrets/cloudstorage/encryption Get Endpoint Cloud Storage EncryptionSecrets #
GET /api/v1/endpoints/{id}/secrets/database Get Endpoint Database Secrets #
GET /api/v1/endpoints/{id}/secrets/flumelakehouse Get Endpoint FlumeLakehouse Secrets #
GET /api/v1/endpoints/{id}/secrets/sftp Get Endpoint SFTP Secret #
GET /api/v1/endpoints/{id}/secrets/sftp/encryption Get Endpoint SFTP Encryption Secret #
GET /api/v1/endpoints/{id}/secrets/snowflake Get Endpoint Snowflake Secrets #
GET /api/v1/endpoints/{id}/tests/cloudstorage Test Existing Cloud Storage Connection #
POST /api/v1/endpoints/{id}/tests/cloudstorage Test New Cloud Storage Connection #
GET /api/v1/endpoints/{id}/tests/database Test Existing Database Connection #
POST /api/v1/endpoints/{id}/tests/database Test New Database Connection #
POST /api/v1/endpoints/{id}/tests/map Test Endpoint map #
GET /api/v1/endpoints/{id}/tests/sftp Get Endpoint SFTP Connection #
POST /api/v1/endpoints/{id}/tests/sftp Test Endpoint SFTP Connection #
GET /api/v1/endpoints/{id}/tests/snowflake Get Endpoint Snowflake Connection #
POST /api/v1/endpoints/{id}/tests/snowflake Test Endpoint Snowflake Connection #
POST /api/v1/endpoints/{id}/{fieldType}/resources Update Endpoint Resources #
DELETE /api/v1/endpoints/{id}/{fieldType}/resources/{key} Delete Endpoint Resource by Key #

Documentation

📖
APIReference
https://console.flumehealth.com/api/docs
📖
Documentation
https://docs.flumehealth.com/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/flume-health/refs/heads/main/authentication/flume-health-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/flume-health/refs/heads/main/rate-limits/flume-health-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/flume-health/refs/heads/main/openapi/flume-health-endpoints-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/flume-health/refs/heads/main/scopes/flume-health-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/flume-health/refs/heads/main/conventions/flume-health-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/flume-health/refs/heads/main/errors/flume-health-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/flume-health/refs/heads/main/data-model/flume-health-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/flume-health-endpoints-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

flume-health-endpoints-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: 'The API for Relay by Flume Health.


    For more information about how Flume can power your health plan, please [contact us](mailto:sales@flumehealth.com).


    [Redoc](/api/docs/) | [Swagger - Try It](/api/swagger/)

    '
  title: Flume Console Endpoints API
  contact: {}
  version: '1.0'
  x-logo:
    altText: Flume Health
    url: https://public-static.flume.health/front/logo-margin-512.png
servers:
- url: https://console.flumehealth.com/
- url: http://console.flumehealth.com/
tags:
- name: Endpoints
paths:
  /api/v1/endpoints:
    get:
      description: Lists Endpoints.
      tags:
      - Endpoints
      summary: List Endpoints
      operationId: listEndpoints
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      - description: The page to request. Should be a previously-received nextPageToken
        name: pageToken
        in: query
        schema:
          type: string
      - description: Number of Endpoints to return
        name: pageSize
        in: query
        schema:
          type: string
      - description: List of ids to filter for. If empty, no filtration occurs.
        name: ids
        in: query
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - description: List of endpoint states to filter for. If empty, no filtration occurs.
        name: states
        in: query
        style: form
        explode: true
        schema:
          type: array
          items:
            enum:
            - Idle
            - Running
            - Error
            - Stopped
            type: string
      - description: Connection ID to filter for
        name: connectionId
        in: query
        schema:
          type: integer
      - description: View to return. If `alerts` is provided, endpoints that should be alerted on are returned
        name: view
        in: query
        schema:
          type: string
      - description: Return Archived Endpoints
        name: archived
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/endpoint.ListResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
    post:
      description: Creates an Endpoint.
      tags:
      - Endpoints
      summary: Create Endpoint
      operationId: createEndpoint
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/endpoint.ReadModel'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/endpoint.WriteModel'
        description: Endpoint Body
        required: true
  /api/v1/endpoints/datatypes:
    get:
      description: Gets the list of data types that can be used in an endpoint mapping.
      tags:
      - Endpoints
      summary: Get Endpoint Datatypes
      operationId: getEndpointDataTypes
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/datatypes.DataTypes'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
  /api/v1/endpoints/datatypes/{datatype}:
    get:
      description: Gets the information for a specific datatype that can be used in an endpoint mapping.
      tags:
      - Endpoints
      summary: Get Endpoint Datatype
      operationId: getEndpointDataType
      parameters:
      - description: name of the datatype
        name: datatype
        in: path
        required: true
        schema:
          type: string
          enum:
          - Accumulators
          - Authorizations
          - Bytes
          - Eligibility
          - Groups
          - MedicalClaimServiceLines
          - Providers
          - RxClaimServiceLines
          - MedicalAndRxClaimLines
          - Test
          - TransactionMetadata
          - Generic
          - RecordLevelMetadata
          - PlanNetworks
          - ProviderNetworkDirectory
          - HmClaimsExtended
          - HmProvidersExtended
          - Strings
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/datatypes.DataType'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
  /api/v1/endpoints/lambdas:
    get:
      description: Lists Lambdas for Endpoints.
      tags:
      - Endpoints
      summary: List Endpoint Lambdas
      operationId: listEndpointLambdas
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      - description: The page to request. Should be a previously-received nextPageToken
        name: pageToken
        in: query
        schema:
          type: string
      - description: Number of Lambdas to return
        name: pageSize
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/endpoint.LambdaList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
  /api/v1/endpoints/{id}:
    get:
      description: Gets an Endpoint.
      tags:
      - Endpoints
      summary: Get Endpoint
      operationId: getEndpoint
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      - description: id of the endpoint
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: View to return. If `pipeline` is provided, shards and jobs are omitted for faster loading
        name: view
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/endpoint.ReadModel'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
    patch:
      description: Updates an Endpoint.
      tags:
      - Endpoints
      summary: Update Endpoint
      operationId: updateEndpoint
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      - description: id of the endpoint
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/endpoint.ReadModel'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/endpoint.UpdateModel'
        description: Endpoint Body
        required: true
  /api/v1/endpoints/{id}/datalake-ingest:
    post:
      description: Stream a CSV file body to be ingested into an Iceberg table via Trino. The request body is raw CSV (not JSON) — metadata is passed via headers.
      tags:
      - Endpoints
      summary: Stream CSV Ingest to DataLake Endpoint
      operationId: postIngestEndpoint
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      - description: Endpoint ID
        name: id
        in: path
        required: true
        schema:
          type: integer
      - description: Fully qualified Iceberg table name (e.g. lakekeeper.ref_data.my_table)
        name: X-Table-Name
        in: header
        required: true
        schema:
          type: string
      - description: Rows per INSERT batch (100-10000, default 5000)
        name: X-Batch-Size
        in: header
        schema:
          type: integer
      responses:
        '200':
          description: Ingest results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/flitclient.IngestResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Endpoint not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
      requestBody:
        content:
          text/csv:
            schema:
              type: string
        description: CSV content with header row
        required: true
  /api/v1/endpoints/{id}/datalake-query:
    post:
      description: Execute a SQL query against a DataLake endpoint and stream the NDJSON results
      tags:
      - Endpoints
      summary: Query DataLake Endpoint
      operationId: postQueryEndpoint
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      - description: Endpoint ID
        name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK
        '400':
          description: Bad request
          content:
            application/x-ndjson:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Endpoint not found
          content:
            application/x-ndjson:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/x-ndjson:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/endpoint.QueryEndpointRequest'
        description: Query request
        required: true
  /api/v1/endpoints/{id}/datalake-write:
    post:
      description: Execute a SQL write query against a DataLake endpoint
      tags:
      - Endpoints
      summary: Execute Write Query on DataLake Endpoint
      operationId: postQueryWriteEndpoint
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      - description: Endpoint ID
        name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Write results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/flitclient.WriteResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Endpoint not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/endpoint.QueryEndpointRequest'
        description: Write query request
        required: true
  /api/v1/endpoints/{id}/secrets/api:
    get:
      description: Gets Endpoint Api secret
      tags:
      - Endpoints
      summary: Get Endpoint Api Secrets
      operationId: getEndpointApiSecret
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      - description: id of the endpoint
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secret.ApiSecret'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
  /api/v1/endpoints/{id}/secrets/cloudstorage:
    get:
      description: Gets endpoint cloud storage secrets
      tags:
      - Endpoints
      summary: Get Endpoint Cloud Storage Secrets
      operationId: getEndpointCloudStorageSecret
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      - description: id of the endpoint
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secret.ApiCloudCredSecret'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
  /api/v1/endpoints/{id}/secrets/cloudstorage/encryption:
    get:
      description: Gets endpoint cloud storage encryption secrets
      tags:
      - Endpoints
      summary: Get Endpoint Cloud Storage EncryptionSecrets
      operationId: getEndpointCloudStorageEncryptionSecret
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      - description: id of the endpoint
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secret.ApiEncryptionSecret'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
  /api/v1/endpoints/{id}/secrets/database:
    get:
      description: Gets Endpoint Database secret
      tags:
      - Endpoints
      summary: Get Endpoint Database Secrets
      operationId: getEndpointDatabaseSecret
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      - description: id of the endpoint
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secret.ApiSecret'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
  /api/v1/endpoints/{id}/secrets/flumelakehouse:
    get:
      description: Gets Endpoint FlumeLakehouse Secrets (catalogConfigs JSON credential)
      tags:
      - Endpoints
      summary: Get Endpoint FlumeLakehouse Secrets
      operationId: getEndpointFlumeLakehouseSecret
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      - description: id of the endpoint
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secret.ApiFlumeLakehouseSecret'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
  /api/v1/endpoints/{id}/secrets/sftp:
    get:
      description: Gets endpoint sftp secret
      tags:
      - Endpoints
      summary: Get Endpoint SFTP Secret
      operationId: getEndpointSftpSecret
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      - description: id of the endpoint
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secret.ApiSecret'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
  /api/v1/endpoints/{id}/secrets/sftp/encryption:
    get:
      description: Gets endpoint sftp encryption secret
      tags:
      - Endpoints
      summary: Get Endpoint SFTP Encryption Secret
      operationId: getEndpointSftpEncryptionSecret
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      - description: id of the endpoint
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secret.ApiEncryptionSecret'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
  /api/v1/endpoints/{id}/secrets/snowflake:
    get:
      description: Gets Endpoint Snowflake Secrets
      tags:
      - Endpoints
      summary: Get Endpoint Snowflake Secrets
      operationId: getEndpointSnowflakeSecret
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      - description: id of the endpoint
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secret.ApiSecret'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
  /api/v1/endpoints/{id}/tests/cloudstorage:
    get:
      description: Inspects the cloud storage connection to the server described by the endpoint's Cloud Storage credentials. If it is traversable, it exists and a 200 is returned.
      tags:
      - Endpoints
      summary: Test Existing Cloud Storage Connection
      operationId: getTestCloudStorageConnection
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      - description: id of the endpoint
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
      - OAuth2Implicit:
        - openid
        - profile
        - email
    post:
      description: Tests the cloud storage connection to the server described by the Cloud Storage credentials. If it is traversable, it exists and a 200 is returned.
      tags:
      - Endpoints
      summary: Test New Cloud Storage Connection
      operationId: postTestCloudStorageConnection
      parameters:
      - description: X-Flume-Account-ID
        name: X-Flume-Account-ID
        in: header
        schema:
          type: string
      - description: id of the endpoint
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
 

# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flume-health/refs/heads/main/openapi/flume-health-endpoints-api-openapi.yml