Public APIs for 2019.0.4
The Contracts service provides operations for managing API access contracts in the Akana API Platform.
- Alert Management API
- The API used to report and manage alerts.
The Alerts service provides operations that allow you to manage alerts on APIs, including adding, retrieving, and deleting alerts, commenting on an alert, and retrieving comments.
The APIs service provides a REST interface and a set of operations for managing APIs in the Akana API Platform. This API includes operations to support complete API lifecycle management, including creating and managing APIs and API versions, managing API OAuth details, managing legal agreements and the API Board, API monitoring and documentation, and relationships between APIs and apps.
The Apps service provides a REST interface and a set of operations for managing apps in the Akana API Platform. This service includes operations to support complete app lifecycle management, including such activities as creating, modifying, and deleting apps and app versions, managing app teams, and creating, modifying, and deleting the app security mechanism.
The application identity service provides access to the security artifcats for an API.
- Asset Environment API
The Asset Environment service provides operations for managing the promotion of assets to different environments.
- Asset Transformation API
- Asset transformation API
- Audit Trail Management API
- The API used to report and manage audit trails.
The Boards service provides operations for retrieving information about various Boards in the portal, such as the Board for an app, API, or group, or a user-defined board, the Forum (Site Admin, Business Admin, or API Admin only), or the Support Board for the business.
- Business API
The Businesses service provides operations for managing business information, including apps, APIs, workflows, and other information relating to a specific business on the platform. Note that most of these operations take the Business ID as a parameter. To find out what the Business ID is for your installation, you can run the GET /api/properties operation (TenantBusinessID parameter in the response).
The client services API includes operations to support app developers, and also Test Client, in preparing request messages with the values that the API needs, so that the requests are suitable for the API Security Policy that the API is using.
The Console Resource service provides operations that allow you to upload and manage platform resources such as platform CSS, customizable platform content pages, and platform help files. This service is used for any platform assets, stored in the /resources/ folder structure.
- Container Configuration Data API
- This API is used to fetch container configuration information.
- Container Management API
This API is used to manage PM service containers. Containers can be registered based on metadata documents. Containers may also be modifed or removed from the system. The API also provides read/write access to container metadata and container listener configuration. Information on services hosted by a specific container can be retrieved. To add or modify services other APIs can be used.
- Container State Reporting API
- This API is used to report container state to Policy Manager.
The Content service provides operations for managing content associated with the platform, including adding, modifying, deleting, and retrieving. Content can include API documentation, legal agreements, artifacts for the API Downloads page, and site documentation.
- Contract Management API
- The API used to manage PM contracts
The Deployment Zones service allows you to retrieve a list of deployment zones for the platform.
The Discussions service provides operations for managing discussions about apps or APIs, including the associated comments and marks.
- Domain (Identity System) Management API
- This API is used to manage PM security domains, or identity systems.
The Dropbox service provides operations for uploading images to the Akana API Platform, to support operations that create or modify resources that might include an image, such as user profiles.
- Environment API
The Environment service provides operations for finding information about the configured environments.
The Event service allows events to be created in the system.
- Exports Management Service
- The API used to manage PM exports.
The federated search service provides a high-level search API.
This API provides information about federation members.
The following API allows clients to query and manage following behavior.
The Groups service provides methods for managing groups in the Akana API Platform, including app teams, API Context Groups, and independent groups.
The Search Index service provides an interface for managing the Elasticsearch feature in the Akana API Platform.
The Legals service provides the ability to manage legal agreements in the Akana API Platform. Note that these operations are for managing legal agreements general to the platform, such as end-user license agreements. Operations relating to legal agreements for access to a specific API are part of the APIs service.
The Licenses service provides operations for managing API licenses.
The Login service provides a REST interface and a set of operations that deal with logging in and out, including getting an authentication token, renewing an authorization token, and deleting an authorization token cookie. This API also includes interfaces to perform SSO login.
- Metrics Collection API
- This API is used to report metrics, audit, and transaction data.
The Notification service provides operations for managing Dashboard and email notifications.
This API provides the ability to manage tokens and artifacts associated with OAuth clients.
This service provides access to OAuth client information.
- Organization Management API
- This API is used to manage PM organizations.
The operations in the Password Management service, along with the POST /api/login/authenticateWithPasswordResetCode operation in the Login service, support resetting the user password.
- Policy Management API
The API used to manage PM policies.
The Policies service supports managing the policies that govern API operation in the platform.
This service allows portal settings to be examined and modified.
- Process API
The API used to manage PM processes.
The Propeties service allows you to retrieve properties for your deployment.
- REST Service Information API
- This API is used to get information about REST services
Provides operations that allow you to manage reviews of apps, APIs, or groups on the platform, including creating, deleting, and listing reviews and marking reviews as helpful.
- Role API
The Roles API service provides operations for managing users in roles in a scope of a Resource(Business).
Note: All of these operations take the Resouce ID as a parameter. For exmpale Business ID. To find out what the Business ID is for your installation, you can run the GET /api/properties operation (TenantBusinessID parameter in the response).
- Script Management API
- The API used to manage PM scripts.
The Search service provides an interface for performing searches in the Akana API Platform.
This API allows security domains to be queried and manipulated.
- Service Management API
- The API used to manage PM services.
The Tags service includes operations that can be used to provide autocomplete help to users typing in the user interface.
Provides access to technology information.
The Tenant Administation service includes operations relating to managing settings for a platform tenant.
A simple service that allows tenants to be created.
The Tickets service provides operations for managing tickets about apps or APIs, including the ticket label and the associated comments and marks.
- Topology API
- This API provides operations to maintain topologies.
The Users service provides operations for managing users in the platform, such as adding, modifying, and deleting users and retrieving user information.
The operations in the Workflow service allow you to add, retrieve, manage, and delete custom workflows on the platform.