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 configuration, customization, developers, and applications.

get/v3/portals

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
  • authentication_enabled
  • rbac_enabled
  • auto_approve_applications
  • auto_approve_developers
  • default_domain
  • canonical_domain
  • created_at
  • updated_at
authentication_enabledboolean

Filter by a boolean value (true/false).

rbac_enabledboolean

Filter by a boolean value (true/false).

auto_approve_developersboolean

Filter by a boolean value (true/false).

auto_approve_applicationsboolean

Filter by a boolean value (true/false).

Filter portals returned in the response.

Response

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

Example response

{
  "data": [
    {
      "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
      "created_at": "2022-11-04T20:10:06.927Z",
      "updated_at": "2022-11-04T20:10:06.927Z",
      "sipr_enabled": true,
      "labels": {
        "env": "test"
      }
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  }
}

Changes

Changed in 7 of the 29 revisions of this API.26

  • 658ffb748f9511See the full diff
    • ●

      removed the optional property data/items/mcp_server_enabled from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property data/items/ai to the response with the 200 status

      response-optional-property-added

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

  • 5536690850b51See the full diff
    • ○

      added the optional property data/items/mcp_server_enabled to the response with the 200 status

      response-optional-property-added

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

  • be4c4e09af621See the full diff
    • ○

      added the optional property data/items/notifications_developer_pii_visibility_enabled to the response with the 200 status

      response-optional-property-added

  • 55d91b8ceecd1See the full diff
    • ○

      the sipr_enabled response's property default value false was added for the status 200

      response-property-default-value-added

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

  • 106b373707f31See the full diff
    • ○

      added the required property data/items/sipr_enabled to the response with the 200 status

      response-required-property-added

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

  • 5d2b35832e3f1See 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 57 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ecce2daf9de61See the full diff
    • ○

      endpoint added

      endpoint-added