Portal API (PAPI)

You can programmatically access key API Portal entities that are exposed as RESTful resources using the Portal API. You can call the Portal API from your external client application, or you can try it out using the API Explorer in the API Portal.
You can programmatically access key API Portal entities that are exposed as RESTful resources using the Portal API. You can call the Portal API from your external client application, or you can try it out using the API Explorer or Swagger UI in the API Portal. For more information about testing with API Explorer or Swagger UI, see Test and Explore APIs.
A new set of API operation endpoints (labeled as
) have been introduced that allow functionalities such as SOAP support, API visibility for Orgs, and granular permissions. These endpoints are accessible through the APIs page by default or manually through PAPI.
Note that earlier API endpoints (labeled as
) have been moved to the Deprecated section.
For more information, see Portal API (PAPI).
API Explorer is only accessible through the API Portal/Ingress tenant. If you are using an external tenant, test and explore APIs using the Swagger UI instead.
In this article:
Swagger File
The swagger file describing the current Portal API can be viewed and is available for download:
The following resources are available:
  • AccountPlans
    Use this resource to manage account plans. API publishers can use account plans to restrict cumulative usage for specific organizations.
    The AccountPlans POST method requires the
    value. You can add an autogenerated UUID while creating your users using:
    "Uuid": "{{GENERATED_GUID}}"
    This method does not require values for
    . You can leave them as null.
  • ApiPlans
    Use this resource to manage API Plans. Publishers use API Plans to limit quota and rate limit for specific APIs.
  • ApiDeployments
    Use this resource to manage the deployment details for a specific proxy. A proxy is a runtime environment where APIs, applications, and account plans are deployed.
  • ApiEulas
    Use this resource to manage the End User License Agreements (EULAs). EULAs are sets of legal restrictions that you can apply toward the usage of APIs managed in the API Portal.
  • ApiGroups
    Use this resource to manage the API groups.
  • API Keys
    Use this resource to manage your API keys. API keys are generated when you add applications and uniquely identify APIs so that applications can use them.
  • Apis
    Use this resource to manage APIs, retrieve the Swagger definition for a specific API, and retrieve relevant Gateway policy templates using
  • Applications
    Use this resource to manage applications. Applications are constructs that use one or more APIs.
  • CustomFields
    Use this resource to manage custom fields. A custom field describes extra metadata that API Gateway administrators can use in their policies.
  • Organizations
    Use this resource to manage organizations. Organizations are groups of one or more developers, typically representing a team or department within a business organization.
  • Proxies
    Use this resource to manage the proxies that are associated with the API Portal.
  • Requests
    Use this resource to manage requests. Requests are requests from developers for acceptance or rejection by administrators or API owners.
  • Search
    Use this resource to search for API Portal entities by keyword.
  • Settings
    Use this resource to retrieve or update an API Portal setting that corresponds to a specific functionality (such as Google Analytics tracking for API Portal pages and integrations).
  • Themes
    Use this resource to manage API Portal themes. Themes define the look of your API Portal.
  • Users
    Use this resource to manage API Portal user accounts. You can look up supported languages for the user interface using
    . Each user must have a specific developer or publisher role within an organization. You can look up available roles using
    , respectively.
Requests and responses are in JSON format.
For more information about JSON format, see the JSON.org website.
Access the Portal API
  1. Log in to the API Portal as a Portal administrator for the intended tenant.
  2. On the Welcome page, click the
    Portal API
  3. Select the
    Portal API
    option from the
    drop-down list.
The API Explorer appears in the right pane, showing the Portal API.
Portal API calls require a valid OAuth token.
For more information about OAuth tokens, see the OAuth Community Site.
For CA API Management OAuth Toolkit users, request the access token by posting using the
Audit Logs
Administrators can see the history of actions performed on APIs within Portal by accessing audit data that are captured for APIs.
To view and filter audit logs using an API call, see the following
Swagger JSON file.
For more information about how to access audit data through a UI, see Audit Logs.