Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Portal Emails API

APIs related to Konnect Developer Portal Emails.

Kong Portal Emails API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Portal Emails. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.

This API exposes 19 operations across 10 paths, and defines 39 schemas. It is described by OpenAPI 3.1.0, at version 3.14.0.

Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.

19 operations 10 paths 39 schemas 4 DELETE9 GET3 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Kong Portal Emails API declares 1 security scheme for authenticating requests. An API key is passed in the header as Kong-Admin-Token (adminToken). By default, every request must be authenticated.

Paths & Operations 19

Across 10 paths, the API surfaces 19 operations — 4 DELETE, 9 GET, 3 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Portal Emails 19

APIs related to Konnect Developer Portal Emails.

GET
/v3/portals/{portalId}/email-config
Get the email config for the portal
get-email-config 1 param → 200401403404
POST
/v3/portals/{portalId}/email-config
Create the email config for a portal
create-portal-email-config 1 param body → 201400401403404409
PATCH
/v3/portals/{portalId}/email-config
Setup the email config for a portal
update-portal-email-config 1 param body → 200400401403404
DELETE
/v3/portals/{portalId}/email-config
Delete portal email config
delete-portal-email-config 1 param → 204401403404
GET
/v3/portals/{portalId}/email-deliverydeprecated
Get the email delivery for the portal
get-email-delivery 1 param → 200401403404
PATCH
/v3/portals/{portalId}/email-deliverydeprecated
Setup the email delivery for a portal
update-email-delivery 1 param body → 200400401403404
DELETE
/v3/portals/{portalId}/email-deliverydeprecated
Delete email delivery
delete-email-delivery 1 param → 204401403404
GET
/v3/portals/{portalId}/email-templates
List custom email templates for a portal
list-portal-custom-email-templates 1 param → 200401403404
GET
/v3/portals/{portalId}/email-templates/{templateName}
Get custom email template used in a portal
get-portal-custom-email-template 2 params → 200401403404
PATCH
/v3/portals/{portalId}/email-templates/{templateName}
Update custom email template for a portal
update-portal-custom-email-template 2 params body → 200400401403404
DELETE
/v3/portals/{portalId}/email-templates/{templateName}
Delete custom email template
delete-portal-custom-email-template 2 params → 204401403404
POST
/v3/portals/{portalId}/email-templates/{templateName}/send-test-email
Send Test Email
post-portal-custom-email-test-send 2 params body → 204400401403404
GET
/v3/portals/email-domains
List email domains
list-email-domains 4 params → 200401403
POST
/v3/portals/email-domains
Create an email domain
create-email-domain body → 201400401403404
GET
/v3/portals/email-domains/{emailDomain}
Get an email domain
get-email-domain 1 param → 200401403404
DELETE
/v3/portals/email-domains/{emailDomain}
Delete an email domain
delete-email-domain 1 param → 204401403404
GET
/v3/portals/email-templates
List default email templates
list-default-email-templates → 200401403404
GET
/v3/portals/email-templates/{templateName}
Get default email template
get-default-email-template 1 param → 200401403404
GET
/v3/portals/email-templates/variables
List email template variables
list-email-template-variables → 200401403404

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are EmailTemplate (8 properties), PortalEmailConfig (7 properties), InvalidParameterMinimumLength (5 properties), EmailDomain (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
InvalidParameterChoiceItem
object
5 properties 4 required
ConflictError
ListDomains
object
2 properties 2 required
InvalidParameterMaximumLength
object
5 properties 4 required
EmailTemplateVariableName
string
Enum for available portal email template variables.
EmailDeliveryUpdatePayload
object
3 properties
EmailVerificationStatus
string
Specifies the status of the mail domain verification
ForbiddenError
UnauthorizedError
PortalEmailConfig
object
7 properties 6 required
EmailTemplateVariable
object
4 properties 4 required
DefaultEmailTemplate
object
4 properties 4 required
StringFieldFilter
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
PaginatedMeta
object
returns the pagination information
1 property 1 required
EmailDomainFilterParameters
object
2 properties
SendTestEmailTemplateContent
object
4 properties 3 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
DefaultEmailTemplateContent
object
4 properties 3 required
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
EmailDomainPayload
object
1 property 1 required
PostPortalEmailConfig
object
4 properties
DNSRecord
object
3 properties 3 required
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
EmailTemplateName
string
Short name email template name.
EmailTemplateContent
object
4 properties
InvalidParameterStandard
object
4 properties 2 required
PatchPortalEmailConfig
object
4 properties
EmailTemplate
object
8 properties 7 required
EmailTemplateVariablesList
object
1 property
EmailDomainVerification
object
3 properties 3 required
NotFoundError
EmailDomain
object
5 properties 5 required
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
EmailDelivery
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-portal-emails-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
Kong AI Gateway
Kong Agent Gateway
Kong MCP Registry
Kong Context Mesh
Kong Mesh
Kong Insomnia
Kong ACLs API
Kong Add-Ons API
Kong API API
Kong API Attributes API
Kong API Documentation API