Gravitee

Gravitee Categories API

The Categories API from Gravitee — 4 operation(s) for categories.

GitHub OpenAPI

Operations 8

GET /organizations/{orgId}/environments/{envId}/configuration/categories Retrieve list of categories #
PUT /organizations/{orgId}/environments/{envId}/configuration/categories Update an existing category #
POST /organizations/{orgId}/environments/{envId}/configuration/categories Create a category #
GET /organizations/{orgId}/environments/{envId}/configuration/categories/{categoryId} Get the category #
PUT /organizations/{orgId}/environments/{envId}/configuration/categories/{categoryId} Update the category #
DELETE /organizations/{orgId}/environments/{envId}/configuration/categories/{categoryId} Delete the category #
GET /organizations/{orgId}/environments/{envId}/configuration/categories/{categoryId}/background Get the Category's background #
GET /organizations/{orgId}/environments/{envId}/configuration/categories/{categoryId}/picture Get the category's picture #

Documentation

📖
Documentation
https://documentation.gravitee.io/apim
📖
GettingStarted
https://documentation.gravitee.io/apim/getting-started
📖
RateLimits
https://artifacts.apis.io/gravitee/rate-limits/gravitee-rate-limits.yml
📖
Documentation
https://documentation.gravitee.io/am

Specifications

⚙
OpenAPI
https://artifacts.apis.io/gravitee/openapi/gravitee-categories-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/gravitee-io/gravitee-api-management
📦
GitHubRepository
https://github.com/gravitee-io/gravitee-access-management

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/gravitee/json-schema/gravitee-api-schema.json
📊
JSONSchema
https://artifacts.apis.io/gravitee/json-schema/gravitee-plan-schema.json
📊
JSONSchema
https://artifacts.apis.io/gravitee/json-schema/gravitee-domain-schema.json

Other Resources

🔗
ChangeLog
https://documentation.gravitee.io/apim/release-information/changelog
🔗
License
https://github.com/gravitee-io/gravitee-api-management/blob/master/LICENSE.txt
🔗
SDKs
https://github.com/gravitee-io/gravitee-clients-sdk
🔗
SDKs
https://github.com/gravitee-io/terraform-provider-apim
🔗
CLI
https://github.com/gravitee-io/graviteeio-cli
🔗
KubernetesOperator
https://github.com/gravitee-io/gravitee-kubernetes-operator
🔗
HelmChart
https://github.com/gravitee-io/helm-charts
🔗
DockerImage
https://hub.docker.com/r/graviteeio/apim-gateway
🔗
JSONLDContext
https://artifacts.apis.io/gravitee/json-ld/gravitee-context.jsonld
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_apidefinitions.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_apiv4definitions.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_apiresources.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_applications.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_subscriptions.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_managementcontexts.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_sharedpolicygroups.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_groups.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_notifications.yaml
🔗
Plans
https://artifacts.apis.io/gravitee/plans/gravitee-plans-pricing.yml
🔗
FinOps
https://artifacts.apis.io/gravitee/finops/gravitee-finops.yml
🔗
Reference
https://documentation.gravitee.io/am/reference/am-api-reference
🔗
ChangeLog
https://documentation.gravitee.io/am/releases-and-changelog/release-notes
🔗
License
https://github.com/gravitee-io/gravitee-access-management/blob/master/LICENSE
🔗
SDKs
https://github.com/gravitee-io/gravitee-access-management/tree/master/gravitee-am-management-api-sdk-java
🔗
HelmChart
https://github.com/gravitee-io/helm-charts/tree/master/helm/gravitee-am
🔗
DockerImage
https://hub.docker.com/r/graviteeio/am-gateway

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gravitee:gravitee-categories-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gravitee-categories-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Gravitee.io - Management Categories API
  description: Some news resources are in alpha version. This implies that they are likely to be modified or even removed in future versions. They are marked with the 🧪 symbol
  version: 3.20.0
servers:
- url: http://localhost:8083/management
security:
- gravitee-auth: []
tags:
- name: Categories
paths:
  /organizations/{orgId}/environments/{envId}/configuration/categories:
    get:
      tags:
      - Categories
      summary: Retrieve list of categories
      operationId: getCategories
      parameters:
      - name: include
        in: query
        schema:
          type: array
          items:
            type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CategoryEntity'
    put:
      tags:
      - Categories
      summary: Update an existing category
      description: User must have the PORTAL_CATEGORY[UPDATE] permission to use this service
      operationId: updateCategories
      parameters:
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UpdateCategoryEntity'
        required: true
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CategoryEntity'
    post:
      tags:
      - Categories
      summary: Create a category
      description: User must have the PORTAL_CATEGORY[CREATE] permission to use this service
      operationId: createCategory
      parameters:
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewCategoryEntity'
        required: true
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryEntity'
  /organizations/{orgId}/environments/{envId}/configuration/categories/{categoryId}:
    get:
      tags:
      - Categories
      summary: Get the category
      description: User must have the PORTAL_CATEGORY[READ] permission to use this service
      operationId: getCategory
      parameters:
      - name: categoryId
        in: path
        required: true
        schema:
          type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: Category's definition
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryEntity'
        '500':
          description: Internal server error
    put:
      tags:
      - Categories
      summary: Update the category
      description: User must have the PORTAL_CATEGORY[UPDATE] permission to use this service
      operationId: updateCategory
      parameters:
      - name: categoryId
        in: path
        required: true
        schema:
          type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCategoryEntity'
        required: true
      responses:
        '200':
          description: Category successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryEntity'
        '500':
          description: Internal server error
    delete:
      tags:
      - Categories
      summary: Delete the category
      description: User must have the PORTAL_CATEGORY[DELETE] permission to use this service
      operationId: deleteCategory
      parameters:
      - name: categoryId
        in: path
        required: true
        schema:
          type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '204':
          description: Category successfully deleted
        '500':
          description: Internal server error
  /organizations/{orgId}/environments/{envId}/configuration/categories/{categoryId}/background:
    get:
      tags:
      - Categories
      summary: Get the Category's background
      description: User must have the READ permission to use this service
      operationId: getCategoryBackground
      parameters:
      - name: categoryId
        in: path
        required: true
        schema:
          type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: Category's background
          content:
            '*/*':
              schema:
                type: string
                format: binary
        '500':
          description: Internal server error
  /organizations/{orgId}/environments/{envId}/configuration/categories/{categoryId}/picture:
    get:
      tags:
      - Categories
      summary: Get the category's picture
      description: User must have the PORTAL_CATEGORY[READ] permission to use this service
      operationId: getCategoryPicture
      parameters:
      - name: categoryId
        in: path
        required: true
        schema:
          type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: Category's picture
          content:
            '*/*':
              schema:
                type: string
                format: binary
        '500':
          description: Internal server error
components:
  schemas:
    CategoryEntity:
      required:
      - name
      type: object
      properties:
        background:
          type: string
        background_url:
          type: string
        createdAt:
          type: string
          format: date-time
        description:
          type: string
        hidden:
          type: boolean
        highlightApi:
          type: string
        id:
          type: string
        key:
          type: string
        name:
          maxLength: 2147483647
          minLength: 1
          type: string
        order:
          type: integer
          format: int32
        page:
          type: string
        picture:
          type: string
        picture_url:
          type: string
        totalApis:
          type: integer
          format: int64
        updatedAt:
          type: string
          format: date-time
    NewCategoryEntity:
      required:
      - name
      type: object
      properties:
        background:
          type: string
        description:
          type: string
        hidden:
          type: boolean
        highlightApi:
          type: string
        name:
          maxLength: 2147483647
          minLength: 1
          type: string
        order:
          type: integer
          format: int32
        page:
          type: string
        picture:
          type: string
    UpdateCategoryEntity:
      required:
      - name
      type: object
      properties:
        background:
          type: string
        defaultCategory:
          type: boolean
        description:
          type: string
        hidden:
          type: boolean
        highlightApi:
          type: string
        id:
          type: string
        name:
          maxLength: 2147483647
          minLength: 1
          type: string
        order:
          type: integer
          format: int32
        page:
          type: string
        picture:
          type: string
        picture_url:
          type: string
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: basic