openapi: 3.2.0
info:
  title: Cal.com API v2 Allowlists API
  description: ''
  version: 1.0.0
  contact: {}
servers: []
tags:
- name: Allow Lists
paths:
  /v2/allowlists:
    get:
      description: Returns the IPv4 ranges Cal.com sends traffic from and receives traffic on, keyed by service. Poll this endpoint instead of hard-coding addresses, because they can change.
      operationId: AllowlistsController_getAllowlists
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllowlistsOutput'
      summary: Get the Cal.com IP allowlists
      tags:
      - Allow Lists
      x-oauth-scopes: []
  /v2/allowlists/{service}:
    get:
      operationId: AllowlistsController_getAllowlist
      parameters:
      - name: service
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllowlistOutput'
      summary: Get the Cal.com IP allowlist of one service
      tags:
      - Allow Lists
      x-oauth-scopes: []
components:
  schemas:
    AllowlistServiceOutput:
      type: object
      properties:
        direction:
          enum:
          - ingress-to-cal
          - egress-from-cal
          type: string
          description: '`ingress-to-cal` are the addresses your systems connect to when they call Cal.com. `egress-from-cal` are the addresses Cal.com connects to your systems from, for example when delivering a webhook.'
          example: egress-from-cal
        ipv4:
          example:
          - 203.0.113.20/32
          - 203.0.113.21/32
          type: array
          items:
            type: string
      required:
      - direction
      - ipv4
    AllowlistMetadataOutput:
      type: object
      properties:
        schemaVersion:
          type: string
          example: v1
      required:
      - schemaVersion
    AllowlistServiceData:
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/AllowlistMetadataOutput'
        service:
          $ref: '#/components/schemas/NamedAllowlistServiceOutput'
      required:
      - metadata
      - service
    NamedAllowlistServiceOutput:
      type: object
      properties:
        direction:
          enum:
          - ingress-to-cal
          - egress-from-cal
          type: string
          description: '`ingress-to-cal` are the addresses your systems connect to when they call Cal.com. `egress-from-cal` are the addresses Cal.com connects to your systems from, for example when delivering a webhook.'
          example: egress-from-cal
        ipv4:
          example:
          - 203.0.113.20/32
          - 203.0.113.21/32
          type: array
          items:
            type: string
        name:
          type: string
          example: webhooks
      required:
      - direction
      - ipv4
      - name
    GetAllowlistOutput:
      type: object
      properties:
        status:
          enum:
          - success
          - error
          type: string
          example: success
        data:
          $ref: '#/components/schemas/AllowlistServiceData'
      required:
      - status
      - data
    GetAllowlistsOutput:
      type: object
      properties:
        status:
          enum:
          - success
          - error
          type: string
          example: success
        data:
          $ref: '#/components/schemas/AllowlistServicesData'
      required:
      - status
      - data
    AllowlistServicesData:
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/AllowlistMetadataOutput'
        services:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AllowlistServiceOutput'
          description: Allowlists keyed by service name.
      required:
      - metadata
      - services
x-provenance:
  method: harvested
  publisher: Cal.com
  source: https://cal.com/docs/api-reference/v2/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)