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
.
apip43
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
.
In this article:
 
 
2
 
 
Swagger File
The swagger file describing the Portal API can be viewed and is available for download:
 
 
Resources
The following resources are available:
  • AccountPlans
    Use this resource to manage account plans. API publishers can use account plans to grant or restrict access to developer organizations, apply usage restrictions, and provide access to private APIs.
    The AccountPlans POST method requires the 
    UUID
     value. You can add an autogenerated UUID while creating your users using: 
    "Uuid": "{{GENERATED_GUID}}"
    This method does not require values for 
    OldPassword
     and 
    NewPassword
    . You can leave them as null.
  • 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). A EULA is a set of legal restrictions that you can apply toward the usage of any API managed in the 
    API Portal
    .
     
  • ApiGroups
    Use this resource to manage the API groups.
     
  • Apis
    Use this resource to manage APIs, retrieve the Swagger definition for a specific API, and retrieve relevant Gateway policy templates using 
    /policyTemplates
    .
  • Applications
    Use this resource to manage applications. An application is a construct that uses 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. An organization is a group 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. A request is request from a developer 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).
     
  • Themes
    Use this resource to manage 
    API Portal
     themes. A theme defines the look of your 
    API Developer Portal
    .
  • Users
    Use this resource to manage 
    API Portal
     user accounts. You can look up supported languages for the user interface using 
    /languages
    . Each user must have a specific developer or publisher role within an organization. You can look up available roles using 
    /developerRoleTypes
     and 
    /publisherRoleTypes
    , respectively.
Requests and responses are in JSON format.
For more information about JSON format, see the JSON.org website
Access the Portal API
  1. While logged in to the 
    API Portal
     as a Portal administrator for the intended tenant, click the 
    Services
     icon.
  2. Click 
    Portal 
     
    API
    .
  3. Select the 
    Portal API
     option from the 
    API
     drop-down list.
The API Explorer appears in the right pane, showing the Portal API.
Authentication
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 
application/x-www-form-urlencoded
 Content-Type.
Audit Logs
Administrators can access audit data that are captured for APIs to see the history of actions performed on APIs within Portal.
To view and filter audit logs using an API call, see the 
Auditing
 Swagger JSON file below. 
For more information about accessing audit data through a UI, see Audit Logs.