Sign in
Portals

List Portals

Lists developer portals defined in this region for this organization. Each developer portal is available at a unique address and has isolated appearance, configuration, developers, and applications.

get/v2/portals#classic

Query parameters

page[size]integer
Example:100

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

page[number]integer
Example:1

Determines which page of the entities to retrieve.

sortstring

Sorts a collection of portals. Supported sort attributes are:

  • name
  • description
  • is_public
  • rbac_enabled
  • auto_approve_applications
  • auto_approve_developers
  • default_domain
  • custom_domain
  • custom_client_domain
  • created_at
  • updated_at

Response

A paginated list of portals in the current region of an organization.

Example response

{
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 1
    }
  },
  "data": [
    {
      "id": "8f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
      "created_at": "2022-02-07T17:46:57.52Z",
      "updated_at": "2022-10-08T17:00:00.52Z",
      "name": "Portal A",
      "display_name": "Developer Portal A",
      "description": "The Portal A",
      "default_domain": "123455678abcd.us.portal.konghq.com",
      "is_public": false,
      "rbac_enabled": true,
      "auto_approve_applications": false,
      "auto_approve_developers": true,
      "custom_domain": "api.example.com",
      "custom_client_domain": "portal.example.com",
      "application_count": 0,
      "developer_count": 0,
      "published_product_count": 0
    }
  ]
}

Changes

Changed in 3 of the 52 revisions of this API.1011

  • 19e869275e281See the full diff
    • ●

      added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 96118a9cd7f410See the full diff
    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property data/items/labels/additionalProperties/ became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property detail became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property instance became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property status became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property title became nullable for the status 401

      response-property-became-nullable

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ab1a51b761441See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog