Packages

This REST API is used to manage packages. You can view, add, edit, and delete packages. You can also add, update, and delete the APIs and Plans associated with packages.

List of resources

  • GET /packages

    Retrieves the list of packages in Developer Portal.

  • POST /packages

    Create a package with the given details.

  • GET /packages/{id}

    Retrieves the details of the specified package.

  • PUT /packages/{id}

    Updates the specified package with the given details.

  • DELETE /packages/{id}

    Deletes the specified package.

  • GET /packages/{id}/plans

    Retrieves the list of plans for the specified package.

  • PUT /packages/{id}/plans

    Updates the plans of the specified package with the given details.

  • DELETE /packages/{id}/plans

    Deletes the given plans from the specified package.

  • GET /packages/{id}/apis

    Retrieves the list of APIs in the specified package.

  • PUT /packages/{id}/apis

    Updates the APIs of the specified package with the given details.

  • DELETE /packages/{id}/apis

    Deletes the given APIs from the specified package.

  • GET /packages/{id}/communities

    Retrieves the list of communities in the specified package.

  • GET /packages/{id}/topics

    Retrieves the list of topics in the specified package.

  • GET /packages/{id}/rate

    Retrieves the rating details of the specified package.

  • PUT /packages/{id}/rate

    Updates the rating details the specified package with the given details.

  • GET /packages/{id}/followers

    Retrieves the list of followers of the specified package.

  • PUT /packages/{id}/followers

    Updates the list of followers in the specified package with the given details.

  • GET /packages/{id}/followers/_count

    Retrieves the number of followers for the specified package.

  • PUT /packages/{id}/state

    Allows to modify the lifecycle state of the specific package.

  • PUT /packages/{id}/owners

    Allows to assign ownership of a package to a partner user or team.

Sample cURL Command

curl --location --request GET 'developer_portal_rest_base/packages' \
--header 'Authorization: Basic basic_auth'