Portal (3.0.4)

Download OpenAPI specification:Download

URL: https://cloud.konghq.com

N/A (this description is removed during bundling)

Portal

The API for retrieving details about a single Konnect Portal.

Get Portal Context

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

Returns information about the portal.

Authorizations:

portalAccessTokenNone

Responses

Response samples

Content type

application/json

{"portal_id": "18a9b697-7e68-411b-8e1d-102b261ab18e",
"org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
"basic_auth_enabled": true,
"oidc_auth_enabled": true,
"saml_auth_enabled": true,
"authentication_enabled": true,
"rbac_enabled": true,
"name": "my portal",
"canonical_domain": "portal.example.com"
}

Content

The API for retrieving content for a Konnect Portal.

List Pages

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

Returns a paginated list of pages for the portal. Each page has a slug, title, and content. Public pages will be returned for non-authenticated users, while both private and public pages will be returned for authenticated users.

Authorizations:

portalAccessTokenNone

query Parameters

sort	string Sorts a collection of portal pages. Supported sort attributes are: created_at updated_at slug title visibility
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.
filter[title][eq]	string Example: filter[title][eq]=Good Page Filter by direct equality comparison of the title property with a supplied value.
filter[title]	string Example: filter[title]=Good Page Filter by direct equality comparison (short-hand) of the title property with a supplied value.
filter[title][contains]	string Example: filter[title][contains]=Good Filter by contains comparison of the title property with a supplied substring
filter[slug][eq]	string Example: filter[slug][eq]=good-page Filter by direct equality comparison of the slug property with a supplied value.
filter[slug]	string Example: filter[slug]=good-page Filter by direct equality comparison (short-hand) of the slug property with a supplied value.
filter[slug][contains]	string Example: filter[slug][contains]=good Filter by contains comparison of the slug property with a supplied substring
filter[visibility][eq]	string Enum: "public" "private" Example: filter[visibility][eq]=public Filter by whether the pages returned are public or private. Private pages are only accessible to authenticated users. For authenticated users, results will include both public and private pages if not specified.
filter[visibility]	string Enum: "public" "private" Example: filter[visibility]=private Filter (short-hand) by whether the pages returned are public or private. Private pages are only accessible to authenticated users. For authenticated users, results will include both public and private pages if not specified.

Responses

Response samples

Content type

application/json

{"data": [{"id": "582b9327-3eba-4bfe-9438-6066840dbbca",
"title": "Home",
"slug": "/",
"visibility": "public",
"description": "Welcome page",
"parent_page_id": null,
"children": [ ],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
],
"meta": {"page": {"size": 10,
"total": 1,
"number": 1
}
}
}

Fetch Page

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

Returns a single page for the portal. Each page has a slug, title, and content. Public pages will be returned for non-authenticated users, while both private and public pages will be returned for authenticated users.

Authorizations:

portalAccessTokenNone

path Parameters

pagePath

required

string

Example: %2Fmypage

Targeted page, url-encoded.

Responses

Response samples

Content type

application/json

{"id": "582b9327-3eba-4bfe-9438-6066840dbbca",
"title": "Home",
"slug": "/",
"content": "# Welcome to the Developer Portal",
"visibility": "public",
"parent_page_id": null,
"created_at": "2021-09-01T00:00:00Z",
"updated_at": "2021-09-01T00:00:00Z"
}

List Snippets

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

Returns a paginated list of snippets for the portal. Each snippet has a name, title, and content. Public snippets will be returned for non-authenticated users, while both private and public snippets will be returned for authenticated users.

Authorizations:

portalAccessTokenNone

query Parameters

sort	string Sorts a collection of portal snippets. Supported sort attributes are: created_at updated_at name title visibility
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.
filter[title][eq]	string Example: filter[title][eq]=Good Page Filter by direct equality comparison of the title property with a supplied value.
filter[title]	string Example: filter[title]=Good Page Filter by direct equality comparison (short-hand) of the title property with a supplied value.
filter[title][contains]	string Example: filter[title][contains]=Good Filter by contains comparison of the title property with a supplied substring
filter[name][eq]	string Example: filter[name][eq]=good service Filter by direct equality comparison of the name property with a supplied value.
filter[name]	string Example: filter[name]=good service Filter by direct equality comparison (short-hand) of the name property with a supplied value.
filter[visibility][eq]	string Enum: "public" "private" Example: filter[visibility][eq]=public Filter by whether the pages returned are public or private. Private pages are only accessible to authenticated users. For authenticated users, results will include both public and private pages if not specified.
filter[visibility]	string Enum: "public" "private" Example: filter[visibility]=private Filter (short-hand) by whether the pages returned are public or private. Private pages are only accessible to authenticated users. For authenticated users, results will include both public and private pages if not specified.

Responses

Response samples

Content type

application/json

{"data": [{"id": "582b9327-3eba-4bfe-9438-6066840dbbca",
"title": "Home",
"name": "snip1",
"visibility": "public",
"description": "Welcome snippet",
"created_at": "2021-09-01T00:00:00Z",
"updated_at": "2021-09-01T00:00:00Z"
}
],
"meta": {"page": {"size": 10,
"total": 1,
"number": 1
}
}
}

Fetch Snippet

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

Returns a single snippet for the portal. Each snippet has a name, title, and content. Public snippets will be returned for non-authenticated users, while both private and public snippets will be returned for authenticated users.

Authorizations:

portalAccessTokenNone

path Parameters

snippetName

required

string

Example: mysnippet

Targeted snippet, url-encoded. Must not start with /.

Responses

Response samples

Content type

application/json

{"id": "582b9327-3eba-4bfe-9438-6066840dbbca",
"title": "Home",
"name": "snip1",
"content": "# Welcome to the Developer Portal",
"visibility": "public",
"created_at": "2021-09-01T00:00:00Z",
"updated_at": "2021-09-01T00:00:00Z"
}

Settings

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

Returns the portal's custom settings.

Authorizations:

None

Responses

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"
}

Logo Asset

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

Gets logo of the developer portal.

Authorizations:

None

Responses

Favicon Asset

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

Gets favicon of the developer portal.

Authorizations:

None