Portal Management (2.2.0)

Download OpenAPI specification:Download

URL: https://konghq.com

The management API for Portals

Portals

APIs related to Configuration of Konnect Developer Portals.

Get a portal configuration

Get the configuration of the portal

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

portalId

required

string <uuid>

ID of the portal.

Responses

United-States Production region

https://us.api.konghq.com/v2/portals/{portalId}/config

Europe Production region

https://eu.api.konghq.com/v2/portals/{portalId}/config

Australia Production region

https://au.api.konghq.com/v2/portals/{portalId}/config

Middle-East Production region

https://me.api.konghq.com/v2/portals/{portalId}/config

India Production region

https://in.api.konghq.com/v2/portals/{portalId}/config

Response samples

Content type

application/json

{"data": {"header": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
],
"footer_sections": [{"title": "string",
"items": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
}
],
"footer_bottom": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
}
}

Replace a portal configuration

Update the configuration of the portal

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

portalId

required

string <uuid>

ID of the portal.

Request Body schema: application/json

required

object

Responses

United-States Production region

https://us.api.konghq.com/v2/portals/{portalId}/config

Europe Production region

https://eu.api.konghq.com/v2/portals/{portalId}/config

Australia Production region

https://au.api.konghq.com/v2/portals/{portalId}/config

Middle-East Production region

https://me.api.konghq.com/v2/portals/{portalId}/config

India Production region

https://in.api.konghq.com/v2/portals/{portalId}/config

Request samples

Payload

Content type

application/json

{"data": {"header": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
],
"footer_sections": [{"title": "string",
"items": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
}
],
"footer_bottom": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
}
}

Response samples

Content type

application/json

{"data": {"header": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
],
"footer_sections": [{"title": "string",
"items": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
}
],
"footer_bottom": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
}
}

Update a portal configuration

Update the configuration of the portal

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

portalId

required

string <uuid>

ID of the portal.

Request Body schema: application/json

Request schema to replace the portal configuration.

required

object

Responses

United-States Production region

https://us.api.konghq.com/v2/portals/{portalId}/config

Europe Production region

https://eu.api.konghq.com/v2/portals/{portalId}/config

Australia Production region

https://au.api.konghq.com/v2/portals/{portalId}/config

Middle-East Production region

https://me.api.konghq.com/v2/portals/{portalId}/config

India Production region

https://in.api.konghq.com/v2/portals/{portalId}/config

Request samples

Payload

Content type

application/json

{"data": {"header": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
],
"footer_sections": [{"title": "string",
"items": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
}
],
"footer_bottom": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
}
}

Response samples

Content type

application/json

{"data": {"header": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
],
"footer_sections": [{"title": "string",
"items": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
}
],
"footer_bottom": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
}
}

Portal Customization

APIs related to Konnect Developer Portal Customization.

Get Customization

Returns the portal customization options.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

portalId

required

string <uuid>

ID of the portal.

Responses

United-States Production region

https://us.api.konghq.com/v2/portals/{portalId}/customization

Europe Production region

https://eu.api.konghq.com/v2/portals/{portalId}/customization

Australia Production region

https://au.api.konghq.com/v2/portals/{portalId}/customization

Middle-East Production region

https://me.api.konghq.com/v2/portals/{portalId}/customization

India Production region

https://in.api.konghq.com/v2/portals/{portalId}/customization

Response samples

Content type

application/json

{"theme": {"name": "string",
"mode": "light",
"colors": {"primary": "#000000"
}
},
"layout": "string",
"css": "string",
"js": {"custom": "string",
"scripts": ["string"
]
},
"menu": {"main": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
],
"footer_sections": [{"title": "string",
"items": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
}
],
"footer_bottom": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
},
"spec_renderer": {"try_it_ui": true,
"try_it_insomnia": true,
"infinite_scroll": true,
"show_schemas": true
},
"robots": "string"
}

Replace Customization

Replace the portal customization options.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

portalId

required

string <uuid>

ID of the portal.

Request Body schema: application/json

	object
layout	string
css	string or null
	object
	object
	object
robots	string or null

Responses

United-States Production region

https://us.api.konghq.com/v2/portals/{portalId}/customization

Europe Production region

https://eu.api.konghq.com/v2/portals/{portalId}/customization

Australia Production region

https://au.api.konghq.com/v2/portals/{portalId}/customization

Middle-East Production region

https://me.api.konghq.com/v2/portals/{portalId}/customization

India Production region

https://in.api.konghq.com/v2/portals/{portalId}/customization

Request samples

Payload

Content type

application/json

{"theme": {"name": "string",
"mode": "light",
"colors": {"primary": "#000000"
}
},
"layout": "string",
"css": "string",
"js": {"custom": "string",
"scripts": ["string"
]
},
"menu": {"main": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
],
"footer_sections": [{"title": "string",
"items": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
}
],
"footer_bottom": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
},
"spec_renderer": {"try_it_ui": true,
"try_it_insomnia": true,
"infinite_scroll": true,
"show_schemas": true
},
"robots": "string"
}

Response samples

Content type

application/json

{"theme": {"name": "string",
"mode": "light",
"colors": {"primary": "#000000"
}
},
"layout": "string",
"css": "string",
"js": {"custom": "string",
"scripts": ["string"
]
},
"menu": {"main": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
],
"footer_sections": [{"title": "string",
"items": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
}
],
"footer_bottom": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
},
"spec_renderer": {"try_it_ui": true,
"try_it_insomnia": true,
"infinite_scroll": true,
"show_schemas": true
},
"robots": "string"
}

Update Portal Customization

Update the portal customization options, merging properties.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

portalId

required

string <uuid>

ID of the portal.

Request Body schema: application/json

	object
layout	string
css	string or null
	object
	object
	object
robots	string or null

Responses

United-States Production region

https://us.api.konghq.com/v2/portals/{portalId}/customization

Europe Production region

https://eu.api.konghq.com/v2/portals/{portalId}/customization

Australia Production region

https://au.api.konghq.com/v2/portals/{portalId}/customization

Middle-East Production region

https://me.api.konghq.com/v2/portals/{portalId}/customization

India Production region

https://in.api.konghq.com/v2/portals/{portalId}/customization

Request samples

Payload

Content type

application/json

{"theme": {"name": "string",
"mode": "light",
"colors": {"primary": "#000000"
}
},
"layout": "string",
"css": "string",
"js": {"custom": "string",
"scripts": ["string"
]
},
"menu": {"main": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
],
"footer_sections": [{"title": "string",
"items": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
}
],
"footer_bottom": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
},
"spec_renderer": {"try_it_ui": true,
"try_it_insomnia": true,
"infinite_scroll": true,
"show_schemas": true
},
"robots": "string"
}

Response samples

Content type

application/json

{"theme": {"name": "string",
"mode": "light",
"colors": {"primary": "#000000"
}
},
"layout": "string",
"css": "string",
"js": {"custom": "string",
"scripts": ["string"
]
},
"menu": {"main": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
],
"footer_sections": [{"title": "string",
"items": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
}
],
"footer_bottom": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
},
"spec_renderer": {"try_it_ui": true,
"try_it_insomnia": true,
"infinite_scroll": true,
"show_schemas": true
},
"robots": "string"
}