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

# Get by Name

> Get the specified Vercel Sync by name and project ID.



## OpenAPI

````yaml GET /api/v1/secret-syncs/vercel/sync-name/{syncName}
openapi: 3.0.3
info:
  title: Infisical API
  description: List of all available APIs that can be consumed
  version: 0.0.1
servers:
  - url: https://us.infisical.com
    description: Production server (US)
  - url: https://eu.infisical.com
    description: Production server (EU)
  - url: http://localhost:8080
    description: Local server
security: []
paths:
  /api/v1/secret-syncs/vercel/sync-name/{syncName}:
    get:
      tags:
        - Secret Syncs
      description: Get the specified Vercel Sync by name and project ID.
      operationId: getVercelSecretSyncByName
      parameters:
        - schema:
            type: string
            minLength: 1
          in: query
          name: projectId
          required: true
          description: The ID of the project the Vercel Sync is associated with.
        - schema:
            type: string
            minLength: 1
          in: path
          name: syncName
          required: true
          description: The name of the Vercel Sync to retrieve.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  secretSync:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      name:
                        type: string
                      description:
                        type: string
                        nullable: true
                      isAutoSyncEnabled:
                        type: boolean
                        default: true
                      version:
                        type: number
                        default: 1
                      projectId:
                        type: string
                      folderId:
                        type: string
                        format: uuid
                        nullable: true
                      connectionId:
                        type: string
                        format: uuid
                      createdAt:
                        type: string
                        format: date-time
                      updatedAt:
                        type: string
                        format: date-time
                      syncStatus:
                        type: string
                        nullable: true
                      lastSyncJobId:
                        type: string
                        nullable: true
                      lastSyncMessage:
                        type: string
                        nullable: true
                      lastSyncedAt:
                        type: string
                        format: date-time
                        nullable: true
                      importStatus:
                        type: string
                        nullable: true
                      lastImportJobId:
                        type: string
                        nullable: true
                      lastImportMessage:
                        type: string
                        nullable: true
                      lastImportedAt:
                        type: string
                        format: date-time
                        nullable: true
                      removeStatus:
                        type: string
                        nullable: true
                      lastRemoveJobId:
                        type: string
                        nullable: true
                      lastRemoveMessage:
                        type: string
                        nullable: true
                      lastRemovedAt:
                        type: string
                        format: date-time
                        nullable: true
                      syncOptions:
                        type: object
                        properties:
                          initialSyncBehavior:
                            type: string
                            enum:
                              - overwrite-destination
                              - import-prioritize-source
                              - import-prioritize-destination
                            description: >-
                              Specify how Infisical should resolve the initial
                              sync to the Vercel destination.
                          keySchema:
                            type: string
                            description: >-
                              Specify the format to use for structuring secret
                              keys in the Vercel destination.
                          disableSecretDeletion:
                            type: boolean
                            description: >-
                              Enable this flag to prevent removal of secrets
                              from the Vercel destination when syncing.
                        required:
                          - initialSyncBehavior
                        additionalProperties: false
                        description: Optional parameters to modify how secrets are synced.
                      connection:
                        type: object
                        properties:
                          app:
                            type: string
                            enum:
                              - vercel
                          name:
                            type: string
                          id:
                            type: string
                            format: uuid
                        required:
                          - app
                          - name
                          - id
                        additionalProperties: false
                      environment:
                        type: object
                        properties:
                          slug:
                            type: string
                          name:
                            type: string
                          id:
                            type: string
                            format: uuid
                        required:
                          - slug
                          - name
                          - id
                        additionalProperties: false
                        nullable: true
                      folder:
                        type: object
                        properties:
                          id:
                            type: string
                          path:
                            type: string
                        required:
                          - id
                          - path
                        additionalProperties: false
                        nullable: true
                      destination:
                        type: string
                        enum:
                          - vercel
                      destinationConfig:
                        anyOf:
                          - type: object
                            properties:
                              scope:
                                type: string
                                enum:
                                  - project
                              app:
                                type: string
                                minLength: 1
                                description: The ID of the Vercel app to sync secrets to.
                              appName:
                                type: string
                                minLength: 1
                                description: The name of the Vercel app to sync secrets to.
                              env:
                                anyOf:
                                  - type: string
                                    enum:
                                      - development
                                      - preview
                                      - production
                                  - type: string
                                description: >-
                                  The ID of the Vercel environment to sync
                                  secrets to.
                              branch:
                                type: string
                                description: The branch to sync preview secrets to.
                              teamId:
                                type: string
                                description: The ID of the Vercel team to sync secrets to.
                              sensitive:
                                type: boolean
                                default: false
                                description: >-
                                  Whether to create Vercel environment variables
                                  as Sensitive (cannot be read back). Not
                                  allowed when targeting the Development
                                  environment.
                            required:
                              - scope
                              - app
                              - appName
                              - env
                              - teamId
                            additionalProperties: false
                          - type: object
                            properties:
                              scope:
                                type: string
                                enum:
                                  - team
                              teamId:
                                type: string
                                minLength: 1
                                description: The ID of the Vercel team to sync secrets to.
                              teamName:
                                type: string
                                description: >-
                                  The name of the team to sync the secrets to.
                                  This is an optional field only intended for
                                  display purposes.
                              targetEnvironments:
                                type: array
                                items:
                                  type: string
                                  enum:
                                    - development
                                    - preview
                                    - production
                                default: []
                                description: >-
                                  An optional array of Vercel default
                                  environments (development, preview,
                                  production) to add shared environment
                                  variables to.
                              applyToAllCustomEnvironments:
                                type: boolean
                                default: false
                                description: >-
                                  Whether to apply shared environment variables
                                  to all custom environments in the team.
                              targetProjects:
                                type: array
                                items:
                                  type: string
                                description: >-
                                  An optional array of Vercel projects to add
                                  shared environment variables to.
                              sensitive:
                                type: boolean
                                default: false
                                description: >-
                                  Whether to create Vercel environment variables
                                  as Sensitive (cannot be read back). Not
                                  allowed when targeting the Development
                                  environment.
                            required:
                              - scope
                              - teamId
                            additionalProperties: false
                    required:
                      - id
                      - name
                      - projectId
                      - connectionId
                      - createdAt
                      - updatedAt
                      - syncOptions
                      - connection
                      - environment
                      - folder
                      - destination
                      - destinationConfig
                    additionalProperties: false
                    title: Vercel
                required:
                  - secretSync
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                      - 400
                  message:
                    type: string
                  error:
                    type: string
                  details: {}
                required:
                  - reqId
                  - statusCode
                  - message
                  - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                      - 401
                  message:
                    type: string
                  error:
                    type: string
                required:
                  - reqId
                  - statusCode
                  - message
                  - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                      - 403
                  message:
                    type: string
                  details: {}
                  error:
                    type: string
                required:
                  - reqId
                  - statusCode
                  - message
                  - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                      - 404
                  message:
                    type: string
                  error:
                    type: string
                required:
                  - reqId
                  - statusCode
                  - message
                  - error
                additionalProperties: false
        '422':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                      - 422
                  message: {}
                  error:
                    type: string
                required:
                  - reqId
                  - statusCode
                  - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reqId:
                    type: string
                  statusCode:
                    type: number
                    enum:
                      - 500
                  message:
                    type: string
                  error:
                    type: string
                required:
                  - reqId
                  - statusCode
                  - message
                  - error
                additionalProperties: false

````