# Integrations
External sources from which resources and metadata are extracted.
## List Integrations
> This endpoint will return all the integrations active in your workspace.
```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"tags":[{"name":"Integrations","description":"External sources from which resources and metadata are extracted."}],"servers":[{"url":"https://api.secoda.co","description":"Base URL for all US cloud based workspaces"},{"url":"https://eapi.secoda.co","description":"Base URL for all EU cloud based workspaces"},{"url":"https://aapi.secoda.co","description":"Base URL for all APAC cloud based workspaces"},{"url":"https://{customer_domain}.secoda.co","description":"Base URL for On Premise Secoda workspaces","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"paths":{"/api/v1/integration/integrations":{"get":{"tags":["Integrations"],"summary":"List Integrations","description":"This endpoint will return all the integrations active in your workspace.","parameters":[{"name":"type","in":"query","schema":{"type":"string"},"description":"The type of integrations to filter."}],"responses":{"200":{"description":"List of integrations.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/v1_ListResponse"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/v1_IntegrationResponse"}}}}]}}}},"400":{"description":"Bad request."},"500":{"description":"Internal server error."}}}}},"components":{"schemas":{"v1_ListResponse":{"type":"object","properties":{"links":{"type":"object","description":"Indicates Links to associated pages.","properties":{"next":{"type":"string","description":"The link to the next page (null if there are no more pages)."},"previous":{"type":"string","description":"The link to the previous page (null if on the first page)."}}},"meta":{"type":"object","description":"Reprents the meta data of the response.","properties":{"page":{"type":"integer","description":"The current page number."},"previous_page":{"type":"integer","description":"The previous page number (null if on the first page)."},"next_page":{"type":"integer","description":"The next page number (null if on the last page)."}}},"count":{"type":"integer","description":"The total count of items returned."},"total_pages":{"type":"integer","description":"The total number of pages."}}},"v1_IntegrationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the created integration."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the integration was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the integration was last updated in Secoda UTC format."},"name":{"type":"string","description":"The name of the integration."},"type":{"type":"string","description":"The type of integration."},"credentials":{"type":"object","description":"The actual credentials of the integration will NOT be returned. Can you find the easter egg in this response parameter for native integrations?"},"workspace_id":{"type":"string","description":"The ID of the associated workspace."},"ssh_tunnel":{"type":"string","description":"Information about SSH tunnel if one is set update."},"execute_access":{"type":"array","items":{"type":"string"},"description":"List of IDs that have the permission to trigger the extracton."},"scheduled_extractions_hour":{"type":"integer","description":"Hour for scheduled extractions. Will be null for custom extractions."},"scheduled_extractions_frequency":{"type":"integer","description":"Frequency in days of scheduled extractions. Will be null for custom extractions."},"scheduled_extractions_next_run":{"type":"string","format":"date-time","description":"Next scheduled extraction run time. Will be null for custom extractions."},"scheduled_extractions_last_run":{"type":"string","description":"Last scheduled extraction run time (null in this response)."},"properties":{"type":"object","description":"Additional properties associated with the integration."},"preview_access_users":{"type":"array","items":{"type":"string"},"description":"List of users IDs with access to preview the data in the integration."},"preview_access_roles":{"type":"array","items":{"type":"string"},"description":"List of roles that are allowed to preview the data in the integration. "},"preview_access_groups":{"type":"array","items":{"type":"string"},"description":"List of users group IDs with access to preview the data in the integration."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the integration."}}}}}}
```
## Create Integration
> Use this endpoint to create a \[custom integration]\(), or add credentials for a native integration programatically.
```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"tags":[{"name":"Integrations","description":"External sources from which resources and metadata are extracted."}],"servers":[{"url":"https://api.secoda.co","description":"Base URL for all US cloud based workspaces"},{"url":"https://eapi.secoda.co","description":"Base URL for all EU cloud based workspaces"},{"url":"https://aapi.secoda.co","description":"Base URL for all APAC cloud based workspaces"},{"url":"https://{customer_domain}.secoda.co","description":"Base URL for On Premise Secoda workspaces","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"paths":{"/api/v1/integration/integrations":{"post":{"tags":["Integrations"],"summary":"Create Integration","description":"Use this endpoint to create a [custom integration](https://docs.secoda.com/integrations/custom-integration), or add credentials for a native integration programatically.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Represents the name of the integration data source or tool."},"type":{"type":"string","description":"This indicates the type of integration (e.g., \"custom\")."},"teams":{"type":"array","items":{"type":"string"},"description":"Indicates the teams associated with this integration. The access can be edited in the UI."},"credentials":{"type":"object","description":"If you are adding a custom integration, the value of this parameter should always be empty {}."}}}}}},"responses":{"201":{"description":"Integration created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1_IntegrationResponse"}}}},"400":{"description":"Bad request."},"500":{"description":"Internal server error."}}}}},"components":{"schemas":{"v1_IntegrationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the created integration."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the integration was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the integration was last updated in Secoda UTC format."},"name":{"type":"string","description":"The name of the integration."},"type":{"type":"string","description":"The type of integration."},"credentials":{"type":"object","description":"The actual credentials of the integration will NOT be returned. Can you find the easter egg in this response parameter for native integrations?"},"workspace_id":{"type":"string","description":"The ID of the associated workspace."},"ssh_tunnel":{"type":"string","description":"Information about SSH tunnel if one is set update."},"execute_access":{"type":"array","items":{"type":"string"},"description":"List of IDs that have the permission to trigger the extracton."},"scheduled_extractions_hour":{"type":"integer","description":"Hour for scheduled extractions. Will be null for custom extractions."},"scheduled_extractions_frequency":{"type":"integer","description":"Frequency in days of scheduled extractions. Will be null for custom extractions."},"scheduled_extractions_next_run":{"type":"string","format":"date-time","description":"Next scheduled extraction run time. Will be null for custom extractions."},"scheduled_extractions_last_run":{"type":"string","description":"Last scheduled extraction run time (null in this response)."},"properties":{"type":"object","description":"Additional properties associated with the integration."},"preview_access_users":{"type":"array","items":{"type":"string"},"description":"List of users IDs with access to preview the data in the integration."},"preview_access_roles":{"type":"array","items":{"type":"string"},"description":"List of roles that are allowed to preview the data in the integration. "},"preview_access_groups":{"type":"array","items":{"type":"string"},"description":"List of users group IDs with access to preview the data in the integration."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the integration."}}}}}}
```
## Get Integration
> This endpoint will provide the details of an individual integration.
```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"tags":[{"name":"Integrations","description":"External sources from which resources and metadata are extracted."}],"servers":[{"url":"https://api.secoda.co","description":"Base URL for all US cloud based workspaces"},{"url":"https://eapi.secoda.co","description":"Base URL for all EU cloud based workspaces"},{"url":"https://aapi.secoda.co","description":"Base URL for all APAC cloud based workspaces"},{"url":"https://{customer_domain}.secoda.co","description":"Base URL for On Premise Secoda workspaces","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"paths":{"/api/v1/integration/integrations/{integration_id}":{"get":{"tags":["Integrations"],"summary":"Get Integration","description":"This endpoint will provide the details of an individual integration.","parameters":[{"name":"integration_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the integration to retrieve."}],"responses":{"200":{"description":"Integration details retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1_IntegrationResponse"}}}},"404":{"description":"Integration not found."},"500":{"description":"Internal server error."}}}}},"components":{"schemas":{"v1_IntegrationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the created integration."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the integration was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the integration was last updated in Secoda UTC format."},"name":{"type":"string","description":"The name of the integration."},"type":{"type":"string","description":"The type of integration."},"credentials":{"type":"object","description":"The actual credentials of the integration will NOT be returned. Can you find the easter egg in this response parameter for native integrations?"},"workspace_id":{"type":"string","description":"The ID of the associated workspace."},"ssh_tunnel":{"type":"string","description":"Information about SSH tunnel if one is set update."},"execute_access":{"type":"array","items":{"type":"string"},"description":"List of IDs that have the permission to trigger the extracton."},"scheduled_extractions_hour":{"type":"integer","description":"Hour for scheduled extractions. Will be null for custom extractions."},"scheduled_extractions_frequency":{"type":"integer","description":"Frequency in days of scheduled extractions. Will be null for custom extractions."},"scheduled_extractions_next_run":{"type":"string","format":"date-time","description":"Next scheduled extraction run time. Will be null for custom extractions."},"scheduled_extractions_last_run":{"type":"string","description":"Last scheduled extraction run time (null in this response)."},"properties":{"type":"object","description":"Additional properties associated with the integration."},"preview_access_users":{"type":"array","items":{"type":"string"},"description":"List of users IDs with access to preview the data in the integration."},"preview_access_roles":{"type":"array","items":{"type":"string"},"description":"List of roles that are allowed to preview the data in the integration. "},"preview_access_groups":{"type":"array","items":{"type":"string"},"description":"List of users group IDs with access to preview the data in the integration."},"teams":{"type":"array","items":{"type":"string"},"description":"List of team IDs associated with the integration."}}}}}}
```
## Delete Integration
> This endpoint deletes a specific integration by its ID.
```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"tags":[{"name":"Integrations","description":"External sources from which resources and metadata are extracted."}],"servers":[{"url":"https://api.secoda.co","description":"Base URL for all US cloud based workspaces"},{"url":"https://eapi.secoda.co","description":"Base URL for all EU cloud based workspaces"},{"url":"https://aapi.secoda.co","description":"Base URL for all APAC cloud based workspaces"},{"url":"https://{customer_domain}.secoda.co","description":"Base URL for On Premise Secoda workspaces","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"paths":{"/api/v1/integration/integrations/{integration_id}":{"delete":{"tags":["Integrations"],"summary":"Delete Integration","description":"This endpoint deletes a specific integration by its ID.\n","parameters":[{"name":"integration_id","in":"path","description":"ID of the integration to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Integration deleted successfully"},"404":{"description":"Integration not found."},"500":{"description":"Internal server error."}}}}}}
```
## Upload Integration Metadata (via CSV)
> This endpoint allows the upload of integration metadata using a CSV. This can also be done through the UI. See more about CSV uploads \[here]\().
```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"tags":[{"name":"Integrations","description":"External sources from which resources and metadata are extracted."}],"servers":[{"url":"https://api.secoda.co","description":"Base URL for all US cloud based workspaces"},{"url":"https://eapi.secoda.co","description":"Base URL for all EU cloud based workspaces"},{"url":"https://aapi.secoda.co","description":"Base URL for all APAC cloud based workspaces"},{"url":"https://{customer_domain}.secoda.co","description":"Base URL for On Premise Secoda workspaces","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"paths":{"/api/v1/integration/integrations/{integration_id}/import_metadata":{"post":{"tags":["Integrations"],"summary":"Upload Integration Metadata (via CSV)","description":"This endpoint allows the upload of integration metadata using a CSV. This can also be done through the UI. See more about CSV uploads [here](https://docs.secoda.com/integrations/custom-integration/import-your-resources).","parameters":[{"name":"integration_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the integration to upload metadata for."}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"The path to the CSV file containing your metadata and resources. The format of the CSV file can be found [here](https://docs.secoda.com/integrations/custom-integration/import-your-resources/create-your-csv).","type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Integration metadata uploaded successfully."},"404":{"description":"Integration not found."},"500":{"description":"Internal server error."}}}}}}
```
## Upload Integration Metadata (via JSONL)
> This endpoint allows the upload of integration metadata as well as integration lineage using a JSONL file. This can also be done through the UI. See more about JSONL uploads \[here]\().
```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"tags":[{"name":"Integrations","description":"External sources from which resources and metadata are extracted."}],"servers":[{"url":"https://api.secoda.co","description":"Base URL for all US cloud based workspaces"},{"url":"https://eapi.secoda.co","description":"Base URL for all EU cloud based workspaces"},{"url":"https://aapi.secoda.co","description":"Base URL for all APAC cloud based workspaces"},{"url":"https://{customer_domain}.secoda.co","description":"Base URL for On Premise Secoda workspaces","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"paths":{"/api/v1/integration/integrations/{integration_id}/import_jsonl_metadata":{"post":{"tags":["Integrations"],"summary":"Upload Integration Metadata (via JSONL)","description":"This endpoint allows the upload of integration metadata as well as integration lineage using a JSONL file. This can also be done through the UI. See more about JSONL uploads [here](https://docs.secoda.com/integrations/custom-integration/import-your-resources).","parameters":[{"name":"integration_id","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the integration to upload metadata and/or lineage for."}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["resources_file"],"properties":{"resources_file":{"type":"string","format":"binary","description":"The path to the your resources file. The expected formatting of this file can be found [here](https://docs.secoda.com/integrations/custom-integration/import-your-resources/create-your-jsonl-file)."},"lineages_file":{"description":"The path to the your lineages file. The expected formatting of this file can be found [here](https://docs.secoda.com/integrations/custom-integration/import-your-resources/create-your-jsonl-file).","type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Integration JSONL file uploaded successfully."},"404":{"description":"Integration not found."},"500":{"description":"Internal server error."}}}}}}
```
## POST /api/v1/integration/dbt/{integration\_id}/upload\_artifacts/
> Upload dbt Core Artifacts
```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"tags":[{"name":"Integrations","description":"External sources from which resources and metadata are extracted."}],"servers":[{"url":"https://api.secoda.co","description":"Base URL for all US cloud based workspaces"},{"url":"https://eapi.secoda.co","description":"Base URL for all EU cloud based workspaces"},{"url":"https://aapi.secoda.co","description":"Base URL for all APAC cloud based workspaces"},{"url":"https://{customer_domain}.secoda.co","description":"Base URL for On Premise Secoda workspaces","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"paths":{"/api/v1/integration/dbt/{integration_id}/upload_artifacts/":{"post":{"tags":["Integrations"],"summary":"Upload dbt Core Artifacts","parameters":[{"in":"path","name":"integration_id","description":"The ID of the dbt Core integration","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Artifacts uploaded successfully."}},"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"run_results":{"format":"binary","title":"Run Results","type":"string"},"manifest":{"format":"binary","title":"Manifest","type":"string"}},"required":["run_results","manifest"],"title":"FileParams","type":"object"}}},"required":true}}}}}
```
## POST /api/v1/integration/dbt/{integration\_id}/trigger/
> Trigger dbt Core Sync
```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"tags":[{"name":"Integrations","description":"External sources from which resources and metadata are extracted."}],"servers":[{"url":"https://api.secoda.co","description":"Base URL for all US cloud based workspaces"},{"url":"https://eapi.secoda.co","description":"Base URL for all EU cloud based workspaces"},{"url":"https://aapi.secoda.co","description":"Base URL for all APAC cloud based workspaces"},{"url":"https://{customer_domain}.secoda.co","description":"Base URL for On Premise Secoda workspaces","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"paths":{"/api/v1/integration/dbt/{integration_id}/trigger/":{"post":{"tags":["Integrations"],"summary":"Trigger dbt Core Sync","parameters":[{"in":"path","name":"integration_id","description":"The ID of the dbt Core integration","schema":{"title":"Integration Id","type":"string"},"required":true}],"responses":{"200":{"description":"Integration sync triggered successfully."},"409":{"description":"Integration sync already in progress."}}}}}}
```
## Get Entities With Failing Tests
> Get entities with tests that are failing or have a warning.
```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"tags":[{"name":"Integrations","description":"External sources from which resources and metadata are extracted."}],"servers":[{"url":"https://api.secoda.co","description":"Base URL for all US cloud based workspaces"},{"url":"https://eapi.secoda.co","description":"Base URL for all EU cloud based workspaces"},{"url":"https://aapi.secoda.co","description":"Base URL for all APAC cloud based workspaces"},{"url":"https://{customer_domain}.secoda.co","description":"Base URL for On Premise Secoda workspaces","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"paths":{"/api/v1/integration/dbt/{integration_id}/failing_tests/":{"get":{"operationId":"api_get_failing_tests","summary":"Get Entities With Failing Tests","parameters":[{"in":"path","name":"integration_id","schema":{"title":"Integration Id","type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1_DBTTestResultsOut"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"Response","type":"string"}}}}},"description":"Get entities with tests that are failing or have a warning.","tags":["Integrations"]}}},"components":{"schemas":{"v1_DBTTestResultsOut":{"properties":{"warning":{"items":{"type":"string"},"title":"Warning","type":"array"},"failing":{"items":{"type":"string"},"title":"Failing","type":"array"}},"required":["warning","failing"],"title":"DBTTestResultsOut","type":"object"}}}}
```
## List Slack Conversations or Channels
> Use this endpoint to list all available Slack conversations or channels.
```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"tags":[{"name":"Integrations","description":"External sources from which resources and metadata are extracted."}],"servers":[{"url":"https://api.secoda.co","description":"Base URL for all US cloud based workspaces"},{"url":"https://eapi.secoda.co","description":"Base URL for all EU cloud based workspaces"},{"url":"https://aapi.secoda.co","description":"Base URL for all APAC cloud based workspaces"},{"url":"https://{customer_domain}.secoda.co","description":"Base URL for On Premise Secoda workspaces","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"paths":{"/api/v2/integration_v2/slack/conversations/list/":{"get":{"operationId":"get_slack_conversations_list","summary":"List Slack Conversations or Channels","parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/v2_SlackConverstationOut"},"title":"Response","type":"array"}}}}},"description":"Use this endpoint to list all available Slack conversations or channels.","tags":["Integrations"]}}},"components":{"schemas":{"v2_SlackConverstationOut":{"properties":{"id":{"title":"Id","type":"string"},"name":{"title":"Name","type":"string"}},"required":["id","name"],"title":"SlackConverstationOut","type":"object"}}}}
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.secoda.co/api/reference/integrations.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.