Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 14. Exporting and importing the Developer Portal

As a 3scale API provider, you can export and import the Developer Portal for the following purposes:

  • Creating backups.
  • Keeping the Developer Portal in an external repository, for example, GitHub.
  • Integrating the Developer Portal with other applications.

Use the Developer Portal API as a Content Management System (CMS) to import and export the Development Portal content. For this, perform the following steps to generate a key with enough permissions to use the Developer Portal API.

Procedure

  1. Navigate to Account settings > Personal > Tokens and click Add Access Token.
  2. Name the access token and check Developer Portal API.

  3. Choose permissions:

    1. Read only allows retrieving Developer Content portal contents.
    2. Read and Write allows retrieving and restoring Developer Portal contents.
  4. Click Create Access token.
  5. Copy and store the token information displayed.

Check the endpoints list navigating from the left panel to Integrate > 3scale API Docs. Then, scroll down to Developer Portal API. Use the token generated to call each endpoint and fill in the fields according to your needs.

Developer Portal API endpoints considerations

The Developer Portal API available from 3scale 2.14 is not compatible with previous versions. Also, from 3scale 2.14, JSON is the only data format compatible for all requests and responses.

For each endpoint, you can perform the following actions:

  • GET to read and list resources.
  • POST to create and add resources.
  • PUT to modify resources.
  • DELETE to delete resources.
Note
  • Built-in objects cannot be deleted. Call the GET /admin/api/cms/templates endpoint with the type=builtin_page parameter to get a list of builtin pages and the type=builtin_partial parameter to get a list of builtin partials.
  • To do a complete backup, you must call each content. There is no API endpoint that downloads a complete archive containing all files.
  • If content is not sent, it does not return the published or draft content. Instead, it returns a summary with information like template name and section because the content is too long.

Use the details listed under each endpoint to refine its output after executing it. Consider the following for the listed parameters:

  • All endpoints reject unsupported parameters; if unsupported parameters are sent, the request is canceled.
  • GET /admin/api/cms/templates endpoint accepts a content parameter. By default, it returns a list of Developer Portal templates. To also get published and draft content, use content=true parameter.
  • GET /admin/api/cms/templates endpoint accepts type and section_id parameters to filter results.
  • GET /admin/api/cms/sections endpoint accepts parent_id parameter to filter results.
  • GET /admin/api/cms/files endpoint accepts section_id parameter to filter results.
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat