APIs.io Engineering Platform Secondary DNS (Peer) API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Secondary DNS (Peer) API
  version: 4.0.0
tags:
- name: Secondary DNS (Peer)
paths:
  /accounts/{account_id}/secondary_dns/peers:
    get:
      description: List Peers.
      operationId: secondary-dns-(-peer)-list-peers
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_schemas-response_collection'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: List Peers response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_schemas-response_collection'
          description: List Peers response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Peers
      tags:
      - Secondary DNS (Peer)
      x-cfPermissionsRequired:
        enum:
        - '#dns_records:read'
        - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Create Peer.
      operationId: secondary-dns-(-peer)-create-peer
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  $ref: '#/components/schemas/secondary-dns_components-schemas-name'
              required:
              - name
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_schemas-single_response'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: Create Peer response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_schemas-single_response'
          description: Create Peer response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create Peer
      tags:
      - Secondary DNS (Peer)
      x-cfPermissionsRequired:
        enum:
        - '#dns_records:edit'
        - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/secondary_dns/peers/{peer_id}:
    delete:
      description: Delete Peer.
      operationId: secondary-dns-(-peer)-delete-peer
      parameters:
      - in: path
        name: peer_id
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_components-schemas-id_response'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: Delete Peer response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_components-schemas-id_response'
          description: Delete Peer response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Peer
      tags:
      - Secondary DNS (Peer)
      x-cfPermissionsRequired:
        enum:
        - '#dns_records:edit'
        - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Get Peer.
      operationId: secondary-dns-(-peer)-peer-details
      parameters:
      - in: path
        name: peer_id
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_schemas-single_response'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: Peer Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_schemas-single_response'
          description: Peer Details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Peer Details
      tags:
      - Secondary DNS (Peer)
      x-cfPermissionsRequired:
        enum:
        - '#dns_records:read'
        - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Modify Peer.
      operationId: secondary-dns-(-peer)-update-peer
      parameters:
      - in: path
        name: peer_id
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/secondary-dns_peer'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_schemas-single_response'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: Update Peer response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_schemas-single_response'
          description: Update Peer response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update Peer
      tags:
      - Secondary DNS (Peer)
      x-cfPermissionsRequired:
        enum:
        - '#dns_records:edit'
        - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
components:
  schemas:
    secondary-dns_api-response-single:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-common'
      type: object
    secondary-dns_components-schemas-identifier:
      example: 23ff594956f20c2a721606e94745a8aa
      readOnly: true
      type: string
    secondary-dns_port:
      description: DNS port of primary or secondary nameserver, depending on what zone this peer is linked to.
      example: 53
      type: number
    secondary-dns_tsig_id:
      description: TSIG authentication will be used for zone transfer if configured.
      example: 69cd1e104af3e6ed3cb344f263fd0d5a
      type: string
    secondary-dns_ixfr_enable:
      description: Enable IXFR transfer protocol, default is AXFR. Only applicable to secondary zones.
      example: false
      type: boolean
    secondary-dns_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    secondary-dns_schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/secondary-dns_peer'
            type: array
    secondary-dns_peer:
      properties:
        id:
          $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
        ip:
          $ref: '#/components/schemas/secondary-dns_ip'
        ixfr_enable:
          $ref: '#/components/schemas/secondary-dns_ixfr_enable'
        name:
          $ref: '#/components/schemas/secondary-dns_components-schemas-name'
        port:
          $ref: '#/components/schemas/secondary-dns_port'
        tsig_id:
          $ref: '#/components/schemas/secondary-dns_tsig_id'
      required:
      - id
      - name
      type: object
    secondary-dns_ip:
      description: IPv4/IPv6 address of primary or secondary nameserver, depending on what zone this peer is linked to. For primary zones this IP defines the IP of the secondary nameserver Cloudflare will NOTIFY upon zone changes. For secondary zones this IP defines the IP of the primary nameserver Cloudflare will send AXFR/IXFR requests to.
      example: 192.0.2.53
      type: string
    secondary-dns_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/secondary-dns_result_info'
      type: object
    secondary-dns_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/secondary-dns_messages'
        messages:
          $ref: '#/components/schemas/secondary-dns_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    secondary-dns_components-schemas-name:
      description: The name of the peer.
      example: my-peer-1
      type: string
    secondary-dns_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-single'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
            type: object
    secondary-dns_account_identifier:
      example: 01a7362d577a6c3019a474fd6f485823
      readOnly: true
      type: string
    secondary-dns_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/secondary-dns_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/secondary-dns_messages'
          example: []
        result:
          enum:
          - null
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    secondary-dns_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    secondary-dns_schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/secondary-dns_peer'
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey