Gravitee

Gravitee API Ratings API

The API Ratings API from Gravitee — 12 operation(s) for api ratings.

GitHub OpenAPI

Operations 16

GET /organizations/{orgId}/environments/{envId}/apis/{api}/ratings List ratings for an API #
POST /organizations/{orgId}/environments/{envId}/apis/{api}/ratings Create a new rating for an API #
GET /organizations/{orgId}/environments/{envId}/apis/{api}/ratings/current Retrieve current rating for an API provided by the authenticated user #
GET /organizations/{orgId}/environments/{envId}/apis/{api}/ratings/summary Get the rating summary for an API #
PUT /organizations/{orgId}/environments/{envId}/apis/{api}/ratings/{rating} Update an existing rating for an API #
DELETE /organizations/{orgId}/environments/{envId}/apis/{api}/ratings/{rating} Delete an existing rating for an API #
POST /organizations/{orgId}/environments/{envId}/apis/{api}/ratings/{rating}/answers Create an answer to a rating for an API #
DELETE /organizations/{orgId}/environments/{envId}/apis/{api}/ratings/{rating}/answers/{answer} Delete an answer to a rating for an API #
GET /organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings List ratings for an API #
POST /organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings Create a new rating for an API #
GET /organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings/current Retrieve current rating for an API provided by the authenticated user #
GET /organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings/summary Get the rating summary for an API #
PUT /organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings/{rating} Update an existing rating for an API #
DELETE /organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings/{rating} Delete an existing rating for an API #
POST /organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings/{rating}/answers Create an answer to a rating for an API #
DELETE /organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings/{rating}/answers/{answer} Delete an answer to a rating for an API #

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-api-ratings-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-api-ratings-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-api-ratings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Gravitee.io - Management API Ratings 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: API Ratings
paths:
  /organizations/{orgId}/environments/{envId}/apis/{api}/ratings:
    get:
      tags:
      - API Ratings
      summary: List ratings for an API
      operationId: getApiRating
      parameters:
      - name: pageNumber
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      - name: pageSize
        in: query
        schema:
          type: integer
          format: int32
      - name: api
        in: path
        description: The ID of the API
        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:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageRatingEntity'
    post:
      tags:
      - API Ratings
      summary: Create a new rating for an API
      description: User must have the API_RATING[CREATE] permission to use this service
      operationId: createApiRating
      parameters:
      - name: api
        in: path
        description: The ID of the API
        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/NewRatingEntity'
        required: true
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingEntity'
  /organizations/{orgId}/environments/{envId}/apis/{api}/ratings/current:
    get:
      tags:
      - API Ratings
      summary: Retrieve current rating for an API provided by the authenticated user
      operationId: getApiRatingByApiAndUser
      parameters:
      - name: api
        in: path
        description: The ID of the API
        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:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingEntity'
  /organizations/{orgId}/environments/{envId}/apis/{api}/ratings/summary:
    get:
      tags:
      - API Ratings
      summary: Get the rating summary for an API
      operationId: getApiRatingSummaryByApi
      parameters:
      - name: api
        in: path
        description: The ID of the API
        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:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingSummaryEntity'
  /organizations/{orgId}/environments/{envId}/apis/{api}/ratings/{rating}:
    put:
      tags:
      - API Ratings
      summary: Update an existing rating for an API
      description: User must have the API_RATING[UPDATE] permission to use this service
      operationId: updateApiRating
      parameters:
      - name: rating
        in: path
        required: true
        schema:
          type: string
      - name: api
        in: path
        description: The ID of the API
        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/UpdateRatingEntity'
        required: true
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingEntity'
    delete:
      tags:
      - API Ratings
      summary: Delete an existing rating for an API
      description: User must have the API_RATING[DELETE] permission to use this service
      operationId: deleteApiRating
      parameters:
      - name: rating
        in: path
        required: true
        schema:
          type: string
      - name: api
        in: path
        description: The ID of the API
        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:
        default:
          description: default response
          content:
            '*/*': {}
  /organizations/{orgId}/environments/{envId}/apis/{api}/ratings/{rating}/answers:
    post:
      tags:
      - API Ratings
      summary: Create an answer to a rating for an API
      description: User must have the API_RATING_ANSWER[CREATE] permission to use this service
      operationId: createApiRatingAnswer
      parameters:
      - name: rating
        in: path
        required: true
        schema:
          type: string
      - name: api
        in: path
        description: The ID of the API
        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/NewRatingAnswerEntity'
        required: true
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingEntity'
  /organizations/{orgId}/environments/{envId}/apis/{api}/ratings/{rating}/answers/{answer}:
    delete:
      tags:
      - API Ratings
      summary: Delete an answer to a rating for an API
      description: User must have the API_RATING_ANSWER[DELETE] permission to use this service
      operationId: deleteApiRatingAnswer
      parameters:
      - name: rating
        in: path
        required: true
        schema:
          type: string
      - name: answer
        in: path
        required: true
        schema:
          type: string
      - name: api
        in: path
        description: The ID of the API
        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:
        default:
          description: default response
          content:
            '*/*': {}
  /organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings:
    get:
      tags:
      - API Ratings
      summary: List ratings for an API
      operationId: getApiRating_1
      parameters:
      - name: pageNumber
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      - name: pageSize
        in: query
        schema:
          type: integer
          format: int32
      - name: api
        in: path
        description: The ID of the API
        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:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageRatingEntity'
    post:
      tags:
      - API Ratings
      summary: Create a new rating for an API
      description: User must have the API_RATING[CREATE] permission to use this service
      operationId: createApiRating_1
      parameters:
      - name: api
        in: path
        description: The ID of the API
        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/NewRatingEntity'
        required: true
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingEntity'
  /organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings/current:
    get:
      tags:
      - API Ratings
      summary: Retrieve current rating for an API provided by the authenticated user
      operationId: getApiRatingByApiAndUser_1
      parameters:
      - name: api
        in: path
        description: The ID of the API
        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:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingEntity'
  /organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings/summary:
    get:
      tags:
      - API Ratings
      summary: Get the rating summary for an API
      operationId: getApiRatingSummaryByApi_1
      parameters:
      - name: api
        in: path
        description: The ID of the API
        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:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingSummaryEntity'
  /organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings/{rating}:
    put:
      tags:
      - API Ratings
      summary: Update an existing rating for an API
      description: User must have the API_RATING[UPDATE] permission to use this service
      operationId: updateApiRating_1
      parameters:
      - name: rating
        in: path
        required: true
        schema:
          type: string
      - name: api
        in: path
        description: The ID of the API
        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/UpdateRatingEntity'
        required: true
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingEntity'
    delete:
      tags:
      - API Ratings
      summary: Delete an existing rating for an API
      description: User must have the API_RATING[DELETE] permission to use this service
      operationId: deleteApiRating_1
      parameters:
      - name: rating
        in: path
        required: true
        schema:
          type: string
      - name: api
        in: path
        description: The ID of the API
        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:
        default:
          description: default response
          content:
            '*/*': {}
  /organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings/{rating}/answers:
    post:
      tags:
      - API Ratings
      summary: Create an answer to a rating for an API
      description: User must have the API_RATING_ANSWER[CREATE] permission to use this service
      operationId: createApiRatingAnswer_1
      parameters:
      - name: rating
        in: path
        required: true
        schema:
          type: string
      - name: api
        in: path
        description: The ID of the API
        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/NewRatingAnswerEntity'
        required: true
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingEntity'
  /organizations/{orgId}/environments/{envId}/v4/apis/{api}/ratings/{rating}/answers/{answer}:
    delete:
      tags:
      - API Ratings
      summary: Delete an answer to a rating for an API
      description: User must have the API_RATING_ANSWER[DELETE] permission to use this service
      operationId: deleteApiRatingAnswer_1
      parameters:
      - name: rating
        in: path
        required: true
        schema:
          type: string
      - name: answer
        in: path
        required: true
        schema:
          type: string
      - name: api
        in: path
        description: The ID of the API
        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:
        default:
          description: default response
          content:
            '*/*': {}
components:
  schemas:
    RatingAnswerEntity:
      type: object
      properties:
        comment:
          type: string
        createdAt:
          type: string
          format: date-time
        id:
          type: string
        user:
          type: string
        userDisplayName:
          type: string
    NewRatingEntity:
      type: object
      properties:
        api:
          type: string
        comment:
          maxLength: 1024
          minLength: 0
          type: string
        rate:
          type: string
          format: byte
        title:
          maxLength: 64
          minLength: 0
          type: string
    PageRatingEntity:
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/RatingEntity'
        pageElements:
          type: integer
          format: int64
        pageNumber:
          type: integer
          format: int32
        totalElements:
          type: integer
          format: int64
    RatingSummaryEntity:
      type: object
      properties:
        api:
          type: string
        averageRate:
          type: number
          format: double
        numberOfRatings:
          type: integer
          format: int32
        numberOfRatingsByRate:
          type: object
          additionalProperties:
            type: integer
            format: int64
    RatingEntity:
      type: object
      properties:
        answers:
          type: array
          items:
            $ref: '#/components/schemas/RatingAnswerEntity'
        api:
          type: string
        comment:
          type: string
        createdAt:
          type: string
          format: date-time
        id:
          type: string
        rate:
          type: string
          format: byte
        title:
          type: string
        updatedAt:
          type: string
          format: date-time
        user:
          type: string
        userDisplayName:
          type: string
    NewRatingAnswerEntity:
      type: object
      properties:
        comment:
          maxLength: 1024
          minLength: 0
          type: string
        ratingId:
          type: string
    UpdateRatingEntity:
      type: object
      properties:
        api:
          type: string
        comment:
          maxLength: 1024
          minLength: 0
          type: string
        id:
          type: string
        rate:
          type: string
          format: byte
        title:
          maxLength: 64
          minLength: 0
          type: string
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: basic