Schema Reference

This page lists the key data transfer objects (DTOs) used across the API. For the complete schema definitions, refer to the Swagger UI of your instance.

Core resources

ApiDTO

Field	Type	Required	Description
id	UUID	—	API identifier (read-only)
name	string	Yes	Unique technical name
displayName	string	Yes	Human-readable display name
description	string	—	Description (max 1000 chars)
url	string	—	Base URL path
status	enum	Yes	ACTIVE, INACTIVE
owner	UUID	—	Owner user ID
tags	string[]	Yes	Tags (can be empty)
gitUrl	string	—	Git repository URL
gitCredential	UUID	—	Git credential ID
platformType	enum	—	Gateway platform type
deploymentStatus	enum	—	Deployment status (read-only)
createdAt	date-time	—	Creation timestamp (read-only)
hasImage	boolean	—	Whether an image is uploaded (read-only)
ownerDisplayName	string	—	Owner's display name (read-only)
ownerEmail	string	—	Owner's email (read-only)

ApiProductDTO

Field	Type	Required	Description
id	UUID	—	Product identifier (read-only)
name	string	Yes	Unique technical name (max 255)
displayName	string	Yes	Human-readable name (max 255)
description	string	—	Description (max 1000 chars)
visibility	enum	Yes	PUBLIC, RESTRICTED
allowSelfServiceSubscription	boolean	Yes	Allow self-service subscriptions
published	boolean	Yes	Whether published
mcpStatus	enum	Yes	ENABLED, DISABLED
tags	string[]	Yes	Tags (can be empty)
owner	UUID	—	Owner user ID
platformType	enum	—	Gateway platform type
subscribableStatus	enum	—	Whether subscribable (read-only)
deploymentStatus	enum	—	Deployment status (read-only)

EnvironmentDTO

Field	Type	Required	Description
id	UUID	—	Environment identifier (read-only)
name	string	Yes	Unique technical name
displayName	string	Yes	Human-readable name
url	string	—	Environment URL
symbol	string	Yes	Short symbol (max 4 chars)
status	enum	Yes	ACTIVE, INACTIVE
color	string	Yes	Color code for UI
pinned	boolean	Yes	Pinned in UI
stage	enum	Yes	DEVELOPMENT, PRODUCTION
platformType	enum	Yes	Gateway platform type
agentType	enum	Yes	STANDALONE, MANAGED
subscribeAccessMode	enum	—	PUBLIC, RESTRICTED
publishAccessMode	enum	—	PUBLIC, RESTRICTED
apiUrlStrategy	enum	—	PLATFORM_DEFAULT, PATH, SUB_DOMAIN

SubscriptionDTO

Field	Type	Required	Description
id	UUID	—	Subscription identifier (read-only)
application	UUID	Yes	Subscribing application
apiProduct	UUID	Yes	API Product
plan	UUID	Yes	Selected plan
environments	UUID[]	—	Target environments
approvalStatus	enum	—	APPROVED, PENDING, DECLINED (read-only)
deploymentStatus	enum	—	Deployment status (read-only)
termsOfUseAccepted	boolean	—	Terms accepted

UserDTO

Field	Type	Required	Description
id	UUID	—	User identifier (read-only)
username	string	Yes	Unique login name
displayName	string	—	Full display name
email	string	Yes	Email address
firstName	string	—	First name
lastName	string	—	Last name
status	enum	—	INVITED, ACTIVE, DELETED
role	enum	—	USER, GLOBAL_ADMIN, ADMIN, BILLING_CONTACT, NO_ACCESS
organization	UUID	—	Organization ID
origin	enum	—	MANUAL, INVITED, LDAP, SAML, OIDC, MANAGED
locked	boolean	Yes	Account locked status

Enumerations

Platform types

UNKNOWN, APIGEE, GRAVITEE, LAYER7, AWS, AZURE, KONG, WSO2, AAGM, IBM, BOOMI, MULESOFT, CAM, UNIVERSAL

Deployment status

CREATED, DEPLOYMENT_REQUIRED, DEPLOYMENT_IN_PROGRESS, DEPLOYED, DEPLOYMENT_FAILED, DELETION_IN_PROGRESS, DELETION_FAILED

User roles

USER, GLOBAL_ADMIN, ADMIN, BILLING_CONTACT, NO_ACCESS

Access token scopes

API_READ, API_WRITE, ENVIRONMENT_READ, ENVIRONMENT_WRITE, USER_READ, USER_WRITE,
ACCESS_TOKEN_MANAGE, APPLICATION_READ, APPLICATION_WRITE, JOBS_READ, PLAN_READ,
PLAN_WRITE, GIT_CREDENTIALS_READ, GIT_CREDENTIALS_WRITE, SUBSCRIPTIONS_READ,
SUBSCRIPTIONS_WRITE, CONFIGURATION_READ, CONFIGURATION_WRITE, METRICS_READ,
ORGANIZATION_READ, ORGANIZATION_WRITE, DISCOVERY, USER_INVITATION,
APPROVAL_REQUEST_READ, APPROVAL_REQUEST_WRITE, AUDIT_LOG_READ, RULE_SETS_READ,
RULE_SETS_WRITE, DEV_PORTAL_READ, DEV_PORTAL_WRITE, WEBHOOKS_READ, WEBHOOKS_WRITE,
TERMS_OF_USE_READ, TERMS_OF_USE_WRITE, API_GATEWAY_READ, API_GATEWAY_WRITE,
PLAN_ASSIGN_APIS, ACCESS_TENANT_DATA, READ_GOVERNANCE_DATA, SELF_SERVICE,
CROSS_ORGANIZATION_ACCESS, SAML_LOGIN, API_ORGANIZATION_READ, API_ORGANIZATION_WRITE,
API_READ_ACCESSIBLE

Pagination wrapper

All list endpoints return results in a SimplePage wrapper:

Field	Type	Description
content	array	Items for the current page
size	integer	Page size
number	integer	Current page (1-based)
totalPages	integer	Total pages
totalElements	integer	Total items
last	boolean	Whether this is the last page

Error response

Field	Type	Description
timestamp	string	When the error occurred
status	integer	HTTP status code
error	string	HTTP status text
message	string	Human-readable description
path	string	Request path