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

# Create or Replace Connection

> Creates the connection `name`, or replaces its settings.

Runs already in progress use the new settings on their next call.



## OpenAPI

````yaml /openapi.json put /v1/connections/{name}
openapi: 3.1.0
info:
  title: Sixtyfour API
  description: >-
    Intelligence API for people and companies: research agents that investigate,
    resolve identities, map relationships and surface risk signals.
  contact:
    name: Sixtyfour
    url: https://sixtyfour.ai/
    email: support@sixtyfour.ai
  license:
    name: Proprietary
  version: 1.0.0
servers:
  - url: https://api.sixtyfour.ai
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Enrichment
    description: Find and enrich emails, phones, and LinkedIn for people and companies.
  - name: Search
    description: Run deep and filter searches over Sixtyfour's data.
  - name: Workflow
    description: Create, run, and manage enrichment workflows.
  - name: Workflow Schedules
    description: Create and manage recurring schedules for workflows.
  - name: Account
    description: Manage and inspect your account and credit balance.
  - name: Feedback
    description: >-
      Tell us a result was wrong, missing or outdated, and report problems with
      the API, the docs or a tool.
  - name: Intelligence
    description: Verify identity attributes such as age using high-tier OSINT research.
  - name: Atlas
    description: >-
      Start, continue and read Atlas investigations: attribution graph,
      workspace files, reports and exports.
paths:
  /v1/connections/{name}:
    put:
      tags:
        - Connections
      summary: Create or Replace Connection
      description: |-
        Creates the connection `name`, or replaces its settings.

        Runs already in progress use the new settings on their next call.
      operationId: save_connection_v1_connections__name__put
      parameters:
        - name: name
          in: path
          required: true
          schema:
            type: string
            title: Name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveConnection'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/api__routers__v1_connections_api__SavedConnection
              example:
                name: crm
                description: 'Our CRM: accounts, contacts and deal notes'
                base_url: https://api.crm.example.com/v2
                sign_in:
                  type: bearer
                  name: null
                allowed_requests:
                  - POST /search
                secret_last4: _KEY
                created_at: '2026-11-05T03:40:00Z'
                updated_at: '2026-11-05T03:40:00Z'
                created: true
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicJobError'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicJobError'
          description: Unauthorized
        '402':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicJobError'
          description: Payment Required
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicJobError'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicJobError'
          description: Not Found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicJobError'
          description: Conflict
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicJobValidationError'
          description: Unprocessable Entity
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicJobError'
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicJobError'
          description: Internal Server Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicJobError'
          description: Service Unavailable
components:
  schemas:
    SaveConnection:
      properties:
        base_url:
          type: string
          maxLength: 2048
          title: Base Url
          description: >-
            HTTPS URL of the API. Agents can only call this URL and paths under
            it.
        secret:
          title: Secret
          description: >-
            API key, token or password for the API. Required to create a
            connection. Omit on a replace to keep the saved secret. Use a
            read-only credential where you can.
        description:
          anyOf:
            - type: string
              maxLength: 2000
            - type: 'null'
          title: Description
          description: One line telling agents what the connection is for.
        sign_in:
          anyOf:
            - $ref: '#/components/schemas/SignIn'
            - type: 'null'
          description: >-
            How the secret is sent. Default: a bearer token in the Authorization
            header.
        username:
          title: Username
          description: Username for a `basic` sign-in. The secret is sent as its password.
        allowed_requests:
          anyOf:
            - items:
                type: string
                maxLength: 2048
              type: array
              maxItems: 100
            - type: 'null'
          title: Allowed Requests
          description: >-
            Requests agents may make, each a method and a path under `base_url`,
            such as `POST /search`. Omit to allow GET and HEAD on any path.
        create_only:
          type: boolean
          title: Create Only
          description: >-
            If true, fails when a connection with this name already exists
            instead of replacing it. Default: false.
          default: false
      additionalProperties: false
      type: object
      required:
        - base_url
      title: SaveConnection
      examples:
        - allowed_requests:
            - GET /accounts
            - POST /accounts/search
          base_url: https://api.example.com/v2
          description: Our CRM. Look up accounts and their owners.
          secret: YOUR_CRM_API_KEY
    api__routers__v1_connections_api__SavedConnection:
      properties:
        name:
          type: string
          title: Name
          description: >-
            Connection name. Agents and runs refer to the connection by this
            name.
        description:
          type: string
          title: Description
          description: What the connection is for. Empty when none was given.
        base_url:
          type: string
          title: Base Url
          description: HTTPS URL of the API.
        sign_in:
          $ref: '#/components/schemas/SignIn'
          description: How the secret is sent.
        allowed_requests:
          anyOf:
            - items:
                type: string
                maxLength: 2048
              type: array
            - type: 'null'
          title: Allowed Requests
          description: >-
            Requests agents may make. Null means GET and HEAD on any path under
            `base_url`.
        secret_last4:
          type: string
          title: Secret Last4
          description: >-
            Last four characters of the secret. The secret itself is never
            returned.
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
          description: Creation time in UTC.
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
          description: Last update time in UTC.
        created:
          type: boolean
          title: Created
          description: >-
            If true, this request created the connection. If false, it replaced
            one.
      type: object
      required:
        - name
        - description
        - base_url
        - sign_in
        - allowed_requests
        - secret_last4
        - created
      title: SavedConnection
      examples:
        - allowed_requests:
            - GET /accounts
            - POST /accounts/search
          base_url: https://api.example.com/v2
          created: true
          created_at: '2026-01-05T17:00:00Z'
          description: Our CRM. Look up accounts and their owners.
          name: crm
          secret_last4: 9f2c
          sign_in:
            type: bearer
          updated_at: '2026-01-05T17:00:00Z'
    PublicJobError:
      properties:
        detail:
          type: string
          title: Detail
          description: Human-readable explanation of why the request failed.
        error_code:
          $ref: '#/components/schemas/V1ErrorCode'
          description: >-
            Stable error code for handling the failure in code. Do not branch on
            the wording of `detail`.
        request_id:
          type: string
          title: Request Id
          description: >-
            Request identifier, equal to the X-Request-Id response header. Quote
            this value when contacting support.
        retryable:
          type: boolean
          title: Retryable
          description: >-
            If true, retrying the request can succeed without changing its
            inputs; respect Retry-After when present. If false, correct the
            request or resolve the reported condition before retrying.
        param:
          anyOf:
            - type: string
            - type: 'null'
          title: Param
          description: >-
            Dot-separated path to the parameter that caused the error, such as
            `body.lead` or `header.Idempotency-Key`. Null when the error is not
            tied to a parameter.
      type: object
      required:
        - detail
        - error_code
        - request_id
        - retryable
      title: PublicJobError
    PublicJobValidationError:
      properties:
        detail:
          type: string
          title: Detail
          description: Human-readable explanation of why the request failed.
        error_code:
          $ref: '#/components/schemas/V1ErrorCode'
          description: >-
            Stable error code for handling the failure in code. Do not branch on
            the wording of `detail`.
        request_id:
          type: string
          title: Request Id
          description: >-
            Request identifier, equal to the X-Request-Id response header. Quote
            this value when contacting support.
        retryable:
          type: boolean
          title: Retryable
          description: >-
            If true, retrying the request can succeed without changing its
            inputs; respect Retry-After when present. If false, correct the
            request or resolve the reported condition before retrying.
        param:
          anyOf:
            - type: string
            - type: 'null'
          title: Param
          description: >-
            Dot-separated path to the parameter that caused the error, such as
            `body.lead` or `header.Idempotency-Key`. Null when the error is not
            tied to a parameter.
        errors:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Errors
          description: >-
            Individual validation failures, each with a parameter location
            (`loc`), message (`msg`), and error type (`type`).
      type: object
      required:
        - detail
        - error_code
        - request_id
        - retryable
        - errors
      title: PublicJobValidationError
    SignIn:
      properties:
        type:
          type: string
          maxLength: 200
          title: Type
          description: >-
            How the secret is sent: bearer (Authorization: Bearer), header,
            query, or basic (HTTP Basic)
          default: bearer
        name:
          anyOf:
            - type: string
              maxLength: 200
            - type: 'null'
          title: Name
          description: >-
            The header or query parameter the secret goes in, for header and
            query
      type: object
      title: SignIn
    V1ErrorCode:
      type: string
      enum:
        - invalid_cursor
        - request_in_progress
        - limit_exceeded
        - entity_type_mismatch
        - unsupported_file
        - invalid_upload
        - file_too_large
        - items_not_available
        - list_not_ready
        - job_not_finished
        - not_found
        - validation_error
        - rate_limited
        - internal_error
        - unavailable
        - unauthenticated
        - forbidden
        - insufficient_credits
        - idempotency_key_reused
        - export_source_changed
        - job_execution_changed
        - job_failed
        - item_failed
        - aborted
        - workflow_changed
        - workflow_locked
        - workflow_not_runnable
        - timed_out
      title: V1ErrorCode
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Your Sixtyfour API key.
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        An OAuth access token from `POST /oauth/token`, sent as `Authorization:
        Bearer <token>`. An API key sent as a bearer token is refused with 401.
        When both headers are sent, the bearer token is used.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.