How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Gravitee domain API

The domain API from Gravitee — 120 operation(s) for domain.

Gravitee domain API is one of 51 APIs that Gravitee publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Domain. 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.

This API exposes 14 operations across 9 paths, and defines 40 schemas. It is described by OpenAPI 3.2.0, at version 4.12.0-alpha.3.

Requests are made against a single base URL, /management.

14 operations 9 paths 40 schemas 2 DELETE7 GET1 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.12.0-alpha.3
Base URL
https://documentation.gravitee.io/apim
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Gravitee domain API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (gravitee-auth). By default, every request must be authenticated.

Paths & Operations 14

Across 9 paths, the API surfaces 14 operations — 2 DELETE, 7 GET, 1 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

domain 14
GET
/organizations/{organizationId}/environments/{environmentId}/domains
List security domains for an environment
listDomains 5 params → 200500
POST
/organizations/{organizationId}/environments/{environmentId}/domains
Create a security domain.
createDomain 2 params body → 201500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/_hrid/{hrid}
Get a security domain by hrid
findDomainByHrid 3 params → 200500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}
Get a security domain
findDomain 3 params → 200500
PUT
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}
Update the security domain
updateDomain 3 params body → 200500
DELETE
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}
Delete the security domain
deleteDomain 3 params → 204500
PATCH
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}
Patch the security domain
patchDomain 3 params body → 200500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/analytics
Find domain analytics
findDomainAnalytics 9 params → 200500
PUT
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/certificate-settings
Update the security domain certificate settings
updateDomainCertificateSettings 3 params body → 200500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/entrypoints
Get the matching gateway entrypoint of the domain
getDomainEntrypoints 3 params → 200500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/members
List members for a security domain
listMembers 3 params → 200500
POST
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/members
Add or update an security domain member
addOrUpdateMember_1 3 params body → 201400500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/members/permissions
List domain member's permissions
getDomainMemberPermissions 3 params → 200500
DELETE
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/members/{member}
Remove a membership
removeDomainMember 4 params → 204500

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are Domain (39 properties), AccountSettings (27 properties), PatchDomain (24 properties), LoginSettings (16 properties). Each schema is shown below with its type and property counts.

UMASettings
object
1 property
SecretExpirationSettings
object
2 properties
PatchOIDCSettings
object
8 properties
ResetPasswordSettings
object
2 properties
PasswordSettings
object
12 properties
FormField
object
3 properties
VirtualHost
object
3 properties
UserBindingCriterion
object
2 properties
ClientRegistrationSettings
object
10 properties
LoginSettings
object
16 properties
OIDCSettings
object
7 properties
CIBASettingNotifier
object
1 property
PatchClientRegistrationSettings
object
13 properties
PatchCIMDSettings
object
10 properties
PatchSAMLSettings
object
4 properties
SCIMSettings
object
3 properties
CIBASettings
object
5 properties
PatchCIBASettings
object
5 properties
SecurityProfileSettings
object
2 properties
WebAuthnSettings
object
11 properties
SelfServiceAccountManagementSettings
object
2 properties
PatchPasswordSettings
object
12 properties
Membership
object
10 properties
TrustedIssuer
object
7 properties
NewDomain
object
3 properties 2 required
DomainPage
object
3 properties
TokenExchangeOAuthSettings
object
2 properties
CorsSettings
object
6 properties
SAMLSettings
object
3 properties
MembershipListItem
object
2 properties
AnalyticsTypeParam
object
2 properties
AccountSettings
object
27 properties
CertificateSettings
object
1 property
PatchDomain
object
24 properties
Entrypoint
object
9 properties
PatchSecurityProfileSettings
object
2 properties
TokenExchangeSettings
object
9 properties
CIMDSettings
object
10 properties
NewMembership
object
3 properties 3 required
Domain
object
39 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gravitee-domain-api-openapi.yml Raw ↑

Other APIs Gravitee publishes across the network.

Gravitee Cockpit
Gravitee Alert Engine
Gravitee AI Agent Management
Gravitee Kafka Gateway
Gravitee Kubernetes Operator
Gravitee alerts API
Gravitee Analytics API
Gravitee API Products API
Gravitee APIs API
Gravitee application API
Gravitee Applications API
Gravitee audit API
Where this information came from

This is an independent, third-party profile of Gravitee domain API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.