Twilio SendGrid IP Access Management API — IP Access Management

naftiko: 1.0.0-alpha2
info:
  label: Twilio SendGrid IP Access Management API — IP Access Management
  description: 'Twilio SendGrid IP Access Management API — IP Access Management. 6 operations. Lead operation: Retrieve all
    recent access attempts. Self-contained Naftiko capability covering one Sendgrid business surface.'
  tags:
  - Sendgrid
  - IP Access Management
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SENDGRID_API_KEY: SENDGRID_API_KEY
capability:
  consumes:
  - type: http
    namespace: tsg_ip_access_management_v3-ip-access-management
    baseUri: https://api.sendgrid.com
    description: Twilio SendGrid IP Access Management API — IP Access Management business capability. Self-contained, no shared
      references.
    resources:
    - name: v3-access_settings-activity
      path: /v3/access_settings/activity
      operations:
      - name: listaccessactivity
        method: GET
        description: Retrieve all recent access attempts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Limits the number of IPs to return.
    - name: v3-access_settings-whitelist
      path: /v3/access_settings/whitelist
      operations:
      - name: addiptoallowlist
        method: POST
        description: Add one or more IPs to the allow list
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: listallowedip
        method: GET
        description: Retrieve a list of currently allowed IPs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteallowedips
        method: DELETE
        description: Remove one or more IPs from the allow list
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v3-access_settings-whitelist-rule_id
      path: /v3/access_settings/whitelist/{rule_id}
      operations:
      - name: getallowedip
        method: GET
        description: Retrieve a specific allowed IP
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteallowedip
        method: DELETE
        description: Remove a specific IP from the allowed list
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.SENDGRID_API_KEY}}'
  exposes:
  - type: rest
    namespace: tsg_ip_access_management_v3-ip-access-management-rest
    port: 8080
    description: REST adapter for Twilio SendGrid IP Access Management API — IP Access Management. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/v3/access-settings/activity
      name: v3-access-settings-activity
      description: REST surface for v3-access_settings-activity.
      operations:
      - method: GET
        name: listaccessactivity
        description: Retrieve all recent access attempts
        call: tsg_ip_access_management_v3-ip-access-management.listaccessactivity
        with:
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/access-settings/whitelist
      name: v3-access-settings-whitelist
      description: REST surface for v3-access_settings-whitelist.
      operations:
      - method: POST
        name: addiptoallowlist
        description: Add one or more IPs to the allow list
        call: tsg_ip_access_management_v3-ip-access-management.addiptoallowlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listallowedip
        description: Retrieve a list of currently allowed IPs
        call: tsg_ip_access_management_v3-ip-access-management.listallowedip
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteallowedips
        description: Remove one or more IPs from the allow list
        call: tsg_ip_access_management_v3-ip-access-management.deleteallowedips
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/access-settings/whitelist/{rule-id}
      name: v3-access-settings-whitelist-rule-id
      description: REST surface for v3-access_settings-whitelist-rule_id.
      operations:
      - method: GET
        name: getallowedip
        description: Retrieve a specific allowed IP
        call: tsg_ip_access_management_v3-ip-access-management.getallowedip
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteallowedip
        description: Remove a specific IP from the allowed list
        call: tsg_ip_access_management_v3-ip-access-management.deleteallowedip
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: tsg_ip_access_management_v3-ip-access-management-mcp
    port: 9090
    transport: http
    description: MCP adapter for Twilio SendGrid IP Access Management API — IP Access Management. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: retrieve-all-recent-access-attempts
      description: Retrieve all recent access attempts
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tsg_ip_access_management_v3-ip-access-management.listaccessactivity
      with:
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: add-one-more-ips-allow
      description: Add one or more IPs to the allow list
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: tsg_ip_access_management_v3-ip-access-management.addiptoallowlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-list-currently-allowed-ips
      description: Retrieve a list of currently allowed IPs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tsg_ip_access_management_v3-ip-access-management.listallowedip
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-one-more-ips-allow
      description: Remove one or more IPs from the allow list
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: tsg_ip_access_management_v3-ip-access-management.deleteallowedips
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-specific-allowed-ip
      description: Retrieve a specific allowed IP
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tsg_ip_access_management_v3-ip-access-management.getallowedip
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-specific-ip-allowed-list
      description: Remove a specific IP from the allowed list
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: tsg_ip_access_management_v3-ip-access-management.deleteallowedip
      outputParameters:
      - type: object
        mapping: $.