Gravitee

Gravitee Entry Points API

The Entry Points API from Gravitee — 6 operation(s) for entry points.

GitHub OpenAPI

Operations 15

GET /organizations/{organizationId}/entrypoints List entrypoints #
POST /organizations/{organizationId}/entrypoints Create a entrypoint #
GET /organizations/{organizationId}/entrypoints/{entrypointId} Get a sharding entrypoint #
PUT /organizations/{organizationId}/entrypoints/{entrypointId} Update the sharding entrypoint #
DELETE /organizations/{organizationId}/entrypoints/{entrypointId} Delete the sharding entrypoint #
GET /organizations/{orgId}/configuration/entrypoints List the platform entrypoints #
PUT /organizations/{orgId}/configuration/entrypoints Update a platform entrypoint #
POST /organizations/{orgId}/configuration/entrypoints Create a platform entrypoint #
GET /organizations/{orgId}/configuration/entrypoints/{entrypoint} Get a platform entrypoints #
DELETE /organizations/{orgId}/configuration/entrypoints/{entrypoint} Delete a platform entrypoint #
GET /organizations/{orgId}/environments/{envId}/configuration/entrypoints List the platform entrypoints #
PUT /organizations/{orgId}/environments/{envId}/configuration/entrypoints Update a platform entrypoint #
POST /organizations/{orgId}/environments/{envId}/configuration/entrypoints Create a platform entrypoint #
GET /organizations/{orgId}/environments/{envId}/configuration/entrypoints/{entrypoint} Get a platform entrypoints #
DELETE /organizations/{orgId}/environments/{envId}/configuration/entrypoints/{entrypoint} Delete a platform entrypoint #

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-entry-points-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-entry-points-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-entry-points-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Gravitee Entrypoints API
  version: '1.0'
  description: 'Operations tagged entrypoints across 2 of this provider''s published API definitions: gravitee-am-openapi.yml, gravitee-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /management
- url: http://localhost:8083/management
security:
- gravitee-auth: []
tags:
- name: Entry Points
paths:
  /organizations/{organizationId}/entrypoints:
    get:
      tags:
      - Entry Points
      summary: List entrypoints
      description: User must have the ORGANIZATION[LIST] permission on the specified organization. Each returned entrypoint is filtered and contains only basic information such as id and name.
      operationId: listEntrypoints
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List all the entrypoints
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Entrypoint'
        '500':
          description: Internal server error
    post:
      tags:
      - Entry Points
      summary: Create a entrypoint
      description: User must have the ORGANIZATION_ENTRYPOINT[CREATE] permission on the specified organization
      operationId: createEntrypoint
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewEntrypoint'
        required: true
      responses:
        '201':
          description: Entrypoint successfully created
        '500':
          description: Internal server error
    servers:
    - url: /management
  /organizations/{organizationId}/entrypoints/{entrypointId}:
    get:
      tags:
      - Entry Points
      summary: Get a sharding entrypoint
      description: User must have the ORGANIZATION_ENTRYPOINT[READ] permission on the specified organization
      operationId: getEntrypoint
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: entrypointId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Sharding entrypoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Entrypoint'
        '500':
          description: Internal server error
    put:
      tags:
      - Entry Points
      summary: Update the sharding entrypoint
      description: User must have the ORGANIZATION_ENTRYPOINT[UPDATE] permission on the specified organization
      operationId: updateEntrypoint
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: entrypointId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEntrypoint'
        required: true
      responses:
        '200':
          description: Sharding entrypoint successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Entrypoint'
        '500':
          description: Internal server error
    delete:
      tags:
      - Entry Points
      summary: Delete the sharding entrypoint
      description: User must have the ORGANIZATION_ENTRYPOINT[DELETE] permission on the specified organization
      operationId: deleteEntrypoint
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: entrypointId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Sharding entrypoint successfully deleted
        '500':
          description: Internal server error
    servers:
    - url: /management
  /organizations/{orgId}/configuration/entrypoints:
    get:
      tags:
      - Entry Points
      summary: List the platform entrypoints
      description: User must have the MANAGEMENT_ENTRYPOINT[READ] permission to use this service
      operationId: getEntrypoints
      parameters:
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: List of platform entrypoints
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EntrypointEntity'
        '500':
          description: Internal server error
    put:
      tags:
      - Entry Points
      summary: Update a platform entrypoint
      description: User must have the MANAGEMENT_ENTRYPOINT[UPDATE] permission to use this service
      operationId: putOrganizationsByOrgIdConfigurationEntrypoints
      parameters:
      - 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/UpdateEntryPointEntity'
        required: true
      responses:
        '200':
          description: Updated entrypoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntrypointEntity'
        '500':
          description: Internal server error
      x-operation-id-source: normalized
      x-operation-id-original: updateEntrypoint
    post:
      tags:
      - Entry Points
      summary: Create a platform entrypoint
      description: User must have the MANAGEMENT_ENTRYPOINT[CREATE] permission to use this service
      operationId: postOrganizationsByOrgIdConfigurationEntrypoints
      parameters:
      - 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/NewEntryPointEntity'
        required: true
      responses:
        '201':
          description: Entrypoint successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntrypointEntity'
        '500':
          description: Internal server error
      x-operation-id-source: normalized
      x-operation-id-original: createEntrypoint
    servers:
    - url: http://localhost:8083/management
  /organizations/{orgId}/configuration/entrypoints/{entrypoint}:
    get:
      tags:
      - Entry Points
      summary: Get a platform entrypoints
      description: User must have the MANAGEMENT_ENTRYPOINT[READ] permission to use this service
      operationId: getOrganizationsByOrgIdConfigurationEntrypointsByEntrypoint
      parameters:
      - name: entrypoint
        in: path
        required: true
        schema:
          type: string
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: A platform entrypoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntrypointEntity'
        '404':
          description: Entrypoint not found
        '500':
          description: Internal server error
      x-operation-id-source: normalized
      x-operation-id-original: getEntrypoint
    delete:
      tags:
      - Entry Points
      summary: Delete a platform entrypoint
      description: User must have the MANAGEMENT_ENTRYPOINT[DELETE] permission to use this service
      operationId: deleteOrganizationsByOrgIdConfigurationEntrypointsByEntrypoint
      parameters:
      - name: entrypoint
        in: path
        required: true
        schema:
          type: string
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '204':
          description: Entrrypoint successfully deleted
        '500':
          description: Internal server error
      x-operation-id-source: normalized
      x-operation-id-original: deleteEntrypoint
    servers:
    - url: http://localhost:8083/management
  /organizations/{orgId}/environments/{envId}/configuration/entrypoints:
    get:
      tags:
      - Entry Points
      summary: List the platform entrypoints
      description: User must have the MANAGEMENT_ENTRYPOINT[READ] permission to use this service
      operationId: getEntrypoints_1
      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
      responses:
        '200':
          description: List of platform entrypoints
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EntrypointEntity'
        '500':
          description: Internal server error
    put:
      tags:
      - Entry Points
      summary: Update a platform entrypoint
      description: User must have the MANAGEMENT_ENTRYPOINT[UPDATE] permission to use this service
      operationId: updateEntrypoint_1
      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/UpdateEntryPointEntity'
        required: true
      responses:
        '200':
          description: Updated entrypoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntrypointEntity'
        '500':
          description: Internal server error
    post:
      tags:
      - Entry Points
      summary: Create a platform entrypoint
      description: User must have the MANAGEMENT_ENTRYPOINT[CREATE] permission to use this service
      operationId: createEntrypoint_1
      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/NewEntryPointEntity'
        required: true
      responses:
        '201':
          description: Entrypoint successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntrypointEntity'
        '500':
          description: Internal server error
    servers:
    - url: http://localhost:8083/management
  /organizations/{orgId}/environments/{envId}/configuration/entrypoints/{entrypoint}:
    get:
      tags:
      - Entry Points
      summary: Get a platform entrypoints
      description: User must have the MANAGEMENT_ENTRYPOINT[READ] permission to use this service
      operationId: getEntrypoint_1
      parameters:
      - name: entrypoint
        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: A platform entrypoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntrypointEntity'
        '404':
          description: Entrypoint not found
        '500':
          description: Internal server error
    delete:
      tags:
      - Entry Points
      summary: Delete a platform entrypoint
      description: User must have the MANAGEMENT_ENTRYPOINT[DELETE] permission to use this service
      operationId: deleteEntrypoint_1
      parameters:
      - name: entrypoint
        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: Entrrypoint successfully deleted
        '500':
          description: Internal server error
    servers:
    - url: http://localhost:8083/management
components:
  schemas:
    UpdateEntrypoint:
      required:
      - name
      - tags
      - url
      type: object
      properties:
        description:
          type: string
        name:
          type: string
        tags:
          type: array
          items:
            type: string
        url:
          type: string
    Entrypoint:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
        defaultEntrypoint:
          type: boolean
        description:
          type: string
        id:
          type: string
        name:
          type: string
        organizationId:
          type: string
        tags:
          type: array
          items:
            type: string
        updatedAt:
          type: string
          format: date-time
        url:
          type: string
    NewEntrypoint:
      required:
      - name
      - tags
      - url
      type: object
      properties:
        description:
          type: string
        name:
          type: string
        tags:
          type: array
          items:
            type: string
        url:
          type: string
    NewEntryPointEntity:
      required:
      - tags
      - value
      type: object
      properties:
        tags:
          maxItems: 2147483647
          minItems: 1
          type: array
          items:
            type: string
        value:
          maxLength: 2147483647
          minLength: 1
          type: string
    EntrypointEntity:
      type: object
      properties:
        id:
          type: string
        tags:
          type: array
          items:
            type: string
        value:
          type: string
    UpdateEntryPointEntity:
      required:
      - tags
      - value
      type: object
      properties:
        id:
          type: string
        tags:
          maxItems: 2147483647
          minItems: 1
          type: array
          items:
            type: string
        value:
          maxLength: 2147483647
          minLength: 1
          type: string
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: Bearer
x-refined-from:
- gravitee-am-openapi.yml
- gravitee-openapi.json