Send Test Email

Send a test email based on the portal’s email template, using the content provided in the request.
The email will be sent to the Konnect user who triggered the test.

post

Path Parameters

portalIdstring(uuid)required

ID of the portal.

templateNamestringrequired

Short name email template name.

Allowed values:confirm-email-addressapp-registration-approvedapp-registration-rejectedapp-registration-revokedreset-passwordaccount-access-approvedaccount-access-rejectedaccount-access-revokedapi-key-expiring-soonapi-key-expireddeveloper-invitation

Body

application/json

Send a test email using a custom email template.

contentobjectrequired
Show Child Parameters

Response

No Content

post/portals/{portalId}/email-templates/{templateName}/send-test-email

Body

{ "content": { "subject": "{{developer_fullname}}, Your registration has been revoked", "title": "Revoked registration", "body": "Hello {{ developer_fullname }},\\n\\your registration has been **revoked**.", "button_label": "Acknowledge" } }
 

Portals IP Allow List

APIs related to Konnect Portal IP Allow List.

Create an IP allow list for a portal

Create an IP allow list for a portal.

post

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json
* Additional properties are NOT allowed.
allowed_ipsarray[string]requiredunique-items

The list of allowed ips for the portal.

>= 1 items<= 25 items

Example:["192.168.1.1","192.168.1.0/22"]

Response

application/json

The portal’s IP allow list configuration.

IPEntry

An entry representing a collection of allowed IP addresses or CIDR blocks.

* Additional properties are NOT allowed.
idstring(uuid)required

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

allowed_ipsarray[string]requiredunique-items

The list of allowed ips for the portal.

>= 1 items<= 25 items

Example:["192.168.1.1","192.168.1.0/22"]

post/portals/{portalId}/ip-allow-list

Body

{ "allowed_ips": [ "192.168.1.1", "192.168.1.0/22" ] }
 
application/json

List the IP allow list for portal

Lists the IP allow list configuration for a portal.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[before]string

Request the next page of data, starting with the item before this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

The portal’s IP allow list configuration.

* Additional properties are NOT allowed.
metaobjectrequired
Show Child Parameters
dataarray[object]requiredunique-items

An entry representing a collection of allowed IP addresses or CIDR blocks.

<= 1000 items

Example:[{"id":"660e8400-e29b-41d4-a716-446655440000","allowed_ips":["192.168.1.1"]},{"id":"550e8400-e29b-41d4-a716-446655440000","allowed_ips":["192.168.1.0/22","192.168.1.52"]}]

* Additional properties are NOT allowed.
Show Child Parameters
get/portals/{portalId}/ip-allow-list
 
application/json

Replace an IP allow list for a portal

Replace an IP allow list for a portal.

put

Path Parameters

portalIdstring(uuid)required

ID of the portal.

idstring(uuid)required

ID of the allow list.

Body

application/json
* Additional properties are NOT allowed.
allowed_ipsarray[string]requiredunique-items

The list of allowed ips for the portal.

>= 1 items<= 25 items

Example:["192.168.1.1","192.168.1.0/22"]

Response

application/json

The portal’s IP allow list configuration.

IPEntry

An entry representing a collection of allowed IP addresses or CIDR blocks.

* Additional properties are NOT allowed.
idstring(uuid)required

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

allowed_ipsarray[string]requiredunique-items

The list of allowed ips for the portal.

>= 1 items<= 25 items

Example:["192.168.1.1","192.168.1.0/22"]

put/portals/{portalId}/ip-allow-list/{id}

Body

{ "allowed_ips": [ "192.168.1.1", "192.168.1.0/22" ] }
 
application/json