APIs

Developer Portal provides the capability to retrieve and manage all its APIs. You can use the resources of the API to update or retrieve the API details such as the associated applications, versions, topics, communities and so on.

List of resources

  • GET /apis

    Retrieves the list of APIs in Developer Portal.

  • POST /apis

    Publishes an API to Developer Portal.

  • GET /apis/_count

    Retrieves the count of APIs in Developer Portal.

  • GET apis/available

    Retrieves the list of APIs that are not mapped with any provider.

  • GET /apis/filter

    Retrieves the possible filter criteria of the given Id.

  • GET /apis/{id}

    Retrieves API based on the given Id.

  • PUT /apis/{id}

    Updates API based on the given Id

  • DELETE /apis/{id}

    Unpublishes API based on the given Id.

  • GET /apis/{id}/communities

    Retrieves the list of communities associated with the given Id.

  • GET /apis/{id}/topics

    Retrieves the list of topics for the given Id.

  • GET /apis/{id}/applications

    Retrieves the list of applications associated with the given Id.

  • GET /apis/{id}/subscriptions

    Retrieves the list of subscriptions mapped with the given Id.

  • GET /apis/{id}/versions

    Retrieves the versions of the API.

  • GET /apis/{id}/stages

    Retrieves the stages of the API.

  • GET /apis/{id}/followers

    Retrieves the list of followers of the given Id.

  • PUT /apis/{id}/followers

    Subscribes or unsubscribes to receive the updates of the given Id.

  • GET /apis/{id}/packages

    Retrieves the list of packages associated with the given Id.

  • GET /apis/{id}/groups

    Retrieves the list of groups associated with the given Id.

  • GET /apis/{id}/programs

    Retrieves the list of methods of an API associated by programs with the given Id.

  • GET /apis/{id}/applications/available

    Retrieves the list of applications that can be associated with the given Id.

  • PUT /apis/{id}/rate

    Allows to provide a rating for the given Id.

  • GET /apis/{id}/rate

    Retrieves the rating of the given Id.

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

    Retrieves the number of followers for the given Id.

  • GET /apis/{id}/bookmarks

    Retrives the list of topics of the given Id that are saved as bookmarks.

  • POST /apis/{id}/try

    Allows to test the given Id.

  • POST /apis/{id}/fileTypeTry

    Allows to test the multipart or binary type resources of the given Id.

  • GET /apis/{id}/try/history

    Retrieves the details of tests performed for the given Id.

  • GET /apis/status/{referenceId}

    Retrieves the published status of an API based on the given reference Id.

  • POST /apis/search

    Searches for an API based on the given search criteria.

  • GET /apis/{id}/export

    Exports the given Id.

  • PUT /apis/{id}/preferences

    Updates the view preference of the given Id.

  • PUT /apis/{id}/edits

    Allows to edit the details of the given Id and its resources.

  • PUT /apis/{id}/logo

    Allows to update the logo of the given Id.

  • PUT /apis/{id}/attachments

    Allows to update the attachments of the given Id.

  • PUT /apis/{id}/state

    Allows to modify the lifecycle state of the specific API.

  • PUT /apis/{id}/owners

    Allows to assign ownership of an API to other partner users or teams.

  • Delete /apis/{id}/owners

    Allows to revoke ownership of an API from other partner users or teams.

Sample cURL Command

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

The apis.yaml file is located at InstallDir\DeveloperPortal\developers\openapis.