Manage Applications
Applications are containers that developers create to group subscriptions and credentials. While applications are primarily managed by developers through the Developer Portal, administrators can view and manage them from the Provider Portal.
List Applications
Retrieve all applications for a specific developer:
curl "https://{ADMIN_API_URL}/api/applications?developer_id={developer_id}" \
-H "Authorization: Bearer $API_TOKEN"
Response:
{
"list": [
{
"id": "app-uuid-1234",
"developer_id": "dev-uuid-5678",
"name": "Mobile App",
"desc": "Mobile application backend integration",
"labels": {
"team": "mobile",
"environment": "production"
},
"created_at": "2025-01-10T08:00:00Z",
"updated_at": "2025-01-15T10:30:00Z"
}
],
"total": 1
}
Filter by API Product
To list all applications subscribed to a specific API product:
curl "https://{ADMIN_API_URL}/api/applications?api_product_id={api_product_id}" \
-H "Authorization: Bearer $API_TOKEN"
Get Application Details
Retrieve a specific application:
curl "https://{ADMIN_API_URL}/api/applications/{application_id}" \
-H "Authorization: Bearer $API_TOKEN"
Application Structure
Each application belongs to a single developer and contains:
| Component | Description |
|---|---|
| Subscriptions | Links to API products that grant the application access to consume APIs. |
| Credentials | Authentication tokens (API keys, basic auth, OAuth clients) used to authenticate API requests. |
| Labels | Optional key-value pairs for categorization and filtering. |
API Usage Tracking
You can retrieve API call statistics per application:
curl "https://{ADMIN_API_URL}/api/applications/api_calls?developer_id={developer_id}&application_id={application_id}" \
-H "Authorization: Bearer $API_TOKEN"
This returns usage metrics that help you understand how each application is consuming your APIs.
Application Lifecycle
Applications follow this lifecycle:
- Created by a developer in the Developer Portal.
- Active while the developer uses it to subscribe to API products and make API calls.
- Deleted by the developer or cascaded when the developer account is deleted.
Deleting an application also deletes all its credentials and cancels all its subscriptions. For OAuth (DCR) credentials, the registered clients are also removed from the identity provider.