Apps Service: Overview
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.
If you want to generate a list of apps for a specific user, that operation is part of the Users service: GET /api/users/{UserID}/apps.
Note: For more information about managing apps and app versions, see Managing App Versions.
URL: https://{hostname}/api/apps
| Action | Endpoint | Description |
|---|---|---|
| add member to team | POST /api/apps/{AppID}/members | Adds a new member to the team for the specified app. |
| add version | POST /api/apps/{AppID}/versions | Adds a version of an app. Can be either the original version when the app is created, or a new version created later. |
| create app | POST /api/apps | Creates a new app, which includes the first app version. The response includes information about the new app and app version. |
| delete app | DELETE /api/apps/{AppID} | Deletes an app (all versions). |
| delete app public profile picture | DELETE /api/apps/versions/{AppVersionID}/publicprofile/picture | Deletes the avatar associated with an app version's public profile, replacing it with the default avatar. |
| delete app version | DELETE /api/apps/versions/{AppVersionID} | Deletes the specified version of an app (returns JSON) (recommended). |
| delete app version string |
DELETE /api/apps/versions/{AppVersionID} Note: Legacy operation. |
Deletes the specified version of an app (no response content). Note: Deprecated in version 2019.1.0. Use DELETE /api/apps/versions/{AppVersionID} (returns JSON) instead. |
| execute workflow action | POST /api/apps/versions/{AppVersionID}/action | Executes a workflow action associated with a specific app version. |
| export app | GET /api/apps/{AppID}/package | Exports the information associated with a specific app. |
| export app version | GET /api/apps/versions/{AppVersionID}/package | Exports the information associated with a specific app version. |
| export metrics | GET /api/apps/versions/{AppVersionID}/metrics/export | Exports a summary of metric information for the specified app version, in the form of a CSV file. |
| export usage logs | GET /api/apps/versions/{AppVersionID}/txlogs/export | Exports the transaction log for an app version's usage of an API, to a CSV file. |
| get API legals | GET /api/apps/versions/{AppVersionID}/apilegals | Returns the legal documents associated with an API that an app is connecting to. |
| get app | GET /api/apps/{AppID} | Returns information about an app. |
| get app certificate | GET /api/apps/versions/{AppVersionID}/certificate | Returns the security certificate for an app version. |
| get app OAuth client properties | GET /api/apps/versions/{AppVersionID}/oauthclient | Returns information about the OAuth Profile settings for the specified app version. |
| get app OAuth profile choices | GET /api/apps/versions/{AppVersionID}/oauthprofile/choices | Returns information about the choices available for a specific app, for the app's OAuth Profile. These are the options that are available for the app developer to choose from. |
| get app public profile | GET /api/apps/versions/{AppVersionID}/publicprofile | Returns information about an app's public profile, if the public profile has been set up. |
| get app public profile picture | GET /api/apps/versions/{AppVersionID}/publicprofile/picture | Retrieves the image associated with an app version's public profile. |
| get app settings | GET /api/apps/{AppID}/settings | Returns a summary of the settings for the specified app. |
| get app version connection environments | GET /api/apps/versions/{AppVersionID}/contracts/environments?APIVersionID={APIVersionID} | Returns a summary of the environments available for the specified app version to request a contract with the specified API version. |
| get app version governing workflow | GET /api/apps/versions/{AppVersionID}/governingworkflow | Returns information about the workflow governing the specified app version. |
| get app versions (from Runtime Identity) | GET /api/apps/versions?Identity={identity} | Returns information about app versions, for the ID specified in the required Identity parameter. You can use this operation to get the AppID or AppVersionID if you only have the AppID specified on the App Details Page in the user interface. |
| get avatar | GET /api/apps/{AppID}/avatars/{AvatarVersionID}.png | Retrieves the specified avatar version associated with the specified resource. The avatar might be the current one or an earlier one. |
| get board | GET /api/apps/{AppID}/board | Returns a list of Board items for the specified app. |
| get contracts | GET /api/apps/versions/{AppVersionID}/contracts |
Returns information about API contracts for the specified app version, as an RSS feed. Note: GET /api/apps/versions/{AppVersionID}/contracts (list contracts, with custom Accept header) returns the same information as a JSON object. We recommend using that operation rather than this one. |
| get default avatar | GET /api/apps/{AppID}/avatar | Returns the default (current) avatar for the specified resource. |
| get followers | GET /api/apps/{AppID}/followers | Returns information about the users who are following the specified app. |
| get image | GET /api/apps/{AvatarVersionID}/picture | Retrieves the specified avatar version associated with the specified resource. The avatar might be the current one or an earlier one. |
| get key info | GET /api/apps/versions/{AppVersionID}/keyinfo | Returns the public key or certificate stored for the specified app. |
| get license report | GET /api/apis/versions/{ApIVersionID}/licensereport | Returns the report definition relating to licenses for the specified app version, for the specified ReportType. |
| get metrics | GET /api/apps/versions/{AppVersionID}/metrics | Returns a summary of metric information for an app, in JSON format, that can be used to create a chart. |
| get rating | GET /api/apps/versions/{ID}/ratings/{UserID} | Returns a specific user's rating for a resource. |
| get rating summary | GET /api/apps/versions/{ID}/ratings/summary | Retrieves a summary of the ratings for a resource. |
| get shared secret | GET /api/apps/versions/{AppVersionID}/secret | Returns the Shared Secret for the app version. Valid if the Shared Secret is stored on the platform. Not valid for apps that have a user-defined app identity referencing an external identity domain. |
| get team members | GET /api/apps/{AppID}/members | Returns information about team members for the specified app. |
| get transaction record | GET /api/apps/versions/{AppVersionID}/txlogs/{TransactionID} | Returns information about a specific transaction for an app version. |
| get transaction logs | GET /api/apps/versions/{AppVersionID}/txlogs | Returns up to 1000 transaction logs for the specified app version. If no count parameters specified, returns 100 transactions. |
| get version | GET /api/apps/versions/{AppVersionID} | Returns a version of an app. |
| get version board | GET /api/apps/versions/{AppVersionID}/board | Returns a list of Board items for the specified app version. |
| get version settings | GET /api/apps/{AppVersionID}/settings | Returns information about the settings for the specified app version. |
| get versions (from App ID) | GET /api/apps/{AppID}/versions | Returns a list of versions for the specified app. |
| list apps | GET /api/apps | Returns a list of apps at the root level (not apps added in the context of a specific organization.) With an optional parameter, lists apps owned by the specified organization. |
| list contracts | GET /api/apps/versions/{AppVersionID}/contracts | Returns information about API contracts for the specified app version, in the form of a JSON object. |
| list versions | GET /api/apps/versions?{Identity} | Returns app version information, including the AppVersionID, based on the Identity value provided. |
| modify app | PUT /api/apps/{AppID} | Changes one or more values for an app (Name and/or Description). |
| modify version | PUT /api/apps/versions/{AppVersionID} | Changes one or more values associated with an app version. |
| regenerate shared secret | PUT /api/apps/versions/{AppVersionID}/secret | Regenerates the shared secret value for the specified app version. Valid if the Shared Secret is stored on the platform. Not valid for apps that have a user-defined app identity referencing an external identity domain. |
| remove key info | DELETE /api/apps/versions/{AppVersionID}/keyinfo | Deletes an app's public key or certificate. |
| remove member from team | DELETE /api/apps/{AppID}/members/{UserID} | Removes a member from the team for the specified resource. |
| save app OAuth client properties | PUT /api/apps/versions/{AppVersionID}/oauthclient | Updates information about the OAuth Profile for the specified app version. |
| save app public profile | PUT /api/apps/versions/{AppVersionID}/publicprofile | Adds or updates information about an app's public profile. |
| save key info | POST /api/apps/versions/{AppVersionID}/keyinfo | Adds an app's public key or certificate (for runtime security). |
| update rating | PUT /api/apps/versions/{ID}/ratings/{UserID} | Adds or updates a specific user's rating for a resource. If the rating doesn't exist, this operation adds it; if it already exists, the operation updates it. |