FusionAuth API — IP ACL

naftiko: 1.0.0-alpha2
info:
  label: FusionAuth API — IP ACL
  description: 'FusionAuth API — IP ACL. 7 operations. Lead operation: Retrieves the IP Access Control List with the given Id.. Self-contained Naftiko capability covering one business surface.'
  tags:
  - FusionAuth
  - IP ACL
  created: '2026-05-20'
  modified: '2026-05-20'
binds:
- namespace: env
  keys:
    FUSIONAUTH_API_KEY: FUSIONAUTH_API_KEY
capability:
  consumes:
  - type: http
    namespace: fusionauth-ip-acl
    baseUri: http://localhost:9011
    description: FusionAuth API — IP ACL business capability. Self-contained, no shared references.
    resources:
    - name: api-ip-acl
      path: /api/ip-acl
      operations:
      - name: createipaccesscontrollist
        method: POST
        description: Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-ip-acl-search
      path: /api/ip-acl/search
      operations:
      - name: searchipaccesscontrollistswithid
        method: POST
        description: Searches the IP Access Control Lists with the specified criteria and pagination.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-ip-acl-accesscontrollistid
      path: /api/ip-acl/{accessControlListId}
      operations:
      - name: createipaccesscontrollistwithid
        method: POST
        description: Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accessControlListId
          in: path
          type: string
          description: The Id for the IP Access Control List. If not provided a secure random UUID will be generated.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: patchipaccesscontrollistwithid
        method: PATCH
        description: Update the IP Access Control List with the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accessControlListId
          in: path
          type: string
          description: The Id of the IP Access Control List to patch.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: updateipaccesscontrollistwithid
        method: PUT
        description: Updates the IP Access Control List with the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accessControlListId
          in: path
          type: string
          description: The Id of the IP Access Control List to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-ip-acl-ipaccesscontrollistid
      path: /api/ip-acl/{ipAccessControlListId}
      operations:
      - name: deleteipaccesscontrollistwithid
        method: DELETE
        description: Deletes the IP Access Control List for the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ipAccessControlListId
          in: path
          type: string
          description: The Id of the IP Access Control List to delete.
          required: true
      - name: retrieveipaccesscontrollistwithid
        method: GET
        description: Retrieves the IP Access Control List with the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ipAccessControlListId
          in: path
          type: string
          description: The Id of the IP Access Control List.
          required: true
  exposes:
  - type: rest
    namespace: fusionauth-ip-acl-rest
    port: 8080
    description: REST adapter for FusionAuth API — IP ACL. One resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/ip-acl
      name: api-ip-acl
      description: REST surface for api-ip-acl.
      operations:
      - method: POST
        name: createipaccesscontrollist
        description: Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated.
        call: fusionauth-ip-acl.createipaccesscontrollist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/ip-acl/search
      name: api-ip-acl-search
      description: REST surface for api-ip-acl-search.
      operations:
      - method: POST
        name: searchipaccesscontrollistswithid
        description: Searches the IP Access Control Lists with the specified criteria and pagination.
        call: fusionauth-ip-acl.searchipaccesscontrollistswithid
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/ip-acl/{accessControlListId}
      name: api-ip-acl-accesscontrollistid
      description: REST surface for api-ip-acl-accesscontrollistid.
      operations:
      - method: POST
        name: createipaccesscontrollistwithid
        description: Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated.
        call: fusionauth-ip-acl.createipaccesscontrollistwithid
        with:
          accessControlListId: rest.accessControlListId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchipaccesscontrollistwithid
        description: Update the IP Access Control List with the given Id.
        call: fusionauth-ip-acl.patchipaccesscontrollistwithid
        with:
          accessControlListId: rest.accessControlListId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateipaccesscontrollistwithid
        description: Updates the IP Access Control List with the given Id.
        call: fusionauth-ip-acl.updateipaccesscontrollistwithid
        with:
          accessControlListId: rest.accessControlListId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/ip-acl/{ipAccessControlListId}
      name: api-ip-acl-ipaccesscontrollistid
      description: REST surface for api-ip-acl-ipaccesscontrollistid.
      operations:
      - method: DELETE
        name: deleteipaccesscontrollistwithid
        description: Deletes the IP Access Control List for the given Id.
        call: fusionauth-ip-acl.deleteipaccesscontrollistwithid
        with:
          ipAccessControlListId: rest.ipAccessControlListId
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: retrieveipaccesscontrollistwithid
        description: Retrieves the IP Access Control List with the given Id.
        call: fusionauth-ip-acl.retrieveipaccesscontrollistwithid
        with:
          ipAccessControlListId: rest.ipAccessControlListId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: fusionauth-ip-acl-mcp
    port: 9090
    transport: http
    description: MCP adapter for FusionAuth API — IP ACL. One tool per consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: fusionauth-createipaccesscontrollist
      description: Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-ip-acl.createipaccesscontrollist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-searchipaccesscontrollistswithid
      description: Searches the IP Access Control Lists with the specified criteria and pagination.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-ip-acl.searchipaccesscontrollistswithid
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-createipaccesscontrollistwithid
      description: Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-ip-acl.createipaccesscontrollistwithid
      with:
        accessControlListId: tools.accessControlListId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-patchipaccesscontrollistwithid
      description: Update the IP Access Control List with the given Id.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-ip-acl.patchipaccesscontrollistwithid
      with:
        accessControlListId: tools.accessControlListId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-updateipaccesscontrollistwithid
      description: Updates the IP Access Control List with the given Id.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: fusionauth-ip-acl.updateipaccesscontrollistwithid
      with:
        accessControlListId: tools.accessControlListId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-deleteipaccesscontrollistwithid
      description: Deletes the IP Access Control List for the given Id.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: fusionauth-ip-acl.deleteipaccesscontrollistwithid
      with:
        ipAccessControlListId: tools.ipAccessControlListId
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-retrieveipaccesscontrollistwithid
      description: Retrieves the IP Access Control List with the given Id.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fusionauth-ip-acl.retrieveipaccesscontrollistwithid
      with:
        ipAccessControlListId: tools.ipAccessControlListId
      outputParameters:
      - type: object
        mapping: $.