GRgravitee-io
Portal Categories

Create a portal category

Changed on

User must have the ENVIRONMENT_DOCUMENTATION[create] permission.

post/portal-categories

Request

  • Base URL
    /management/v2/environments/DEFAULT (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /management/v2/environments/DEFAULT/portal-categories
  • Auth
    • HTTP basic
    • or API key in cookie Auth-Graviteeio-APIM

Request body

titlestring required

The title of the portal category

descriptionstring

The description of the portal category

visibleboolean

Whether the portal category is visible on the portal

Example request

{
  "title": "Weather",
  "description": "APIs related to weather forecasts",
  "visible": true
}

Response

Portal category created

idstring uuid required

The unique ID of the portal category

titlestring required

The title of the portal category

descriptionstring

The description of the portal category

visibleboolean

Whether the portal category is visible on the portal

Example response

{
  "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "title": "Weather",
  "description": "APIs related to weather forecasts",
  "visible": true
}

Changes