mammoth-io Connectors API

openapi: 3.2.0
info:
  title: Mammoth Io Connectors API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Connectors across 2 of this provider''s published API definitions: app.mammoth.io-openapi.json, mammoth-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v2
security:
- bearerAuth: []
- apiKey: []
  apiSecret: []
  workspaceId: []
tags:
- name: Connectors
paths:
  /subscription/connectors:
    get:
      tags:
      - Connectors
      summary: List all connectors
      operationId: ListSubscriptionConnectors
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorListResponseSchema'
      deprecated: false
    post:
      tags:
      - Connectors
      summary: Create a new connector
      operationId: CreateConnector
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectorRequestSchema'
        required: true
      responses:
        '201':
          description: Document created, URL follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorResponseSchema'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Validation Exception
                examples:
                - status_code: 400
                  detail: Bad Request
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
  /subscription/connectors/{connector_id}:
    put:
      tags:
      - Connectors
      summary: Update a connector
      operationId: UpdateConnector
      parameters:
      - name: connector_id
        in: path
        schema:
          type: integer
        required: true
        deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConnectorRequestSchema'
        required: true
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorResponseSchema'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Validation Exception
                examples:
                - status_code: 400
                  detail: Bad Request
                  extra: {}
      deprecated: false
    delete:
      tags:
      - Connectors
      summary: Delete a connector
      operationId: DeleteConnector
      parameters:
      - name: connector_id
        in: path
        schema:
          type: integer
        required: true
        deprecated: false
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponseSchema'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Validation Exception
                examples:
                - status_code: 400
                  detail: Bad Request
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
  /workspaces/{workspace_id}/connectors/{connector_key}:
    get:
      tags:
      - Connectors
      summary: Get connector details
      description: Get the details of an connector
      operationId: GetConnector
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: connector_key
        in: path
        schema:
          type: string
          title: Encoded Connector key
          description: Encoded key of the Connector to work with
          examples:
          - cG9zdGdyZXM=
        description: Encoded key of the Connector to work with
        required: true
        deprecated: false
        examples:
          connector_key-example-1:
            summary: Sample Connector key
            value: cG9zdGdyZXM=
      - name: fields
        in: query
        schema:
          type: string
          title: Fields
          description: Fields to be returned in a comma-separated format
          default: __standard
          examples:
          - name_key,api_type
          - __full
          - __standard
          - __min
        description: Fields to be returned in a comma-separated format
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          fields-example-1:
            summary: Return only name_key and api_type of a Connector
            value: name_key,api_type
          fields-example-2:
            summary: Return full representation of Connectors. Full representation includes name_key,disp_name,api_type,is_premium,is_added,spec,version_key,supported_version,vendor,connection_count
            value: __full
          fields-example-3:
            summary: Return standard representation of Connectors. Standard representation includes name_key,disp_name,api_type,is_premium,is_added,spec
            value: __standard
          fields-example-4:
            summary: Return minimal representation of Connectors. Minimal representation includes name_key,disp_name,api_type
            value: __min
      - name: is_export
        in: query
        schema:
          type: boolean
          default: false
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
      responses:
        '200':
          description: Get details of an connector
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorsSchema'
        '400':
          description: Bad Request
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
  /workspaces/{workspace_id}/connectors:
    get:
      tags:
      - Connectors
      summary: List connectors
      description: List the connectors that are provided by the system
      operationId: ListWorkspaceConnectors
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: limit
        in: query
        schema:
          type: integer
          maximum: 100.0
          minimum: 0.0
          title: Limit
          description: Max number of result to return
          default: 50
          examples:
          - 10
        description: Max number of result to return
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          limit-example-1:
            summary: Limit returned result count to 10
            value: 10
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0.0
          title: Offset
          description: Distance from the beginning of the list of results
          default: 0
          examples:
          - 10
        description: Distance from the beginning of the list of results
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          offset-example-1:
            summary: Start from 10th result
            value: 10
      - name: fields
        in: query
        schema:
          type: string
          title: Fields
          description: Fields to be returned in a comma-separated format
          default: __standard
          examples:
          - name_key,api_type
          - __full
          - __standard
          - __min
        description: Fields to be returned in a comma-separated format
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          fields-example-1:
            summary: Return only name_key and api_type of a Connector
            value: name_key,api_type
          fields-example-2:
            summary: Return full representation of Connectors. Full representation includes name_key,disp_name,api_type,is_premium,is_added,spec,version_key,supported_version,vendor,connection_count
            value: __full
          fields-example-3:
            summary: Return standard representation of Connectors. Standard representation includes name_key,disp_name,api_type,is_premium,is_added,spec
            value: __standard
          fields-example-4:
            summary: Return minimal representation of Connectors. Minimal representation includes name_key,disp_name,api_type
            value: __min
      - name: sort
        in: query
        schema:
          type: string
          title: Order by column names
          description: Returned connectors based on this parameter Use the format '(field:asc)' for ascending and  '(field:desc)' for descending order.
          default: (name_key:asc)
          examples:
          - (name_key:asc),(disp_name:desc)
        description: Returned connectors based on this parameter Use the format '(field:asc)' for ascending and  '(field:desc)' for descending order.
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          sort-example-1:
            summary: Order by connectors.name in ascending order and Connector.disp_name in descending order
            value: (name_key:asc),(disp_name:desc)
      - name: name_key
        in: query
        schema:
          type: string
          title: Get connectors by name
          description: Fetch Connector which matches given name (case sensitive)
          default: ''
          examples:
          - My Connector
        description: Fetch Connector which matches given name (case sensitive)
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          name_key-example-1:
            summary: return resources which matches given name
            value: My Connector
      - name: is_premium
        in: query
        schema:
          oneOf:
          - type: boolean
          - type: 'null'
          title: Get Connectors by premium status
          description: Fetch all Connectors based on premium status
          examples:
          - true
        description: Fetch all Connectors based on premium status
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          is_premium-example-1:
            summary: return resources which matches given condition
            value: true
      - name: is_added
        in: query
        schema:
          oneOf:
          - type: boolean
          - type: 'null'
          title: Get Connectors by added status
          description: Fetch all Connectors based on added status
          examples:
          - true
        description: Fetch all Connectors based on added status
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          is_added-example-1:
            summary: return resources which matches given condition
            value: true
      - name: has_connections
        in: query
        schema:
          oneOf:
          - type: boolean
          - type: 'null'
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
      - name: project_id
        in: query
        schema:
          oneOf:
          - type: integer
          - type: 'null'
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
      responses:
        '200':
          description: List of Connectors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorList'
        '400':
          description: Bad Request
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    ConnectorListResponseSchema:
      properties:
        connectors:
          items:
            $ref: '#/components/schemas/ConnectorSchema'
          type: array
      type: object
      required:
      - connectors
      title: ConnectorListResponseSchema
    ConnectorsSchema:
      properties:
        disp_name:
          oneOf:
          - type: string
          - type: 'null'
          title: Connector Name
          description: Name of the connector
          examples:
          - summary: Sample Connector Name
            value: Postgres SQL
        name_key:
          oneOf:
          - type: string
          - type: 'null'
          title: Connector Key
          description: Key of the connector
          examples:
          - summary: Sample Connector Key
            value: postgres
        api_type:
          oneOf:
          - type: string
          - type: 'null'
          title: API Type
          description: Type of the API
          examples:
          - summary: Sample Connector Type
            value: DB
        is_premium:
          oneOf:
          - type: boolean
          - type: 'null'
          title: Is Premium
          description: Whether the Connector is premium or not
          examples:
          - value: true
          - value: false
        is_added:
          oneOf:
          - type: boolean
          - type: 'null'
          title: Is Added
          description: Whether the Connector is added to the workspace or not
          examples:
          - value: true
          - value: false
        is_available:
          oneOf:
          - type: boolean
          - type: 'null'
          title: Is Available
          description: Whether the workspace's plan lets it create a connection of this connector
          examples:
          - value: true
          - value: false
        spec:
          oneOf:
          - $ref: '#/components/schemas/SpecSchema'
          - type: 'null'
        version_key:
          oneOf:
          - type: string
          - type: 'null'
          title: Version Key
          description: Key of the version
          examples:
          - summary: Sample Version Key
            value: '1.0'
        supported_version:
          oneOf:
          - type: string
          - type: 'null'
          title: Supported Version
          description: Supported version of the connector
          examples:
          - summary: Sample Supported Version
            value: '1.0'
        vendor:
          oneOf:
          - type: string
          - type: 'null'
          title: Vendor
          description: Vendor of the connector
          examples:
          - summary: Sample Vendor
            value: Google
      type: object
      required: []
      title: ConnectorsSchema
    ConnectorResponseSchema:
      properties:
        connector:
          $ref: '#/components/schemas/ConnectorSchema'
        message:
          type: string
      type: object
      required:
      - connector
      - message
      title: ConnectorResponseSchema
    ConnectorSchema:
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          oneOf:
          - type: string
          - type: 'null'
        price_per_month:
          oneOf:
          - type: number
          - type: 'null'
        enabled:
          type: boolean
        bucket:
          oneOf:
          - type: string
          - type: 'null'
          description: 'file | database | app | custom — the access model (admin-v2.1 D6): a plan''s connectorAccess level reaches connectors by bucket'
        created_at:
          oneOf:
          - type: string
          - type: 'null'
        updated_at:
          oneOf:
          - type: string
          - type: 'null'
        used_in_profiles:
          oneOf:
          - items:
              type: string
            type: array
            default: []
          - type: 'null'
          default: []
        profile_count:
          oneOf:
          - type: integer
            default: 0
          - type: 'null'
          default: 0
      type: object
      required:
      - enabled
      - id
      - name
      title: ConnectorSchema
    SpecSchema:
      properties:
        auth_url:
          oneOf:
          - type: string
          - type: 'null'
          title: Auth URL
          description: URL for authentication
          examples:
          - summary: Sample Auth URL
            value: https://accounts.google.com/o/oauth2?response_type=code&client_id=1234567890&redirect_uri=https://omail.com&scope=omail
        scope:
          oneOf:
          - type: string
          - type: 'null'
          title: Scope
          description: List of scopes as string
          examples:
          - summary: Sample Scopes
            value:
            - AllSites.Manage offline_access
        connection_config:
          oneOf:
          - type: object
          - type: 'null'
          title: Connection config schema
          description: JSON schema of the connection config (REST API connector)
        connection_input_note:
          oneOf:
          - type: string
          - type: 'null'
          title: Connection input note
          description: How to send the connection config (REST API connector)
        data_source_config:
          oneOf:
          - type: object
          - type: 'null'
          title: Data source config schema
          description: JSON schema of the data source config (REST API connector)
      type: object
      required: []
      title: SpecSchema
    MessageResponseSchema:
      properties:
        message:
          type: string
      type: object
      required:
      - message
      title: MessageResponseSchema
    UpdateConnectorRequestSchema:
      properties:
        name:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 128
          minLength: 2
          description: Connector name
        description:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 500
          description: Connector description
        enabled:
          oneOf:
          - type: boolean
          - type: 'null'
          description: Whether connector is enabled
        bucket:
          oneOf:
          - type: string
          - type: 'null'
          description: file | database | app — the website's access model. Orthogonal to the basic/premium API profile the product still enforces
        rollout_default:
          oneOf:
          - type: string
          - type: 'null'
          description: 'How a catalog change reaches live deals that do not state this item: retroactive = follows the base plan; opt_in = the deal keeps its old value until opted in'
      type: object
      required: []
      title: UpdateConnectorRequestSchema
    CreateConnectorRequestSchema:
      properties:
        name:
          type: string
          maxLength: 128
          minLength: 2
          description: Connector name
        description:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 500
          description: Connector description
        enabled:
          type: boolean
          description: Whether connector is enabled
          default: true
        bucket:
          oneOf:
          - type: string
          - type: 'null'
          description: file | database | app — the website's access model. Orthogonal to the basic/premium API profile the product still enforces
        rollout_default:
          oneOf:
          - type: string
          - type: 'null'
          description: 'How a catalog change reaches live deals that do not state this item: retroactive = follows the base plan; opt_in = the deal keeps its old value until opted in'
      type: object
      required:
      - name
      title: CreateConnectorRequestSchema
    ConnectorList:
      properties:
        connectors:
          items:
            type: object
          type: array
        limit:
          type: integer
          default: 10
        offset:
          type: integer
          default: 0
        next:
          type: string
      type: object
      required:
      - connectors
      - next
      title: ConnectorList
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Primary credential. Authorization: Bearer mm_<token>. The token is issued server-side and shown once at creation.'
      scheme: bearer
    apiKey:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-KEY
      in: header
    apiSecret:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-SECRET
      in: header
    workspaceId:
      type: apiKey
      description: Required with X-API-KEY and X-API-SECRET. Deprecated with them — use bearerAuth.
      name: X-WORKSPACE-ID
      in: header
x-refined-from:
- app.mammoth.io-openapi.json
- mammoth-io-openapi.json