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

# Create a partner connection

> Register a partner's OCPI endpoint as a connection you own, setting each side's role, the OCPI version and token. Stays pending until you run the handshake.



## OpenAPI

````yaml /openapi/public-api.json post /connections
openapi: 3.1.0
info:
  title: EV Roaming Tester public API
  version: 1.0.0
  description: >-
    Automate EV Roaming Tester with an evrt_ API key: register partner
    connections, run conformance suites and charging journeys, and read the
    graded reports.
servers:
  - url: https://evsim.synergyboat.com/api/v1
security:
  - apiKey: []
tags:
  - name: Connections
  - name: Testing
  - name: Reports
  - name: Usage
  - name: Journeys
paths:
  /connections:
    post:
      tags:
        - Connections
      summary: Create a partner connection
      description: >-
        Register a partner's OCPI endpoint as a connection you own, setting each
        side's role, the OCPI version and token. Stays pending until you run the
        handshake.
      operationId: connections_create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnection'
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
        '400':
          description: Malformed input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: The plan does not include this capability
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Stale plan, idempotency conflict, or stale recovery version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Unsupported configuration for this target
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Quota or rate limit reached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    CreateConnection:
      type: object
      required:
        - partnerBaseUrl
        - ourRole
        - theirRole
        - ocpiVersion
        - tokenA
      properties:
        partnerBaseUrl:
          type: string
          format: uri
        ourRole:
          type: string
          enum:
            - CPO
            - EMSP
        theirRole:
          type: string
          enum:
            - CPO
            - EMSP
        ocpiVersion:
          type: string
          enum:
            - 2.1.1
            - '2.2'
            - 2.2.1
            - 2.3.0
        tokenA:
          type: string
          description: Partner-issued registration token; never logged.
    Connection:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/ConnectionView'
    Error:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
    ConnectionView:
      type: object
      required:
        - _id
        - partnerBaseUrl
        - ourRole
        - theirRole
        - ocpiVersion
        - status
      properties:
        _id:
          type: string
        partnerBaseUrl:
          type: string
          format: uri
        ourRole:
          type: string
          enum:
            - CPO
            - EMSP
        theirRole:
          type: string
          enum:
            - CPO
            - EMSP
        ocpiVersion:
          type: string
          enum:
            - 2.1.1
            - '2.2'
            - 2.2.1
            - 2.3.0
        status:
          type: string
          enum:
            - pending
            - registered
            - failed
        lastError:
          type: string
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: An evrt_... API key created in the app under Settings.

````