Boomi MFT - AFT Management API Reference (v1) - ThruAdminIpAllowlist

Updated 13 November 2026

Toggle Pane

• ThruAdminIpAllowlist
  • getReports whether IP allowlist management is available
  • getLists the environment's configured IP allowlist entries
  • postQueues an IPv4 address or CIDR block on one or more protocols for confirmation by the allowlist function
  • putChanges an entry's description and protocols; the address cannot be changed
  • delRemoves an entry from every configured protocol
  • postStarts a fresh attempt for exactly one failed addition or removal.

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

ThruAdminIpAllowlist

Environment IP allowlist entries, protocol synchronization, availability, and retries.

Reports whether IP allowlist management is available

Requires Thru Ops permission 9100. Returns availability and a reason code without calling the allowlist function.

Authorizations:

ApiKeyBearer

Responses

Response Schema:

application/jsontext/plaintext/jsonapplication/json

available	boolean Whether IP allowlist management is enabled and correctly configured.
reason	string or null Reason code explaining why management is unavailable.

https://us.thruinc.com/api/ThruAdminIpAllowlist/availability

https://uk.thruinc.com/api/ThruAdminIpAllowlist/availability

https://eu.thruinc.com/api/ThruAdminIpAllowlist/availability

https://au.thruinc.com/api/ThruAdminIpAllowlist/availability

Response samples

• 200

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "available": true,
• "reason": "string"

}

Lists the environment's configured IP allowlist entries

Requires Thru Ops permission 9100. Includes failed removals because those addresses may still be allowed.

Authorizations:

ApiKeyBearer

query Parameters

includeRemoved

boolean Default: false Include historical removed entries; entries still being removed are always included.

Responses

Response Schema:

application/jsontext/plaintext/jsonapplication/json

	Array of objects or null (IpAllowlistEntry)
	Array of objects or null (IpAllowlistFailedRemoval)

https://us.thruinc.com/api/ThruAdminIpAllowlist

https://uk.thruinc.com/api/ThruAdminIpAllowlist

https://eu.thruinc.com/api/ThruAdminIpAllowlist

https://au.thruinc.com/api/ThruAdminIpAllowlist

Response samples

• 200
• 404

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "entries": [

  • {

    • "id": 0,
    • "cidr": "string",
    • "description": "string",
    • "protocols": [

      • {

        • "id": 0,
        • "version": "string",
        • "protocol": 1,
        • "syncStatus": 0,
        • "syncError": "string",
        • "createdBy": "string",
        • "createdDate": "2019-08-24T14:15:22Z",
        • "syncedDate": "2019-08-24T14:15:22Z",
        • "deletedBy": "string",
        • "deletedDate": "2019-08-24T14:15:22Z",
        • "supersededDate": "2019-08-24T14:15:22Z"

        }

      ],
    • "createdBy": "string",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "deletedBy": "string",
    • "deletedDate": "2019-08-24T14:15:22Z"

    }

  ],
• "failedRemovals": [

  • {

    • "id": 0,
    • "protocol": 1,
    • "cidr": "string",
    • "syncError": "string",
    • "deletedBy": "string",
    • "deletedDate": "2019-08-24T14:15:22Z"

    }

  ]

}

Queues an IPv4 address or CIDR block on one or more protocols for confirmation by the allowlist function

Requires Thru Ops permission 9100. Saving queues asynchronous firewall synchronization; it does not confirm that access is already allowed.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Public IPv4 address or CIDR block, optional description, and at least one protocol.

cidr	string or null An IPv4 address or CIDR block, for example 203.0.113.0/24.
description	string or null Optional descriptive label for the address, up to 256 characters.
protocols	Array of integers or null <int32> (IpAllowlistProtocol) [ items <int32 > ] Enum: 1 2 3 At least one protocol the address may use.

Responses

Response Schema:

application/jsontext/plaintext/jsonapplication/json

id	integer <int32>
cidr	string or null
description	string or null
	Array of objects or null (IpAllowlistEntryProtocol)
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/ThruAdminIpAllowlist

https://uk.thruinc.com/api/ThruAdminIpAllowlist

https://eu.thruinc.com/api/ThruAdminIpAllowlist

https://au.thruinc.com/api/ThruAdminIpAllowlist

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "cidr": "string",
• "description": "string",
• "protocols": [

  • 1

  ]

}

Response samples

• 200
• 400
• 404
• 409

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": 0,
• "cidr": "string",
• "description": "string",
• "protocols": [

  • {

    • "id": 0,
    • "version": "string",
    • "protocol": 1,
    • "syncStatus": 0,
    • "syncError": "string",
    • "createdBy": "string",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "syncedDate": "2019-08-24T14:15:22Z",
    • "deletedBy": "string",
    • "deletedDate": "2019-08-24T14:15:22Z",
    • "supersededDate": "2019-08-24T14:15:22Z"

    }

  ],
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Changes an entry's description and protocols; the address cannot be changed

Requires Thru Ops permission 9100. Protocol changes are synchronized asynchronously.

Authorizations:

ApiKeyBearer

path Parameters

id required

integer <int32> Unique identifier of the IP allowlist entry.

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated description and desired protocols.

description	string or null Descriptive label for the address, up to 256 characters.
protocols	Array of integers or null <int32> (IpAllowlistProtocol) [ items <int32 > ] Enum: 1 2 3 Desired protocols; at least one must be selected.

Responses

Response Schema:

application/jsontext/plaintext/jsonapplication/json

id	integer <int32>
cidr	string or null
description	string or null
	Array of objects or null (IpAllowlistEntryProtocol)
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/ThruAdminIpAllowlist/{id}

https://uk.thruinc.com/api/ThruAdminIpAllowlist/{id}

https://eu.thruinc.com/api/ThruAdminIpAllowlist/{id}

https://au.thruinc.com/api/ThruAdminIpAllowlist/{id}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "description": "string",
• "protocols": [

  • 1

  ]

}

Response samples

• 200
• 400
• 404

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": 0,
• "cidr": "string",
• "description": "string",
• "protocols": [

  • {

    • "id": 0,
    • "version": "string",
    • "protocol": 1,
    • "syncStatus": 0,
    • "syncError": "string",
    • "createdBy": "string",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "syncedDate": "2019-08-24T14:15:22Z",
    • "deletedBy": "string",
    • "deletedDate": "2019-08-24T14:15:22Z",
    • "supersededDate": "2019-08-24T14:15:22Z"

    }

  ],
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Removes an entry from every configured protocol

Requires Thru Ops permission 9100. Removal is queued; the address may remain allowed until the allowlist function confirms removal.

Authorizations:

ApiKeyBearer

path Parameters

id required

integer <int32> Unique identifier of the IP allowlist entry to remove.

Responses

Response Schema:

application/jsontext/plaintext/jsonapplication/json

id	integer <int32>
cidr	string or null
description	string or null
	Array of objects or null (IpAllowlistEntryProtocol)
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/ThruAdminIpAllowlist/{id}

https://uk.thruinc.com/api/ThruAdminIpAllowlist/{id}

https://eu.thruinc.com/api/ThruAdminIpAllowlist/{id}

https://au.thruinc.com/api/ThruAdminIpAllowlist/{id}

Response samples

• 200
• 404

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": 0,
• "cidr": "string",
• "description": "string",
• "protocols": [

  • {

    • "id": 0,
    • "version": "string",
    • "protocol": 1,
    • "syncStatus": 0,
    • "syncError": "string",
    • "createdBy": "string",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "syncedDate": "2019-08-24T14:15:22Z",
    • "deletedBy": "string",
    • "deletedDate": "2019-08-24T14:15:22Z",
    • "supersededDate": "2019-08-24T14:15:22Z"

    }

  ],
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Starts a fresh attempt for exactly one failed addition or removal.

Requires Thru Ops permission 9100. Retries a failed addition or removal only when the supplied version still matches the failed operation.

Authorizations:

ApiKeyBearer

path Parameters

id required	integer <int32> Unique identifier of the IP allowlist entry.
protocolRowId required	integer <int32> Identifier of the entry's protocol row, not the protocol enum value.

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

The failed protocol row's version token returned by the list operation.

version

string or null <byte> The failed protocol row version returned by List. Rejects a stale Retry.

Responses

Response Schema:

application/jsontext/plaintext/jsonapplication/json

id	integer <int32>
cidr	string or null
description	string or null
	Array of objects or null (IpAllowlistEntryProtocol)
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/ThruAdminIpAllowlist/{id}/protocols/{protocolRowId}/retry

https://uk.thruinc.com/api/ThruAdminIpAllowlist/{id}/protocols/{protocolRowId}/retry

https://eu.thruinc.com/api/ThruAdminIpAllowlist/{id}/protocols/{protocolRowId}/retry

https://au.thruinc.com/api/ThruAdminIpAllowlist/{id}/protocols/{protocolRowId}/retry

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "version": "string"

}

Response samples

• 200
• 400
• 404
• 409

Content type

application/jsontext/plaintext/jsonapplication/json

{

• "id": 0,
• "cidr": "string",
• "description": "string",
• "protocols": [

  • {

    • "id": 0,
    • "version": "string",
    • "protocol": 1,
    • "syncStatus": 0,
    • "syncError": "string",
    • "createdBy": "string",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "syncedDate": "2019-08-24T14:15:22Z",
    • "deletedBy": "string",
    • "deletedDate": "2019-08-24T14:15:22Z",
    • "supersededDate": "2019-08-24T14:15:22Z"

    }

  ],
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}