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

# Get integration definition

> No description available



## OpenAPI

````yaml openapi_v3.yaml get /integrations/integrations/v1/definition/{id}
openapi: 3.0.0
info:
  title: ''
  version: 1.0.0
servers:
  - url: https://api.coralogix.com/mgmt/openapi/3
  - url: https://api.eu2.coralogix.com/mgmt/openapi/3
  - url: https://api.coralogix.us/mgmt/openapi/3
  - url: https://api.cx498.coralogix.com/mgmt/openapi/3
  - url: https://api.coralogix.in/mgmt/openapi/3
  - url: https://api.coralogixsg.com/mgmt/openapi/3
  - url: https://api.ap3.coralogix.com/mgmt/openapi/3
security:
  - apiKeyAuth: []
tags:
  - name: Alert definitions service
    description: >-
      View and manage your alerts using alert definitions - data structures that
      contain the configuration required to create an alert.
    externalDocs:
      description: Learn more about alerts in our documentation
      url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/
  - name: Metrics Data Archive Service
    description: View and manage your storage targets for metrics.
    externalDocs:
      description: Find out more about archives
      url: >-
        https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/
  - name: Connectors service
    description: >-
      View and manage your connectors - integration instances for notification
      destinations
    externalDocs:
      description: Lean more about connectors in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/connectors/introduction/
  - name: Cases service
    description: >-
      Manage cases throughout their lifecycle. Create, view, assign,
      acknowledge, resolve, and close cases to streamline investigations and
      follow-ups.
    externalDocs:
      description: Learn more about Cases in our documentation
      url: https://coralogix.com/docs/user-guides/cases/
  - name: SAML Configuration Service
    description: Manage your SAML configuration
    externalDocs:
      url: ''
  - name: Events2Metrics Service
    description: Manage your events2metrics.
    externalDocs:
      url: ''
  - name: Presets service
    description: >-
      View and manage your presets - pre-configured templates for notification
      content rendering
    externalDocs:
      description: Lean more about presets in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/presets/introduction/
  - name: Entities service
    description: Query information about registered entities in the notification center
    externalDocs:
      description: Lean more about the notification center in our documentation
      url: https://coralogix.com/docs/user-guides/notification-center/introduction/
  - name: API Keys Service
    description: Manage your API Keys.
    externalDocs:
      url: ''
  - name: Alert events service
    description: >-
      Get information regarding your alert events - instances of alerts being
      triggered.
    externalDocs:
      description: Learn more about alert events and incidents in our documentation.
      url: https://coralogix.com/docs/user-guides/alerting/incidents/
  - name: Scopes Service
    description: A service to manage scopes
    externalDocs:
      url: ''
  - name: IP access service
    description: >-
      IP access service provides the API for managing company IP access
      settings.
    externalDocs:
      url: ''
  - name: Dashboard service
    description: Get information about the Coralogix Dashboard catalog.
    externalDocs:
      url: ''
  - name: Events Service
    description: A service for querying events.
    externalDocs:
      description: Learn more about alerts in our documentation
      url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/
  - name: Team Permissions Management Service
    description: Manage Team Groups.
    externalDocs:
      url: ''
  - name: Extension service
    description: A service that enables querying for extension information.
    externalDocs:
      description: Learn more about extensions in our documentation.
      url: https://coralogix.com/docs/integrations/extensions/
  - name: Extension testing service
    externalDocs:
      description: Find out more about extensions in our documentation.
      url: https://coralogix.com/docs/integrations/extensions/
  - name: Data Usage Service
    description: A service to manage data usage metrics.
    externalDocs:
      url: ''
  - name: Target Service
    description: View and manage your storage targets for logs.
    externalDocs:
      description: Find out more about archives
      url: >-
        https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/
  - name: Contextual data integration service
    description: Query for contextual data integration information.
    externalDocs:
      url: ''
  - name: Custom Enrichments Service
    description: Manage your enrichments.
    externalDocs:
      url: ''
  - name: Global routers service
    description: >-
      View and manage your global routers - entities that direct notifications
      to configured destinations based on conditions
    externalDocs:
      description: Lean more about global routers in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/routing/introduction/
  - name: Recording Rules Service
    description: A service to manage recording rules.
    externalDocs:
      url: ''
  - name: Folders for views service
    description: Create and manage view folders.
    externalDocs:
      url: ''
  - name: Incidents service
    description: >-
      Handle all operations related to incident management within Coralogix.
      Identify, manage, and resolve incidents efficiently through automated
      workflows and team collaboration.
    externalDocs:
      description: Find out more about incident management in our documentation
      url: https://coralogix.com/docs/user-guides/alerting/incidents/
  - name: Retentions Service
    description: View and manage retentions
    externalDocs:
      url: ''
  - name: Extension deployment service
    description: A service that enables querying for extension deployment information.
    externalDocs:
      description: Find out more about extensions in our documentation.
      url: https://coralogix.com/docs/integrations/extensions/
  - name: Enrichments Service
    description: Manage your enrichments.
    externalDocs:
      url: ''
  - name: Role Management Service
    description: Service for managing system and custom roles.
    externalDocs:
      url: ''
  - name: Integration service
    description: A service that enables querying for integration information.
    externalDocs:
      description: Find out more about integrations in our documentation.
      url: https://coralogix.com/docs/integrations/getting-started/
  - name: Rule Groups Service
    description: A service to manage rule groups.
    externalDocs:
      url: ''
  - name: Policies Service
    description: View and manage your TCO policies
    externalDocs:
      url: ''
  - name: Alert Scheduler Rule service
    description: Manage your alert scheduler rules.
    externalDocs:
      url: ''
  - name: Dashboard folders service
    description: Manage your dashboard folders.
    externalDocs:
      url: ''
  - name: Actions Service
    description: A service for managing actions.
    externalDocs:
      url: ''
  - name: Slos Service
    description: A service for managing Service Level Objectives (SLOs).
    externalDocs:
      url: ''
  - name: Views service
    description: Create and manage views.
    externalDocs:
      url: ''
  - name: Outgoing webhooks service
    externalDocs:
      description: Find out more about outbound webhooks in our documentation.
      url: >-
        https://coralogix.com/docs/user-guides/alerting/outbound-webhooks/generic-outbound-webhooks-alert-webhooks/
  - name: SLO Service
    description: Manage your SLOs.
    externalDocs:
      url: ''
paths:
  /integrations/integrations/v1/definition/{id}:
    get:
      tags:
        - Integration service
      summary: Get integration definition
      description: No description available
      operationId: IntegrationService_GetIntegrationDefinition
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
            example: aws-sqs
        - in: query
          name: include_testing_revision
          required: false
          schema:
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIntegrationDefinitionResponse'
          description: ''
        '400':
          content:
            application/json: {}
          description: Bad Request
        '401':
          content:
            application/json: {}
          description: Unauthorized request
        '500':
          content:
            application/json: {}
          description: Internal server error
      externalDocs:
        url: ''
components:
  schemas:
    GetIntegrationDefinitionResponse:
      title: Get integration definition response
      type: object
      properties:
        integrationDefinition:
          $ref: '#/components/schemas/IntegrationDefinition'
      description: This data structure represents a list of outgoing webhook types.
      externalDocs:
        url: ''
    IntegrationDefinition:
      title: Integration definition
      type: object
      properties:
        featureFlag:
          type: string
        integrationType:
          $ref: '#/components/schemas/v1.IntegrationType'
        key:
          type: string
        revisions:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationRevision'
      description: This data structure represents a definition of an integration.
      externalDocs:
        url: ''
    v1.IntegrationType:
      oneOf:
        - $ref: '#/components/schemas/V1IntegrationTypeManaged'
        - $ref: '#/components/schemas/V1IntegrationTypeUntracked'
        - $ref: '#/components/schemas/V1IntegrationTypeCloudformation'
        - $ref: '#/components/schemas/V1IntegrationTypeArm'
        - $ref: '#/components/schemas/V1IntegrationTypePushBasedContextualData'
        - $ref: '#/components/schemas/V1IntegrationTypeContextualData'
        - $ref: '#/components/schemas/V1IntegrationTypeGenericWebhook'
    IntegrationRevision:
      oneOf:
        - $ref: '#/components/schemas/IntegrationRevisionTerraform'
        - $ref: '#/components/schemas/IntegrationRevisionCloudFormation'
        - $ref: '#/components/schemas/IntegrationRevisionManagedService'
        - $ref: '#/components/schemas/IntegrationRevisionHelmChart'
        - $ref: '#/components/schemas/IntegrationRevisionAzureArmTemplate'
        - $ref: '#/components/schemas/IntegrationRevisionRum'
    V1IntegrationTypeManaged:
      title: Integration type
      type: object
      properties:
        managed:
          $ref: '#/components/schemas/Managed'
      additionalProperties: false
      description: This data structure represents an integration type.
      externalDocs:
        url: ''
    V1IntegrationTypeUntracked:
      title: Integration type
      type: object
      properties:
        untracked:
          $ref: '#/components/schemas/Untracked'
      additionalProperties: false
      description: This data structure represents an integration type.
      externalDocs:
        url: ''
    V1IntegrationTypeCloudformation:
      title: Integration type
      type: object
      properties:
        cloudformation:
          $ref: '#/components/schemas/Cloudformation'
      additionalProperties: false
      description: This data structure represents an integration type.
      externalDocs:
        url: ''
    V1IntegrationTypeArm:
      title: Integration type
      type: object
      properties:
        arm:
          $ref: '#/components/schemas/AzureArm'
      additionalProperties: false
      description: This data structure represents an integration type.
      externalDocs:
        url: ''
    V1IntegrationTypePushBasedContextualData:
      title: Integration type
      type: object
      properties:
        pushBasedContextualData:
          $ref: '#/components/schemas/PushBasedContextualData'
      additionalProperties: false
      description: This data structure represents an integration type.
      externalDocs:
        url: ''
    V1IntegrationTypeContextualData:
      title: Integration type
      type: object
      properties:
        contextualData:
          $ref: '#/components/schemas/ContextualData'
      additionalProperties: false
      description: This data structure represents an integration type.
      externalDocs:
        url: ''
    V1IntegrationTypeGenericWebhook:
      title: Integration type
      type: object
      properties:
        genericWebhook:
          $ref: '#/components/schemas/GenericWebhook'
      additionalProperties: false
      description: This data structure represents an integration type.
      externalDocs:
        url: ''
    IntegrationRevisionTerraform:
      title: Integration revision
      type: object
      properties:
        featureFlag:
          type: string
        fields:
          type: array
          items:
            $ref: '#/components/schemas/FieldInformation'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationRevision.Group'
        id:
          type: string
        revisionDeploymentSupported:
          type: boolean
        terraform:
          $ref: '#/components/schemas/Terraform'
        upgradeInstructionsMd:
          type: string
      additionalProperties: false
      description: This data structure represents an integration revision.
      externalDocs:
        url: ''
    IntegrationRevisionCloudFormation:
      title: Integration revision
      type: object
      properties:
        cloudFormation:
          $ref: '#/components/schemas/CloudFormationTemplate'
        featureFlag:
          type: string
        fields:
          type: array
          items:
            $ref: '#/components/schemas/FieldInformation'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationRevision.Group'
        id:
          type: string
        revisionDeploymentSupported:
          type: boolean
        upgradeInstructionsMd:
          type: string
      additionalProperties: false
      description: This data structure represents an integration revision.
      externalDocs:
        url: ''
    IntegrationRevisionManagedService:
      title: Integration revision
      type: object
      properties:
        featureFlag:
          type: string
        fields:
          type: array
          items:
            $ref: '#/components/schemas/FieldInformation'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationRevision.Group'
        id:
          type: string
        managedService:
          $ref: '#/components/schemas/ManagedService'
        revisionDeploymentSupported:
          type: boolean
        upgradeInstructionsMd:
          type: string
      additionalProperties: false
      description: This data structure represents an integration revision.
      externalDocs:
        url: ''
    IntegrationRevisionHelmChart:
      title: Integration revision
      type: object
      properties:
        featureFlag:
          type: string
        fields:
          type: array
          items:
            $ref: '#/components/schemas/FieldInformation'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationRevision.Group'
        helmChart:
          $ref: '#/components/schemas/HelmChart'
        id:
          type: string
        revisionDeploymentSupported:
          type: boolean
        upgradeInstructionsMd:
          type: string
      additionalProperties: false
      description: This data structure represents an integration revision.
      externalDocs:
        url: ''
    IntegrationRevisionAzureArmTemplate:
      title: Integration revision
      type: object
      properties:
        azureArmTemplate:
          $ref: '#/components/schemas/AzureArmTemplate'
        featureFlag:
          type: string
        fields:
          type: array
          items:
            $ref: '#/components/schemas/FieldInformation'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationRevision.Group'
        id:
          type: string
        revisionDeploymentSupported:
          type: boolean
        upgradeInstructionsMd:
          type: string
      additionalProperties: false
      description: This data structure represents an integration revision.
      externalDocs:
        url: ''
    IntegrationRevisionRum:
      title: Integration revision
      type: object
      properties:
        featureFlag:
          type: string
        fields:
          type: array
          items:
            $ref: '#/components/schemas/FieldInformation'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationRevision.Group'
        id:
          type: string
        revisionDeploymentSupported:
          type: boolean
        rum:
          $ref: '#/components/schemas/Rum'
        upgradeInstructionsMd:
          type: string
      additionalProperties: false
      description: This data structure represents an integration revision.
      externalDocs:
        url: ''
    Managed:
      title: Managed
      type: object
      properties:
        variant:
          $ref: '#/components/schemas/Variant'
      description: This data structure represents a managed integration.
      externalDocs:
        url: ''
    Untracked:
      title: Untracked
      type: object
      description: This data structure represents an untracked integration.
      externalDocs:
        url: ''
    Cloudformation:
      title: CloudFormation
      type: object
      description: This data structure represents a CloudFormation integration.
      externalDocs:
        url: ''
    AzureArm:
      title: Azure ARM
      type: object
      description: This data structure represents an Azure ARM integration.
      externalDocs:
        url: ''
    PushBasedContextualData:
      title: Push based contextual data
      type: object
      description: This data structure represents a push based contextual data integration.
      externalDocs:
        url: ''
    ContextualData:
      title: Contextual data
      type: object
      description: This data structure represents a contextual data integration.
      externalDocs:
        url: ''
    GenericWebhook:
      title: Generic webhook
      type: object
      description: This data structure represents a generic webhook integration.
      externalDocs:
        url: ''
    FieldInformation:
      oneOf:
        - $ref: '#/components/schemas/FieldInformationSingle'
        - $ref: '#/components/schemas/FieldInformationMultiText'
        - $ref: '#/components/schemas/FieldInformationMultipleSelection'
        - $ref: '#/components/schemas/FieldInformationSingleBoolean'
        - $ref: '#/components/schemas/FieldInformationSelection'
        - $ref: '#/components/schemas/FieldInformationSingleNumber'
    IntegrationRevision.Group:
      title: Group
      type: object
      properties:
        id:
          type: string
        name:
          type: string
      externalDocs:
        url: ''
    Terraform:
      title: Terraform
      type: object
      properties:
        configurationBlocks:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurationBlock'
      description: This data structure represents a Terraform integration.
      externalDocs:
        url: ''
    CloudFormationTemplate:
      title: CloudFormation template
      type: object
      properties:
        commands:
          type: array
          items:
            $ref: '#/components/schemas/CommandInformation'
        parameters:
          type: object
          additionalProperties:
            type: string
        postInstallationSteps:
          type: object
          additionalProperties:
            type: string
        templateUrl:
          type: string
      externalDocs:
        url: ''
    ManagedService:
      title: Managed service
      type: object
      description: This data structure represents a managed service.
      externalDocs:
        url: ''
    HelmChart:
      title: Helm chart
      type: object
      properties:
        commands:
          type: array
          items:
            $ref: '#/components/schemas/CommandInformation'
        guide:
          $ref: '#/components/schemas/IntegrationGuide'
        template:
          type: string
      description: This data structure represents a Helm chart.
      externalDocs:
        url: ''
    AzureArmTemplate:
      title: Azure ARM template
      type: object
      properties:
        templateUrl:
          type: string
      description: This data structure represents an azure ARM template.
      externalDocs:
        url: ''
    Rum:
      title: RUM
      type: object
      properties:
        browserSdkCommands:
          type: array
          items:
            $ref: '#/components/schemas/CommandInformation'
        sourceMapCommands:
          type: array
          items:
            $ref: '#/components/schemas/CommandInformation'
      description: This data structure represents a RUM integration.
      externalDocs:
        url: ''
    Variant:
      enum:
        - DEFAULT
        - GCP
        - OAUTH
        - CUSTOM
      type: string
    FieldInformationSingle:
      title: Field information
      type: object
      properties:
        allowedPattern:
          type: string
        applicableIf:
          $ref: '#/components/schemas/FieldCondition'
        documentationReference:
          type: string
        groupId:
          type: string
        name:
          type: string
        placeholder:
          type: string
        predefined:
          type: boolean
        readonly:
          type: boolean
        required:
          type: boolean
        single:
          $ref: '#/components/schemas/SingleValue'
        templateParamName:
          type: string
        tooltip:
          type: string
        type:
          $ref: '#/components/schemas/InputType'
        upgradeNotice:
          type: string
        visible:
          type: boolean
      additionalProperties: false
      externalDocs:
        url: ''
    FieldInformationMultiText:
      title: Field information
      type: object
      properties:
        allowedPattern:
          type: string
        applicableIf:
          $ref: '#/components/schemas/FieldCondition'
        documentationReference:
          type: string
        groupId:
          type: string
        multiText:
          $ref: '#/components/schemas/ListTextValue'
        name:
          type: string
        placeholder:
          type: string
        predefined:
          type: boolean
        readonly:
          type: boolean
        required:
          type: boolean
        templateParamName:
          type: string
        tooltip:
          type: string
        type:
          $ref: '#/components/schemas/InputType'
        upgradeNotice:
          type: string
        visible:
          type: boolean
      additionalProperties: false
      externalDocs:
        url: ''
    FieldInformationMultipleSelection:
      title: Field information
      type: object
      properties:
        allowedPattern:
          type: string
        applicableIf:
          $ref: '#/components/schemas/FieldCondition'
        documentationReference:
          type: string
        groupId:
          type: string
        multipleSelection:
          $ref: '#/components/schemas/MultipleSelectionValue'
        name:
          type: string
        placeholder:
          type: string
        predefined:
          type: boolean
        readonly:
          type: boolean
        required:
          type: boolean
        templateParamName:
          type: string
        tooltip:
          type: string
        type:
          $ref: '#/components/schemas/InputType'
        upgradeNotice:
          type: string
        visible:
          type: boolean
      additionalProperties: false
      externalDocs:
        url: ''
    FieldInformationSingleBoolean:
      title: Field information
      type: object
      properties:
        allowedPattern:
          type: string
        applicableIf:
          $ref: '#/components/schemas/FieldCondition'
        documentationReference:
          type: string
        groupId:
          type: string
        name:
          type: string
        placeholder:
          type: string
        predefined:
          type: boolean
        readonly:
          type: boolean
        required:
          type: boolean
        singleBoolean:
          $ref: '#/components/schemas/SingleBooleanValue'
        templateParamName:
          type: string
        tooltip:
          type: string
        type:
          $ref: '#/components/schemas/InputType'
        upgradeNotice:
          type: string
        visible:
          type: boolean
      additionalProperties: false
      externalDocs:
        url: ''
    FieldInformationSelection:
      title: Field information
      type: object
      properties:
        allowedPattern:
          type: string
        applicableIf:
          $ref: '#/components/schemas/FieldCondition'
        documentationReference:
          type: string
        groupId:
          type: string
        name:
          type: string
        placeholder:
          type: string
        predefined:
          type: boolean
        readonly:
          type: boolean
        required:
          type: boolean
        selection:
          $ref: '#/components/schemas/SelectionValue'
        templateParamName:
          type: string
        tooltip:
          type: string
        type:
          $ref: '#/components/schemas/InputType'
        upgradeNotice:
          type: string
        visible:
          type: boolean
      additionalProperties: false
      externalDocs:
        url: ''
    FieldInformationSingleNumber:
      title: Field information
      type: object
      properties:
        allowedPattern:
          type: string
        applicableIf:
          $ref: '#/components/schemas/FieldCondition'
        documentationReference:
          type: string
        groupId:
          type: string
        name:
          type: string
        placeholder:
          type: string
        predefined:
          type: boolean
        readonly:
          type: boolean
        required:
          type: boolean
        singleNumber:
          $ref: '#/components/schemas/IntegrationRevision.SingleNumericValue'
        templateParamName:
          type: string
        tooltip:
          type: string
        type:
          $ref: '#/components/schemas/InputType'
        upgradeNotice:
          type: string
        visible:
          type: boolean
      additionalProperties: false
      externalDocs:
        url: ''
    ConfigurationBlock:
      title: Configuration block
      type: object
      properties:
        description:
          type: string
        name:
          type: string
        value:
          type: string
      externalDocs:
        url: ''
    CommandInformation:
      title: Command information
      type: object
      properties:
        command:
          type: string
        description:
          type: string
        language:
          $ref: '#/components/schemas/Language'
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
        name:
          type: string
        tooltipText:
          type: string
      externalDocs:
        url: ''
    IntegrationGuide:
      title: Integration guide
      type: object
      properties:
        installationRequirements:
          type: string
        introduction:
          type: string
      externalDocs:
        url: ''
    FieldCondition:
      title: Field condition
      type: object
      properties:
        type:
          $ref: '#/components/schemas/FieldCondition.ConditionType'
        values:
          type: array
          items:
            $ref: '#/components/schemas/FieldCondition.FieldValue'
      externalDocs:
        url: ''
    SingleValue:
      title: Single value
      type: object
      properties:
        defaultValue:
          type: string
      externalDocs:
        url: ''
    InputType:
      enum:
        - API_KEY
        - TEXT
        - LIST_TEXT
        - MULTIPLE_SELECTION
        - BOOLEAN
        - SELECT
        - JSON
        - NUMBER
        - SENSITIVE_DATA
        - JSON_OBJECT_ARRAY
      type: string
    ListTextValue:
      title: List text value
      type: object
      properties:
        defaultValues:
          type: array
          items:
            type: string
        options:
          type: array
          items:
            type: string
      externalDocs:
        url: ''
    MultipleSelectionValue:
      title: Multiple selection value
      type: object
      properties:
        options:
          type: array
          items:
            type: string
      externalDocs:
        url: ''
    SingleBooleanValue:
      title: Single boolean value
      type: object
      properties:
        defaultValue:
          type: boolean
      externalDocs:
        url: ''
    SelectionValue:
      title: Selection value
      type: object
      properties:
        defaultValue:
          type: string
        options:
          type: array
          items:
            type: string
      externalDocs:
        url: ''
    IntegrationRevision.SingleNumericValue:
      title: Single numeric value
      type: object
      properties:
        defaultValue:
          type: number
          format: double
      externalDocs:
        url: ''
    Language:
      enum:
        - UNKNOWN
        - BASH
        - JAVASCRIPT
      type: string
    Link:
      title: Link
      type: object
      properties:
        key:
          type: string
        text:
          type: string
        url:
          type: string
      externalDocs:
        url: ''
    FieldCondition.ConditionType:
      enum:
        - UNKNOWN
        - OR
        - AND
      type: string
    FieldCondition.FieldValue:
      title: Field value
      type: object
      properties:
        fieldName:
          type: string
        valuePattern:
          type: string
      externalDocs:
        url: ''
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key authentication

````