GEgetorchestra
Integrations

Get an integration

Changed on

Fetch a single integration by its identifier, including its auth and job schemas. Each auth_schema item's name is a connection field, and format: password marks a secret one.

get/integrations/{integration}

Request

  • Base URL
    https://app.getorchestra.io/api/engine/public
  • URL
    https://app.getorchestra.io/api/engine/public/integrations/{integration}
  • Auth
    none required

Path parameters

integration'AIRBYTE_CLOUD' | 'AIRBYTE_SERVER' | 'AIRFLOW' | 'ARCH' | 'ALTERYX_SERVER' | 'ANTHROPIC' | 'AWS_EC2' | 'AWS_ECS' | 'AWS_EMR' | 'AWS_EKS' | 'AWS_FIREHOSE' | 'AWS_GLUE' | 'AWS_LAMBDA' | 'AWS_RDS' | 'AWS_REDSHIFT' | 'AWS_S3' | 'AWS_BATCH' | 'AWS_BEDROCK' | 'AWS_SAGEMAKER' | 'AWS_SECRETS_MANAGER' | 'AWS_SES' | 'AWS_STEP_FUNCTIONS' | 'AZURE' | 'AZURE_CONTAINER_APPS' | 'AZURE_DATA_FACTORY' | 'AZURE_DATA_LAKE_STORAGE' | 'AZURE_KEY_VAULT' | 'AZURE_KUBERNETES_SERVICE' | 'AZURE_LOGIC_APPS' | 'AZURE_SYNAPSE_ANALYTICS' | 'AZURE_VM' | 'BAUPLAN' | 'BOOMI' | 'CDATA' | 'CENSUS' | 'CLICKHOUSE' | 'COALESCE' | 'COUNT' | 'DATADOG' | 'DATABRICKS' | 'DATAPROC' | 'DATAZEN' | 'DBT' | 'DBT_CORE' | 'DLT' | 'DOMO' | 'DREMIO' | 'DUCKDB' | 'EMAIL' | 'ESTUARY' | 'ETLEAP' | 'FABRIC' | 'FABRIC_SYNAPSE' | 'FIVETRAN' | 'FORTRA' | 'GCP_BIG_QUERY' | 'GCP_CLOUD_RUN' | 'GCP_CLOUD_FUNCTIONS' | 'GCP_CLOUD_STORAGE' | 'GCP_DATAFLOW' | 'GCP_DATAFORM' | 'GCP_DATASTREAM' | 'GCP_LOOKER' | 'GKE' | 'GITHUB_ACTIONS' | 'GOOGLE_CLOUD' | 'HEVO' | 'HEX' | 'HIGHTOUCH' | 'HTTP' | 'HUBSPOT' | 'INFORMATICA_IICS' | 'INFORMATICA_POWERCENTER' | 'KAFKA' | 'KEBOOLA' | 'KLEENE' | 'LIGHTDASH' | 'LINUX_SSH' | 'MARIADB' | 'MATILLION' | 'MATILLION_ETL' | 'METAPLANE' | 'MICROSOFT_TEAMS' | 'MICROSTRATEGY' | 'MONGODB' | 'MOTHERDUCK' | 'MYSQL' | 'N8N' | 'NIMBLE' | 'NOTION' | 'OMNI' | 'OPEN_AI' | 'ORCHESTRA' | 'PARADIME' | 'PAGER_DUTY' | 'PINECONE' | 'PORTABLE' | 'POSTGRES' | 'POWER_AUTOMATE' | 'POWER_BI' | 'PREFECT_CLOUD' | 'PYTHON' | 'QLIK' | 'QLIK_REPLICATE' | 'QUICKBOOKS' | 'RENDER' | 'RIVERY' | 'RUDDERSTACK' | 'SALESFORCE' | 'SAP' | 'SFTP' | 'SHAREPOINT' | 'SIGMA' | 'SISENSE' | 'SLACK' | 'SNOWFLAKE' | 'SNOWPLOW' | 'SODA' | 'SQL_MESH' | 'SQL_SERVER' | 'STITCH' | 'STREAMKAP' | 'TABLEAU_CLOUD' | 'TALEND_CLOUD' | 'THOUGHTSPOT' | 'TOBIKO_CLOUD' | 'TYPESAFE' | 'WEAVIATE' | 'WEBHOOK' | 'WELD' | 'WINDOWS_SSH' required

Response

Successful Response

id'AIRBYTE_CLOUD' | 'AIRBYTE_SERVER' | 'AIRFLOW' | 'ARCH' | 'ALTERYX_SERVER' | 'ANTHROPIC' | 'AWS_EC2' | 'AWS_ECS' | 'AWS_EMR' | 'AWS_EKS' | 'AWS_FIREHOSE' | 'AWS_GLUE' | 'AWS_LAMBDA' | 'AWS_RDS' | 'AWS_REDSHIFT' | 'AWS_S3' | 'AWS_BATCH' | 'AWS_BEDROCK' | 'AWS_SAGEMAKER' | 'AWS_SECRETS_MANAGER' | 'AWS_SES' | 'AWS_STEP_FUNCTIONS' | 'AZURE' | 'AZURE_CONTAINER_APPS' | 'AZURE_DATA_FACTORY' | 'AZURE_DATA_LAKE_STORAGE' | 'AZURE_KEY_VAULT' | 'AZURE_KUBERNETES_SERVICE' | 'AZURE_LOGIC_APPS' | 'AZURE_SYNAPSE_ANALYTICS' | 'AZURE_VM' | 'BAUPLAN' | 'BOOMI' | 'CDATA' | 'CENSUS' | 'CLICKHOUSE' | 'COALESCE' | 'COUNT' | 'DATADOG' | 'DATABRICKS' | 'DATAPROC' | 'DATAZEN' | 'DBT' | 'DBT_CORE' | 'DLT' | 'DOMO' | 'DREMIO' | 'DUCKDB' | 'EMAIL' | 'ESTUARY' | 'ETLEAP' | 'FABRIC' | 'FABRIC_SYNAPSE' | 'FIVETRAN' | 'FORTRA' | 'GCP_BIG_QUERY' | 'GCP_CLOUD_RUN' | 'GCP_CLOUD_FUNCTIONS' | 'GCP_CLOUD_STORAGE' | 'GCP_DATAFLOW' | 'GCP_DATAFORM' | 'GCP_DATASTREAM' | 'GCP_LOOKER' | 'GKE' | 'GITHUB_ACTIONS' | 'GOOGLE_CLOUD' | 'HEVO' | 'HEX' | 'HIGHTOUCH' | 'HTTP' | 'HUBSPOT' | 'INFORMATICA_IICS' | 'INFORMATICA_POWERCENTER' | 'KAFKA' | 'KEBOOLA' | 'KLEENE' | 'LIGHTDASH' | 'LINUX_SSH' | 'MARIADB' | 'MATILLION' | 'MATILLION_ETL' | 'METAPLANE' | 'MICROSOFT_TEAMS' | 'MICROSTRATEGY' | 'MONGODB' | 'MOTHERDUCK' | 'MYSQL' | 'N8N' | 'NIMBLE' | 'NOTION' | 'OMNI' | 'OPEN_AI' | 'ORCHESTRA' | 'PARADIME' | 'PAGER_DUTY' | 'PINECONE' | 'PORTABLE' | 'POSTGRES' | 'POWER_AUTOMATE' | 'POWER_BI' | 'PREFECT_CLOUD' | 'PYTHON' | 'QLIK' | 'QLIK_REPLICATE' | 'QUICKBOOKS' | 'RENDER' | 'RIVERY' | 'RUDDERSTACK' | 'SALESFORCE' | 'SAP' | 'SFTP' | 'SHAREPOINT' | 'SIGMA' | 'SISENSE' | 'SLACK' | 'SNOWFLAKE' | 'SNOWPLOW' | 'SODA' | 'SQL_MESH' | 'SQL_SERVER' | 'STITCH' | 'STREAMKAP' | 'TABLEAU_CLOUD' | 'TALEND_CLOUD' | 'THOUGHTSPOT' | 'TOBIKO_CLOUD' | 'TYPESAFE' | 'WEAVIATE' | 'WEBHOOK' | 'WELD' | 'WINDOWS_SSH' required
displayNamestring required
descriptionstring nullable

A one-sentence summary of what the integration does in Orchestra

baseLogoUrlstring nullable

The URL for the logo for the integration in light mode

darkModeLogoUrlstring nullable

The URL for the logo for the integration in dark mode

jobTypesIntegrationJobType[]
supportedInOrchestraRuntimeboolean

Whether an agent's runs can be made with this integration's connections

status'ALPHA' | 'COMMUNITY' | 'BETA' | 'RELEASE' | 'DEPRECATED' | 'ROADMAP' | 'HIDDEN' required
setupGuideUrlstring nullable required
setupDocsUrlstring nullable required
supportedAssetTypesAssetTypeEnum[]
supportedAssetFeaturesAssetFeatureEnum[] nullable required
priorityinteger required
topboolean required
tagsstring[] nullable

Changes

  • e45165e7e223Revision changes
    • breaking

      removed the enum value CLAUDE from the path request parameter integration

    • warning

      added the new ANTHROPIC enum value to the response property for the response status

    • warning

      added the new AWS_BATCH enum value to the response property for the response status

    • warning

      added the new AWS_SES enum value to the response property for the response status

    • warning

      added the new AWS_STEP_FUNCTIONS enum value to the response property for the response status

    • warning

      added the new Business Applications enum value to the / response property for the response status

    • warning

      added the new CRM enum value to the / response property for the response status

    • warning

      added the new DREMIO enum value to the response property for the response status

    • warning

      added the new HUBSPOT enum value to the response property for the response status

    • warning

      added the new MARIADB enum value to the response property for the response status

    • warning

      added the new MONGODB enum value to the response property for the response status

    • warning

      added the new MYSQL enum value to the response property for the response status

    • warning

      added the new N8N enum value to the response property for the response status

    • warning

      added the new NOTION enum value to the response property for the response status

    • warning

      added the new QUICKBOOKS enum value to the response property for the response status

    • warning

      added the new SALESFORCE enum value to the response property for the response status

    • warning

      added the new SHAREPOINT enum value to the response property for the response status

    • warning

      added the new TYPESAFE enum value to the response property for the response status

    • info

      the endpoint scheme security BearerAuthReadOnly was removed from the API

    • info

      added the new enum value ANTHROPIC to the path request parameter integration

    • info

      added the new enum value AWS_BATCH to the path request parameter integration

    • info

      added the new enum value AWS_SES to the path request parameter integration

    • info

      added the new enum value AWS_STEP_FUNCTIONS to the path request parameter integration

    • info

      added the new enum value DREMIO to the path request parameter integration

    • info

      added the new enum value HUBSPOT to the path request parameter integration

    • info

      added the new enum value MARIADB to the path request parameter integration

    • info

      added the new enum value MONGODB to the path request parameter integration

    • info

      added the new enum value MYSQL to the path request parameter integration

    • info

      added the new enum value N8N to the path request parameter integration

    • info

      added the new enum value NOTION to the path request parameter integration

    • info

      added the new enum value QUICKBOOKS to the path request parameter integration

    • info

      added the new enum value SALESFORCE to the path request parameter integration

    • info

      added the new enum value SHAREPOINT to the path request parameter integration

    • info

      added the new enum value TYPESAFE to the path request parameter integration

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      removed the CLAUDE enum value from the response property for the response status