API Manager

Resources

Resource Group Since Version Description
API Discovery Provides a REST API for finding out information about the APIs which are been managed by the API Manager
API Manager Services The API Manager Services REST API provides access to some control API Manager's service
API Proxy Registration 1.1 Register and manage frontend API proxies
API Repository 1.1 The API Repository REST API provides backend API management for the gateway
Applications The Applications REST API provides application management to the API Manager's client registry
Current User The Current User REST API provides account management for the calling user
Login The Login API is used to create or destroy API Manager HTTP sessions
Metrics The Metrics REST API provides access to periodic analytics of the Portal's application usage.
Migrate The Migration REST API provides application migration to the API Manager's client registry
OAuth Authorizations The OAuth Authorizations REST API allows resource owners and admins access information regarding OAuth Authorizations given by a resource owner
Organizations The Organizations REST API provides organization management to the API Manager's client registry
Quotas The Quota REST API provides access to the API Manager's quota management.
Users The Users REST API provides user management to the API Manager's client registry.

Classes

Class Since Version Description
API The API is a path and operations.
APIAccess API Access indicates whether access to an API is available
APIDefinition 1.1 An API definition.
APIKey API Manager API Key for use in authenticating applications
APIPromotion 1.1 API promotion package.
AlertConfig 1.1 API alert system configuration
ApiQuotaType API quota types
Application API Manager application.
ApplicationRequest API Manager application request.
AuthenticationProfile 1.1 Outbound authentication profile.
Authorization An OAuth Authorization
BackendBlob 1.1 Backend blob export definition.
BackendExport 1.1 Backend API export definition.
BackendMethodExport 1.1 Backend API method export.
CACert 1.1 Trusted CA certificate
CORSProfile 1.1 CORS configuration profile.
Config API Manager configuration
DiscoveryAPI REST API information.
ErrorResponse An operation response code.
ExportOptions Options available on export of applications
ExternalClient 1.1 API Manager external client
FrontendExport 1.1 Frontend API export definition.
InboundProfiles 1.1 Inbound profiles
Method 1.1 A method available on an API resource.
MetricField Queryable metric type information
MetricTimeline The metrics timeline report is a report of a specific metric over a period of time.
OAuthAppScope OAuth Application Scope
OAuthClient API Manager OAuth Credentials.
OAuthProtectedResource Scope and prefix information for OAuth protected resource.
OAuthResource OAuth protected resource.
Operation An operation available to an API path.
Organization API Manager organization
OutboundProfiles 1.1 Outbound profiles
ParamValue 1.1 Outbound parameter value.
Parameter 1.1 An API operation parameter for a Method, as part of the APIDefinition.
PermissionDTO API Manager application permission.
PortalTrafficListener 1.1 A HTTP service listener.
Quota The Quota is a set of restrictions that apply to applications in the Portal.
QuotaApiConstraintDTO The APIConstraint is restriction that applies to API(s) and API method(s).
QuotaDTO The Quota is a set of restrictions that apply to applications in the Portal.
ReferencedEntity 1.1 Referenced entity.
RegistrationToken Organization Registration Token.
RemoteHost 1.1 An API Manager-registered remote host.
ResponseCode 1.1 An operation response code.
SchemaObject none
SecurityDevice 1.1 Inbound security device.
SecurityProfile 1.1 Inbound security profile.
Series A metric time series.
ServiceProfiles 1.1 Service profile configuration for backend services
String none
Swagger A Swagger API definition.
SwaggerSecurityProfile Security Profile details.
SystemConfig API Manager system configuration
User The API Manager user is a member of organizations.
VirtualizedAPI 1.1 Represents a virtualized, frontend API.
VirtualizedAPIMethod 1.1 Represents a virtualized API method as part of a frontend API.
VirtualizedMethodExport 1.1 Frontend API method export.
WebServiceInfo 1.2 A Policy Studio-registered web service.