datamcp API

openapi: 3.1.0
info:
  title: datamcp API
  version: '2026-11-05'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-05: 5 operation(s) read from 1 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; datamcp has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 5
    pages-with-code: 0
    pages-read: 1
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-05'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://datamcp.app/docs/integration-api
servers:
- url: https://api.datamcp.app/api
paths:
  /integration-credentials:
    get:
      operationId: get_integration_credentials
      tags:
      - Integration Credentials
      summary: Credential management – lists key metadata
      x-source: https://datamcp.app/docs/integration-api
      parameters:
      - name: organizationId
        in: query
        required: true
        schema:
          type: string
        description: Organization UUID
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIntegrationCredentialsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_integration_credentials
      tags:
      - Integration Credentials
      summary: Credential management – creates a key
      x-source: https://datamcp.app/docs/integration-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostIntegrationCredentialsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostIntegrationCredentialsResponse'
      x-evidence:
        kind: documentation
  /integration-credentials/{credentialid}:
    delete:
      operationId: delete_integration_credentials_credentialid
      tags:
      - Integration Credentials
      summary: Credential management – revokes an active key
      x-source: https://datamcp.app/docs/integration-api
      parameters:
      - name: credentialid
        in: path
        required: true
        schema:
          type: string
      - name: organizationId
        in: query
        required: true
        schema:
          type: string
        description: Organization UUID
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteIntegrationCredentialsCredentialidResponse'
      x-evidence:
        kind: documentation
  /integrations/v1/sources:
    get:
      operationId: get_integrations_v1_sources
      tags:
      - Integrations
      summary: List accessible sources
      x-source: https://datamcp.app/docs/integration-api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIntegrationsV1SourcesResponse'
      x-evidence:
        kind: documentation
  /integrations/v1/sources/{sourceid}/query:
    post:
      operationId: post_integrations_v1_sources_sourceid_query
      tags:
      - Integrations
      summary: Read rows
      x-source: https://datamcp.app/docs/integration-api
      parameters:
      - name: sourceid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostIntegrationsV1SourcesSourceidQueryRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostIntegrationsV1SourcesSourceidQueryResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetIntegrationCredentialsResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates the request succeeded
        data:
          type: array
          description: Array of credential metadata objects (no secret or hash included)
    PostIntegrationCredentialsRequest:
      type: object
      properties:
        name:
          type: string
          description: Human‑readable name for the credential
        organizationId:
          type: string
          description: Organization UUID
        sourceIds:
          type: array
          description: List of source IDs (1–10) the credential may access
        operations:
          type: array
          description: Allowed operations (1–4) such as read_query, create_row, update_row, delete_row
        tableScopes:
          type: object
          description: Optional mapping of source IDs to allowed schema‑qualified tables
      required:
      - name
      - organizationId
      - sourceIds
      - operations
    PostIntegrationCredentialsResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates the request succeeded
        data:
          type: object
          description: Metadata about the created credential
        data.secret:
          type: string
          description: One‑time secret beginning with dm_int_ (shown only in this response)
    DeleteIntegrationCredentialsCredentialidResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates the request succeeded
        data:
          type: object
          description: Result of revocation (typically empty)
    GetIntegrationsV1SourcesResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates the request succeeded
        data:
          type: array
          description: Array of source objects
        data[].id:
          type: string
          description: Source identifier
        data[].name:
          type: string
          description: Human‑readable name of the source
        data[].type:
          type: string
          description: Source type (e.g., "database")
        data[].databaseType:
          type: string
          description: Database engine type (e.g., "postgresql")
        data[].routingType:
          type: string
          description: Routing method (e.g., "tunnel")
        data[].operations:
          type: array
          description: Operations allowed by the key
    PostIntegrationsV1SourcesSourceidQueryRequest:
      type: object
      properties:
        query:
          type: string
          description: Read‑only SQL statement
        parameters:
          type: array
          description: Bound parameters for the query (up to 50, each ≤ 4096 chars or a finite number, boolean, or null)
        maxRows:
          type: integer
          description: Maximum rows to return (default 100, 1‑100 inclusive)
      required:
      - query
    PostIntegrationsV1SourcesSourceidQueryResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates the request succeeded
        data:
          type: object
          description: Query result payload
        data.columns:
          type: array
          description: Column names returned by the query
        data.rows:
          type: array
          description: Array of row arrays matching the columns
        data.rowCount:
          type: integer
          description: Number of rows returned
        data.truncated:
          type: boolean
          description: True if the result was truncated due to limits
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      x-source: https://datamcp.app/blog/openapi-authentication-for-mcp
    ApiKeyAuthQuery:
      type: apiKey
      in: query
      name: api_key
      x-source: https://datamcp.app/blog/openapi-authentication-for-mcp
    ApiKeyAuthCookie:
      type: apiKey
      in: cookie
      name: session_key
      x-source: https://datamcp.app/blog/openapi-authentication-for-mcp
    BearerAuth:
      type: http
      scheme: bearer
      x-source: https://datamcp.app/blog/openapi-authentication-for-mcp
    BasicAuth:
      type: http
      scheme: basic
      x-source: https://datamcp.app/blog/openapi-authentication-for-mcp
tags:
- name: Integration Credentials
- name: Integrations
security:
- ApiKeyAuth: []
- ApiKeyAuthQuery: []
- ApiKeyAuthCookie: []
- BearerAuth: []
- BasicAuth: []