> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wirespeed.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get integration configuration by type



## OpenAPI

````yaml https://api.wirespeed.co/v1/openapi.json get /v1/integration/config/{type}
openapi: 3.0.0
info:
  title: Wirespeed API
  description: The public Wirespeed API. v1 is the first stable contract.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.wirespeed.co
security: []
tags: []
paths:
  /v1/integration/config/{type}:
    get:
      tags:
        - Integration
      summary: Get integration configuration by type
      operationId: IntegrationController_getIntegrationConfigById
      parameters:
        - name: type
          required: true
          in: path
          description: Integration type
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationMetadataConfigV2'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpError'
components:
  schemas:
    IntegrationMetadataConfigV2:
      type: object
      properties:
        authType:
          type: string
          enum:
            - oauth2
            - api_token
            - basic
            - custom
            - none
            - multi
          description: >-
            Authentication type for the integration. Derived from authMethods:
            the single method type, or "multi" when more than one.
        authMethods:
          description: >-
            User-selectable authentication methods. When present, the user picks
            one at connect time.
          type: array
          items:
            $ref: '#/components/schemas/IntegrationMetadataConfigAuthMethodV2'
        name:
          type: string
          description: Display name of the integration
        oauthRequiresRedirect:
          type: boolean
          description: Whether OAuth flow requires a redirect
        customFields:
          description: Custom configuration fields for the integration
          type: array
          items:
            $ref: '#/components/schemas/IntegrationMetadataConfigCustomFieldV2'
        requiresConfiguration:
          type: boolean
          description: Whether the integration requires additional configuration
        requiresWebhook:
          type: boolean
          description: >-
            Whether the integration is webhook-only and requires the user to
            configure a webhook on the vendor side
        logo:
          type: string
          description: URL of the integration logo
        logoLight:
          type: string
          description: URL of the light theme logo
        logoDark:
          type: string
          description: URL of the dark theme logo
        beta:
          type: boolean
          description: Whether this integration is in beta
        description:
          type: string
          description: Description of the integration
        slug:
          type: string
          description: Unique slug identifier for the integration
        internalCreds:
          type: boolean
          description: Whether credentials are managed internally
        docsUrl:
          type: string
          description: URL to integration documentation
        statusUrl:
          type: string
          description: URL to provider status page
        default:
          type: boolean
          description: Whether this is a default integration
        rtfm:
          type: boolean
          description: >-
            Should the instructions be read before continuing with this
            integration?
        useCases:
          type: array
          description: Use cases for the integration
          items:
            type: string
            enum:
              - chat_ops
              - CHECK_ATTACK_SIMULATION
              - CHECK_BREACH
              - CHECK_PLANNED_CHANGE
              - contain_endpoint_isolate
              - contain_endpoint_lock
              - contain_user_disable
              - contain_user_reset_password
              - contain_user_revoke_sessions
              - contain_file_delete
              - contain_file_quarantine
              - CREATE_TICKET
              - ENRICH_FILE
              - ENRICH_IP
              - enrich_detection
              - ON_CONNECT
              - ON_ENABLE
              - ON_DISABLE
              - get_detections
              - get_endpoint
              - get_endpoints
              - get_logs
              - get_user
              - get_users
              - INTERNAL
              - INTERNAL_AUTH_CHECK
              - OTHER
              - LOG_PARSER
              - DETECTION_PARSER
              - SEND_MESSAGE
              - uncontain_endpoint_unisolate
              - uncontain_endpoint_unlock
              - uncontain_file_add_exclusion
              - uncontain_file_unquarantine
              - uncontain_user_enable
              - update_detection_source
              - UPDATE_TICKET
              - webhook
              - refresh_detection
              - get_rules
        integrationTypes:
          type: array
          description: Integration types for SKU enforcement
          items:
            type: string
            enum:
              - collaboration
              - endpoint
              - identity
              - network_vpn
              - cloud
              - siem
              - saas
              - attack_simulation
              - deception
              - enrichment
              - email
              - firewall
              - dns
              - custom
        actions:
          description: Public actions available for this integration
          type: array
          items:
            $ref: '#/components/schemas/IntegrationActionV2'
        webhookActions:
          description: Available actions for this integration
          type: array
          items:
            $ref: '#/components/schemas/IntegrationActionV2'
        containmentActions:
          description: Containment and uncontainment actions for this integration
          type: array
          items:
            $ref: '#/components/schemas/IntegrationActionV2'
        singleInstallOnly:
          type: boolean
          description: >-
            If true, only one instance of this integration can be installed per
            team
        hideFromCatalog:
          type: boolean
          description: If true, this integration should not be shown in the browse catalog
        comingSoon:
          type: boolean
          description: >-
            If true, this integration is shown as coming soon and cannot be
            connected yet
        syslogListenerTypes:
          type: array
          description: >-
            Syslog ingestion listener types supported when auto-deploy metadata
            is present
          items:
            type: string
            enum:
              - socket
              - http
              - https
      required:
        - authType
        - name
        - customFields
        - logo
        - beta
        - slug
        - default
        - useCases
        - webhookActions
        - containmentActions
    HttpError:
      type: object
      properties:
        message:
          type: string
        statusCode:
          type: number
      required:
        - message
        - statusCode
    IntegrationMetadataConfigAuthMethodV2:
      type: object
      properties:
        id:
          type: string
          description: >-
            Stable auth method identifier. Required when an integration has
            multiple auth methods.
        displayName:
          type: string
          description: >-
            Display name for the method. Required when an integration has
            multiple auth methods.
        description:
          type: string
          description: Helper text for the method
        authType:
          type: string
          enum:
            - oauth2
            - api_token
            - basic
            - custom
            - none
          description: Framework auth type this method maps to
      required:
        - authType
    IntegrationMetadataConfigCustomFieldV2:
      type: object
      properties:
        slug:
          type: string
          description: Unique identifier for the custom field
        display:
          type: string
          description: Display name for the field
        type:
          type: string
          description: Type of the custom field
        required:
          type: boolean
          description: Whether the field is required
        description:
          type: string
          description: Description of the field
        defaultValue:
          oneOf:
            - type: string
            - type: number
            - type: boolean
          description: Default value for the field
        validationPattern:
          type: string
          description: Validation pattern for the field
        validationMinLength:
          type: number
          description: Minimum length for field validation
        validationMaxLength:
          type: number
          description: Maximum length for field validation
        source:
          type: string
          description: Source configuration for the field
        advancedOption:
          type: boolean
          description: Whether the field is an advanced option
        hidden:
          type: boolean
          description: Whether the field should be hidden from the UI entirely
        nonEditable:
          type: boolean
          description: Whether the field is non-editable after the integration is created
        entitlementSlug:
          type: string
          description: >-
            Slug of the overridable entitlement this field controls. When set,
            the field value maps to the entitlement override (the effective
            value lives in publicEntitlements), not a stored custom field.
        authMethod:
          type: string
          description: >-
            Auth method id this field is scoped to. When set, the field only
            applies when that auth method is selected.
      required:
        - slug
        - display
        - type
        - required
    IntegrationActionV2:
      type: object
      properties:
        slug:
          type: string
          description: Unique slug identifier for the action
        display:
          type: string
          description: Display name for the action
        description:
          type: string
          description: Description of what this action does
        useCases:
          type: array
          description: Use cases for this action
          items:
            type: string
            enum:
              - chat_ops
              - CHECK_ATTACK_SIMULATION
              - CHECK_BREACH
              - CHECK_PLANNED_CHANGE
              - contain_endpoint_isolate
              - contain_endpoint_lock
              - contain_user_disable
              - contain_user_reset_password
              - contain_user_revoke_sessions
              - contain_file_delete
              - contain_file_quarantine
              - CREATE_TICKET
              - ENRICH_FILE
              - ENRICH_IP
              - enrich_detection
              - ON_CONNECT
              - ON_ENABLE
              - ON_DISABLE
              - get_detections
              - get_endpoint
              - get_endpoints
              - get_logs
              - get_user
              - get_users
              - INTERNAL
              - INTERNAL_AUTH_CHECK
              - OTHER
              - LOG_PARSER
              - DETECTION_PARSER
              - SEND_MESSAGE
              - uncontain_endpoint_unisolate
              - uncontain_endpoint_unlock
              - uncontain_file_add_exclusion
              - uncontain_file_unquarantine
              - uncontain_user_enable
              - update_detection_source
              - UPDATE_TICKET
              - webhook
              - refresh_detection
              - get_rules
        showWebhookSecret:
          type: boolean
          description: Whether the webhook secret should be shown in the UI
        containmentRequirements:
          type: object
          description: >-
            Asset field requirements that must be satisfied before this
            containment action can be attempted
          additionalProperties: true
      required:
        - slug
        - display
        - description
        - useCases

````