# Gravitee Configuration API

**Canonical:** https://apis.io/apis/gravitee/gravitee-configuration-api/  
**Provider:** Gravitee — https://apis.io/providers/gravitee/  
**Base URL:** https://cockpit.gravitee.io  
**Documentation:** https://documentation.gravitee.io/cockpit

Gravitee Configuration API is one of 121 APIs that [Gravitee](https://apis.io/providers/gravitee/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 3 JSON Schema definitions. Tagged areas include Configuration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, a changelog, a GitHub repository, rate-limit docs, and 3 JSON Schemas.

The Configuration API from Gravitee — 16 operation(s) for configuration.

## Operations (31)

| Method | Path | Summary |
|---|---|---|
| GET | `/organizations/{orgId}/configuration/identities` | Get the list of identity providers |
| POST | `/organizations/{orgId}/configuration/identities` | Create an identity provider |
| GET | `/organizations/{orgId}/configuration/identities/{identityProvider}` | Get an identity provider |
| PUT | `/organizations/{orgId}/configuration/identities/{identityProvider}` | Update an identity provider |
| DELETE | `/organizations/{orgId}/configuration/identities/{identityProvider}` | Delete an identity provider |
| GET | `/organizations/{orgId}/environments/{envId}/configuration/apiheaders` | List API headers |
| POST | `/organizations/{orgId}/environments/{envId}/configuration/apiheaders` | Create an API header |
| PUT | `/organizations/{orgId}/environments/{envId}/configuration/apiheaders/{id}` | Update an API header |
| DELETE | `/organizations/{orgId}/environments/{envId}/configuration/apiheaders/{id}` | Delete an API header |
| GET | `/organizations/{orgId}/environments/{envId}/configuration/applications/types` | Get the list of enabled application types |
| GET | `/organizations/{orgId}/environments/{envId}/configuration/dictionaries` | Get the list of global dictionaries |
| POST | `/organizations/{orgId}/environments/{envId}/configuration/dictionaries` | Create a dictionary |
| GET | `/organizations/{orgId}/environments/{envId}/configuration/dictionaries/{dictionary}` | Get a dictionary |
| PUT | `/organizations/{orgId}/environments/{envId}/configuration/dictionaries/{dictionary}` | Update a dictionary |
| POST | `/organizations/{orgId}/environments/{envId}/configuration/dictionaries/{dictionary}` | Manage the dictionary's lifecycle |
| DELETE | `/organizations/{orgId}/environments/{envId}/configuration/dictionaries/{dictionary}` | Delete a dictionary |
| POST | `/organizations/{orgId}/environments/{envId}/configuration/dictionaries/{dictionary}/_deploy` | Deploy dictionary to API gateway |
| POST | `/organizations/{orgId}/environments/{envId}/configuration/dictionaries/{dictionary}/_undeploy` | Undeploy dictionary to API gateway |
| GET | `/organizations/{orgId}/environments/{envId}/configuration/hooks` | Get the list of available hooks |
| GET | `/organizations/{orgId}/environments/{envId}/configuration/identities` | Get the list of identity providers |
| POST | `/organizations/{orgId}/environments/{envId}/configuration/identities` | Create an identity provider |
| GET | `/organizations/{orgId}/environments/{envId}/configuration/identities/{identityProvider}` | Get an identity provider |
| PUT | `/organizations/{orgId}/environments/{envId}/configuration/identities/{identityProvider}` | Update an identity provider |
| DELETE | `/organizations/{orgId}/environments/{envId}/configuration/identities/{identityProvider}` | Delete an identity provider |
| GET | `/organizations/{orgId}/environments/{envId}/configuration/notifiers` | List of available notifiers |
| GET | `/organizations/{orgId}/environments/{envId}/configuration/quality-rules` | List quality rules |
| POST | `/organizations/{orgId}/environments/{envId}/configuration/quality-rules` | Create a quality rule |
| GET | `/organizations/{orgId}/environments/{envId}/configuration/quality-rules/{id}` | Get a quality rule |
| PUT | `/organizations/{orgId}/environments/{envId}/configuration/quality-rules/{id}` | Update a quality rule |
| DELETE | `/organizations/{orgId}/environments/{envId}/configuration/quality-rules/{id}` | Delete a quality rule |
| GET | `/organizations/{orgId}/environments/{envId}/configuration/spel/grammar` | Get grammar |

## Machine-readable artifacts (36)

- **OpenAPI** — https://artifacts.apis.io/gravitee/openapi/gravitee-configuration-api-openapi.yml
- **Documentation** — https://documentation.gravitee.io/apim
- **GettingStarted** — https://documentation.gravitee.io/apim/getting-started
- **ChangeLog** — https://documentation.gravitee.io/apim/release-information/changelog
- **License** — https://github.com/gravitee-io/gravitee-api-management/blob/master/LICENSE.txt
- **GitHubRepository** — https://github.com/gravitee-io/gravitee-api-management
- **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
- **JSONSchema** — https://artifacts.apis.io/gravitee/json-schema/gravitee-api-schema.json
- **JSONSchema** — https://artifacts.apis.io/gravitee/json-schema/gravitee-plan-schema.json
- **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
- **RateLimits** — https://artifacts.apis.io/gravitee/rate-limits/gravitee-rate-limits.yml
- **FinOps** — https://artifacts.apis.io/gravitee/finops/gravitee-finops.yml
- **Documentation** — https://documentation.gravitee.io/am
- **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
- **GitHubRepository** — https://github.com/gravitee-io/gravitee-access-management
- **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
- **JSONSchema** — https://artifacts.apis.io/gravitee/json-schema/gravitee-domain-schema.json

## Other Gravitee APIs (12)

- [Gravitee Cockpit](https://apis.io/apis/gravitee/gravitee-cockpit/)
- [Gravitee Alert Engine](https://apis.io/apis/gravitee/gravitee-alert-engine/)
- [Gravitee AI Agent Management](https://apis.io/apis/gravitee/gravitee-ai-agent-management/)
- [Gravitee Kafka Gateway](https://apis.io/apis/gravitee/gravitee-kafka-gateway/)
- [Gravitee Kubernetes Operator](https://apis.io/apis/gravitee/gravitee-kubernetes-operator/)
- [Gravitee Alerts API](https://apis.io/apis/gravitee/gravitee-alerts-api/)
- [Gravitee Analytics API](https://apis.io/apis/gravitee/gravitee-analytics-api/)
- [Gravitee API Products API](https://apis.io/apis/gravitee/gravitee-api-products-api/)
- [Gravitee Application API](https://apis.io/apis/gravitee/gravitee-application-api/)
- [Gravitee Applications API](https://apis.io/apis/gravitee/gravitee-applications-api/)
- [Gravitee Audit API](https://apis.io/apis/gravitee/gravitee-audit-api/)
- [Gravitee Authentication Device Notifier API](https://apis.io/apis/gravitee/gravitee-authentication-device-notifier-api/)

## Tags

Configuration

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/gravitee/gravitee-configuration-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/gravitee/.
