Portal Management V3 (3.0.10)

Download OpenAPI specification:Download

URL: https://konghq.com

The management API for Portals

Portal Custom Domains

APIs related to configuration of Konnect Developer Portals custom domains.

Get Custom Domain

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Get the custom domain associated to the portal.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

portalId

required

string <uuid>

ID of the portal.

Responses

United-States Production region

https://us.api.konghq.com/v3/portals/{portalId}/custom-domain

Europe Production region

https://eu.api.konghq.com/v3/portals/{portalId}/custom-domain

Australia Production region

https://au.api.konghq.com/v3/portals/{portalId}/custom-domain

Middle-East Production region

https://me.api.konghq.com/v3/portals/{portalId}/custom-domain

India Production region

https://in.api.konghq.com/v3/portals/{portalId}/custom-domain

Response samples

200
401
403
404

Content type

application/json

{"hostname": "string",
"enabled": true,
"ssl": {"domain_verification_method": "http",
"verification_status": "verified",
"validation_errors": ["string"
],
"uploaded_at": "2022-11-04T20:10:06.927Z",
"expires_at": "2022-11-04T20:10:06.927Z"
},
"cname_status": "verified",
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Create Custom Domain

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Creates the custom domain associated with the portal. Only one custom domain can be associated with a portal at a time.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

portalId

required

string <uuid>

ID of the portal.

Request Body schema: application/json

Create a portal custom domain.

hostname required	string
enabled required	boolean
required	object (CreatePortalCustomDomainSSL)

Responses

United-States Production region

https://us.api.konghq.com/v3/portals/{portalId}/custom-domain

Europe Production region

https://eu.api.konghq.com/v3/portals/{portalId}/custom-domain

Australia Production region

https://au.api.konghq.com/v3/portals/{portalId}/custom-domain

Middle-East Production region

https://me.api.konghq.com/v3/portals/{portalId}/custom-domain

India Production region

https://in.api.konghq.com/v3/portals/{portalId}/custom-domain

Request samples

Payload

Content type

application/json

{"hostname": "string",
"enabled": true,
"ssl": {"domain_verification_method": "http",
"custom_certificate": "string",
"custom_private_key": "string"
}
}

Response samples

201
400
401
403
404

Content type

application/json

{"hostname": "string",
"enabled": true,
"ssl": {"domain_verification_method": "http",
"verification_status": "verified",
"validation_errors": ["string"
],
"uploaded_at": "2022-11-04T20:10:06.927Z",
"expires_at": "2022-11-04T20:10:06.927Z"
},
"cname_status": "verified",
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Enable or Disable Domain

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Updates the portal domain associated with the portal.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

portalId

required

string <uuid>

ID of the portal.

Request Body schema: application/json

Create a portal custom domain.

enabled	boolean
custom_certificate	string Custom certificate to be used for the SSL termination.
custom_private_key	string Custom certificate private key to be used for the SSL termination.

Responses

United-States Production region

https://us.api.konghq.com/v3/portals/{portalId}/custom-domain

Europe Production region

https://eu.api.konghq.com/v3/portals/{portalId}/custom-domain

Australia Production region

https://au.api.konghq.com/v3/portals/{portalId}/custom-domain

Middle-East Production region

https://me.api.konghq.com/v3/portals/{portalId}/custom-domain

India Production region

https://in.api.konghq.com/v3/portals/{portalId}/custom-domain

Request samples

Payload

Content type

application/json

{"enabled": true,
"custom_certificate": "string",
"custom_private_key": "string"
}

Response samples

200
400
401
403

Content type

application/json

{"hostname": "string",
"enabled": true,
"ssl": {"domain_verification_method": "http",
"verification_status": "verified",
"validation_errors": ["string"
],
"uploaded_at": "2022-11-04T20:10:06.927Z",
"expires_at": "2022-11-04T20:10:06.927Z"
},
"cname_status": "verified",
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Applications

APIs related to Konnect Developer Portal Applications.

List Developers by Application

Lists each developer that can access the given application for this portal.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

portalId required	string <uuid> ID of the portal.
applicationId required	string <uuid> ID of the application.

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.
sort	string Sorts a set of developers for an application. Supported sort attributes are: id
	object Filter application developers returned in the response.

Responses

United-States Production region

https://us.api.konghq.com/v3/portals/{portalId}/applications/{applicationId}/developers

Europe Production region

https://eu.api.konghq.com/v3/portals/{portalId}/applications/{applicationId}/developers

Australia Production region

https://au.api.konghq.com/v3/portals/{portalId}/applications/{applicationId}/developers

Middle-East Production region

https://me.api.konghq.com/v3/portals/{portalId}/applications/{applicationId}/developers

India Production region

https://in.api.konghq.com/v3/portals/{portalId}/applications/{applicationId}/developers

Response samples

200
400
401
403
404

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 4
}
},
"data": [{"id": "8cd9feff-b4da-4a9f-ba49-cbe83c75ff22",
"email": "jane.developer@example.com",
"full_name": "Jane Dev"
},
{"id": "4cd9feff-b4da-4a9f-ba49-cbe83c75ff22",
"email": "john.developer@example.com",
"full_name": "John Dev"
},
{"id": "6cd9feff-b4da-4a9f-ba49-cbe83c75ff22",
"email": "john.developer@example.com",
"full_name": "Jim Dev"
},
{"id": "7cd9feff-b4da-4a9f-ba49-cbe83c75ff22",
"email": "john.developer@example.com",
"full_name": "Jan Dev"
}
]
}

V3 Portal Emails

APIs related to Konnect Developer Portal Emails.

List email domains

Authorizations:

personalAccessTokensystemAccountAccessToken

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.
sort	string Sorts a collection of email domains. Supported sort attributes are: domain created_at updated_at
	object (EmailDomainFilterParameters) Filter email domains returned in the response.

Responses

Response samples

200
401
403

Content type

application/json

{"data": [{"domain": "string",
"verification": {"status": "pending",
"last_time_checked": "2022-11-04T20:10:06.927Z",
"last_time_success": "2022-11-04T20:10:06.927Z"
},
"dns_validation_records": [{"type": "string",
"name": "string",
"value": "string"
}
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
],
"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
}
}

Create an email domain

Authorizations:

personalAccessTokensystemAccountAccessToken

Request Body schema: application/json

domain

required

string

Responses

Request samples

Payload

Content type

application/json

{"domain": "string"
}

Response samples

201
400
401
403
404

Content type

application/json

{"domain": "string",
"verification": {"status": "pending",
"last_time_checked": "2022-11-04T20:10:06.927Z",
"last_time_success": "2022-11-04T20:10:06.927Z"
},
"dns_validation_records": [{"type": "string",
"name": "string",
"value": "string"
}
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Get an email domain

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

emailDomain

required

string

Email domain for custom portal email sender

Responses

United-States Production region

https://us.api.konghq.com/v3/portals/email-domains/{emailDomain}

Europe Production region

https://eu.api.konghq.com/v3/portals/email-domains/{emailDomain}

Australia Production region

https://au.api.konghq.com/v3/portals/email-domains/{emailDomain}

Middle-East Production region

https://me.api.konghq.com/v3/portals/email-domains/{emailDomain}

India Production region

https://in.api.konghq.com/v3/portals/email-domains/{emailDomain}

Response samples

200
401
403
404

Content type

application/json

{"domain": "string",
"verification": {"status": "pending",
"last_time_checked": "2022-11-04T20:10:06.927Z",
"last_time_success": "2022-11-04T20:10:06.927Z"
},
"dns_validation_records": [{"type": "string",
"name": "string",
"value": "string"
}
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Delete an email domain

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

emailDomain

required

string

Email domain for custom portal email sender

Responses

United-States Production region

https://us.api.konghq.com/v3/portals/email-domains/{emailDomain}

Europe Production region

https://eu.api.konghq.com/v3/portals/email-domains/{emailDomain}

Australia Production region

https://au.api.konghq.com/v3/portals/email-domains/{emailDomain}

Middle-East Production region

https://me.api.konghq.com/v3/portals/email-domains/{emailDomain}

India Production region

https://in.api.konghq.com/v3/portals/email-domains/{emailDomain}

Response samples

401
403
404

Content type

application/problem+json

{"status": 401,
"title": "Unauthorized",
"instance": "kong:trace:8347343766220159418",
"detail": "Unauthorized"
}

Retrieve the email delivery for the portal

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

portalId

required

string <uuid>

ID of the portal.

Responses

United-States Production region

https://us.api.konghq.com/v3/portals/{portalId}/email-delivery

Europe Production region

https://eu.api.konghq.com/v3/portals/{portalId}/email-delivery

Australia Production region

https://au.api.konghq.com/v3/portals/{portalId}/email-delivery

Middle-East Production region

https://me.api.konghq.com/v3/portals/{portalId}/email-delivery

India Production region

https://in.api.konghq.com/v3/portals/{portalId}/email-delivery

Response samples

200
401
403
404

Content type

application/json

{"enabled": true,
"from_email": "user@example.com",
"reply_to_email": "user@example.com",
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Setup the email delivery for a portal

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

portalId

required

string <uuid>

ID of the portal.

Request Body schema: application/json

enabled	boolean
from_email	string or null <email>
reply_to_email	string or null <email>

Responses

United-States Production region

https://us.api.konghq.com/v3/portals/{portalId}/email-delivery

Europe Production region

https://eu.api.konghq.com/v3/portals/{portalId}/email-delivery

Australia Production region

https://au.api.konghq.com/v3/portals/{portalId}/email-delivery

Middle-East Production region

https://me.api.konghq.com/v3/portals/{portalId}/email-delivery

India Production region

https://in.api.konghq.com/v3/portals/{portalId}/email-delivery

Request samples

Payload

Content type

application/json

{"enabled": true,
"from_email": "user@example.com",
"reply_to_email": "user@example.com"
}

Response samples

200
400
401
403
404

Content type

application/json

{"enabled": true,
"from_email": "user@example.com",
"reply_to_email": "user@example.com",
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Delete email delivery

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

portalId

required

string <uuid>

ID of the portal.

Responses

United-States Production region

https://us.api.konghq.com/v3/portals/{portalId}/email-delivery

Europe Production region

https://eu.api.konghq.com/v3/portals/{portalId}/email-delivery

Australia Production region

https://au.api.konghq.com/v3/portals/{portalId}/email-delivery

Middle-East Production region

https://me.api.konghq.com/v3/portals/{portalId}/email-delivery

India Production region

https://in.api.konghq.com/v3/portals/{portalId}/email-delivery

Response samples

401
403
404

Content type

application/problem+json

{"status": 401,
"title": "Unauthorized",
"instance": "kong:trace:8347343766220159418",
"detail": "Unauthorized"
}