APIM 3.0 APIs
These APIs manage APIM 3.0 Services, Service versions, migrations, subscriptions, and APIM 3.0 Developer Portal applications.
These APIs validate request parameters and body fields against a schema. If a request contains invalid or missing fields, the API returns HTTP 400 with details about the validation errors:
{
"http_status_code": 400,
"response_map": {
"error_list": [
{
"message": "Request validation failed for <endpoint_name>: <field>: <error_detail>"
}
]
}
}
When a request has multiple validation errors, the API combines them in a single message, separated by semicolons.
Authentication
Most APIM 3.0 APIs authenticate with Basic authentication or JWT as described in Authentication. Some Developer Portal APIs (Get published Service details, Get published Service versions) are accessible without authentication when the Allow access to APIM 3.0 Portal pages without login setting is enabled; when it is disabled, those APIs are not available. Each API page specifies its authentication requirements.
Developer Portal (public)
| Developer Portal (public) | |
|---|---|
GET
/developer_hub/details
|
Retrieve the published details for an APIM 3.0 Service version on the Developer Portal. |
GET
/developer_hub/services/versions/published
|
Returns the published Service versions available on the Developer Portal, optionally filtered by category. |
Subscriptions and Applications
| Subscriptions and Applications | |
|---|---|
POST|GET /api_subscription
|
Subscribe to Services, retrieve subscriptions, generate access tokens, and find available applications. |
POST|DELETE /api_subscription
|
Approve, revoke, renew, or delete Service subscriptions. |
POST|GET|DELETE /service_application
|
Create, list, or delete APIM 3.0 Developer Portal applications. |
Portal Administration
| Portal Administration | |
|---|---|
POST /developer_hub/approve|deny
|
Approve or deny requests for APIM 3.0 Developer Portal accounts. |
PUT
/developer_hub/site_settings
|
Update APIM 3.0 Developer Portal site settings, such as the URL suffix. |
POST|GET /developer_hub/password|site_url
|
Reset a password, update a password, and retrieve the Developer Portal site URL. |
Migration
| Migration | |
|---|---|
POST
/apim_service/migrate_service_version/{src_path}
|
Migrate a Service version, including the asset types specified in the request body, to another environment. The destination Service must already exist in the target environment. |
GET
/apim_service/migration_status/{org_name}
|
This APIM 3.0 endpoint retrieves the status for the migration of one or more Classic APIM API versions or proxies to Services, or lists all migration records for an environment filtered by status. |
POST
/apim_service/service_migration
|
This APIM 3.0 endpoint migrates Classic APIM assets (APIs, API Versions, or Proxies) to APIM 3.0 Services. |