Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Send Requests
• Security, Authentication and Authorization
• Status Codes
• Use cURL
• Use Cases
  • Manage Custom Pages in Developer Portal
    • css
    • data
    • js
    • index.html

Tasks

• Analytics
  • Categorical
    • Get http response code analytics as categorical data for failures.
  • Time Series
    • Get payload size analytics as time series data
    • Get request analytics as time series data
    • Get response time analytics as time series data
  • Totals
    • Get number of failures as a total value
    • Get number of requests as a total value
• APIs
  • Get API's plans
  • Get APIs
  • Get details for an API's latest iteration
  • Get details for an API's published iteration
  • Return the Apiary project
• Applications
  • Create an application
  • Delete an application
  • Get application types
  • Get applications
  • Get details for an application
  • Update an application
  • Grants
    • Get application grants
    • Get grants issued for an application
    • Issue an application grant
    • Revoke an application grant from a group
    • Revoke an application grant from a user
  • Key
    • Update application key
• Plans
  • Get details for a plan
  • Get details for the current plan
  • Get plans
• Portal
  • Customization
    • Check available saved configuration
    • Custom Pages
      • Delete custom page data
      • Get content data for the given custom page
      • Get custom page metadata
      • Get custom pages
      • Set content data for the given custom page
      • Set metadata and content for the given custom page
      • Set metadata for the given custom page
    • Developer Portal Configuration
      • Delete configuration
      • Get configuration
      • Patch configuration
      • Set configuration
    • Language Resources
      • Delete language resource
      • Get language resource
      • Patch language resource
      • Set language resource
  • Miscellaneous
    • Check if the current user can sign in to the Developer Portal
    • Get custom page's file
    • Get state of the Developer Portal
    • Retrieve version information
  • User preferences
    • Delete all user preferences for current user
    • Delete user preference for current user
    • Retrieve all the user preferences for current user
    • Retrieve user preference for current user
    • Set user preference for current user
• Subscriptions
  • Applications
    • Delete a subscription
    • Subscribe to an application
  • Plans
    • Delete a subscription
    • Subscribe to an application