Overview
Authentication to use Developer Portal REST APIsAccess privileges based authorizationREST APIs URI formatPossible response messagesList of APIsThe headless architecture feature of Developer Portal equips you with the APIs that you would require to build an application with the Developer Portal functionality.
The REST APIs allow you to perform all functions that you can accomplish through the application’s user interface.
Authentication to use Developer Portal REST APIs
The authentication method applicable for the Developer Portal REST APIs is HTTP Basic authentication.
Access privileges based authorization
The availability of API resources is based on the user privilege. Typically, users who have the API Administrator privilege have access to all APIs, whereas, the users who have any of the API Provider and API Consumer privileges have limited access of API resources.
REST APIs URI format
Developer Portal allows you to access the API resources using URI paths. The REST call URI must be specified with the required method in the format shown below:
Possible response messages
The following table lists the possible response messages and what they indicate:
Response message | Description |
---|---|
200 - OK | Indicates the request sent and response received successfully. |
201 - Created | Indicates that the request is fulfilled, resulting in the creation of a new resource. |
400 - Bad request | Indicates that a parameter is missing in the request due to which it could not be processed. |
401 - Unauthorized | Indicates authorization problem. |
403 - Forbidden | Indicates that there is no permission to the requested resource. |
404 - Not found | Indicates that the requested resource does not exist. |
500 - Internal server error | Indicates that an unexpected condition is encountered and no more specific message is suitable. |
List of APIs
The REST APIs allow you to perform the following:
Viewing analytics
OverviewList of resourcesSample cURL CommandOverview
The Analytics API is used to view the performance analytics of APIs and applications in the system. This API provides detailed information on the trends, top hits, usage based on the filters applied. There are variety of feeds and each is responsible for providing the aforesaid specific information.
List of resources
- POST /analytics/{id}
- POST /analytics/ACCESS_LOGS
Retrieves the analytic insights for the given feed Id and matching filter criteria.
Possible values are:
Value | Description |
---|---|
TRANSACTION_SUMMARY_FEED | Retrieves the summary of all transactions. |
API_ACCESS_TREND_FEED | Retrieves the API access trend. |
APP_ACCESS_TREND_FEED | Retrieves the application access trend. |
API_RESPONSE_TIME_TREND_FEED | Retrieves the API response time trend. |
TOP_API_HITS_BY_ACCESS_FEED | Retrieves the list of top APIs based on the number of hits. |
TOP_API_BY_FOLLOWERS_FEED | Retrieves the list of top APIs based on the number of followers. |
TOP_RESOURCE_HITS_BY_ACCESS_FEED | Retrieves the list of top resources based on the number of hits. |
TOP_STATUSCODE_HITS_BY_ACCESS_FEED | Retrieves the list of top status codes based on the number of hits. |
TOP_APP_HITS_BY_ACCESS_FEED | Retrieves the list of top applications based on the number of hits. |
APP_DISTRIBUTION_IN_API_FEED | Retrieves the app distribution data from APIs. |
API_DISTRIBUTION_IN_APP_FEED | Retrieves the API distribution data from applications. |
SIGN_UP_TREND_FEED | Retrieves the user sign up trend. |
LOGIN_TREND_FEED | Retrieves the sign in trend. |
ACCESS_LOGS | Retrieves access logs. |
TOP_APP_TYPE_HITS_BY_ACCESS_FEED | Retrieves the list of application types based on the number of hits. |
USER_SIGNUP_SUMMARY_FEED | Retrieves the user sign up summary. |
USER_LOGIN_SUMMARY_FEED | Retrieves the user sign in summary. |
TOP_CONSUMER_LOGINS | Retrieves the list of top consumer sign ins. |
TOTAL_USER_SIGNUP_AND_DELETE_FEED | Retrieves the total number sign ups and deletes. |
Retrieves the access logs for the matching filter criteria.
Sample cURL Command
curl --location --request POST 'developer_portal_rest_base/analytics/TRANSACTION_SUMMARY_FEED' \
--header 'Authorization: Basic basic_auth' \
--header 'Content-Type: application/json' \
--data-raw '{
"apis":["api_id"]
}'
Managing APIs
OverviewList of resourcesSample cURL CommandOverview
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
- POST /apis
- GET /apis/_count
- GET apis/available
- GET /apis/filter
- GET /apis/{id}
- PUT /apis/{id}
- DELETE /apis/{id}
- GET /apis/{id}/communities
- GET /apis/{id}/topic
- GET /apis/{id}/applications
- GET /apis/{id}/subscriptions
- GET /apis/{id}/versions
- GET /apis/{id}/stages
- GET /apis/{id}/followers
- PUT /apis/{id}/followers
- GET /apis/{id}/packages
- GET /apis/{id}/groups
- GET /apis/{id}/applications/available
- PUT /apis/{id}/rate
- GET /apis/{id}/rate
- GET /apis/{id}/followers/_count
- GET /apis/{id}/bookmarks
- POST /apis/{id}/try
- POST /apis/{id}/fileTypeTry
- GET /apis/{id}/try/history
- GET /apis/status/{referenceId}
- POST /apis/search
- GET /apis/{id}/try/history
- GET /apis/{id}/export
- PUT /apis/{id}/preferences
- PUT /apis/{id}/edits
- PUT /apis/{id}/logo
- PUT /apis/{id}/attachments
Retrieves the list of APIs in Developer Portal.
Publishes an API to Developer Portal.
Retrieves the count of APIs in Developer Portal.
Retrieves the list of APIs that are not mapped with any provider.
Retrieves the possible filter criteria of the given Id.
Retrieves API based on the given Id.
Updates API based on the given Id
Unpublishes API based on the given Id.
Retrieves the list of communities associated with the given Id.
Retrieves the list of topics for the given Id.
Retrieves the list of applications associated with the given Id.
Retrieves the list of subscriptions mapped with the given Id.
Retrieves the versions of the API.
Retrieves the stages of the API.
Retrieves the list of followers of the given Id.
Subscribes or unsubscribes to receive the updates of the given Id.
Retrieves the list of packages associated with the given Id.
Retrieves the list of groups associated with the given Id.
Retrieves the list of applications that can be associated with the given Id.
Allows to provide a rating for the given Id.
Retrieves the rating of the given Id.
Retrieves the number of followers for the given Id.
Retrives the list of topics of the given Id that are saved as bookmarks.
Allows to test the given Id.
Allows to test the multipart or binary type resources of the given Id.
Retrieves the details of tests performed for the given Id.
Retrieves the published status of an API based on the given reference Id.
Searches for an API based on the given search criteria.
Retrieves the details of tests performed for the given Id.
Exports the given Id.
Updates the view preference of the given Id.
Allows to edit the details of the given Id and its resources.
Allows to update the logo of the given Id.
Allows to update the attachments of the given Id.
Sample cURL Command
curl --location --request GET 'developer_portal_rest_base/apis' \
--header 'Authorization: Basic basic_auth'
Managing applications
OverviewList of resourcesSample cURL CommandOverview
This REST API is used to create applications, retrieve application information, share applications with require users or teams, and delete the existing applications using a REST API.
List of resources
- GET /applications
- POST /applications
- GET /applications/{id}
- PUT /applications/{id}
- DELETE /applications/{id}
- PUT /applications/{id}/share
- DELETE /applications/{id}/share
- GET /applications/_all
- GET /applications/{id}/requests
- GET /applications/{id}/tokens
- DELETE /applications/{id}/tokens/{tokenId}
- GET /applications/{id}/scopes
Retrieves the list of applications in Developer Portal for the current user.
Creates an application with the given data.
Retrieves the application associated with the given Id.
Updates the application associated with the given Id.
Deletes the application associated with the given Id.
Allows to share the specified application with a user or team.
Allows to revoke the access of the specified application.
Retrieves the list of applications in Developer Portal irrespective of the users associated with them.
Retrieves the users requests received for the specified application.
Retrieves the list of specified tokens generated for the specified application.
Deletes the specified tokens generated for the specified application.
Retrieves the list of scopes mapped with the specified application.
Sample cURL Command
curl --location --request GET 'developer_portal_rest_base/applications' \
--header 'Authorization: Basic basic_auth'
Managing approvals
OverviewList of resourcesSample cURL CommandOverview
This REST API is used to retrieve details of approval processes that are used to onboard a user, application, or subscription. You can also retrieve, approve, or reject the user or application onboarding requests.
List of resources
- GET /approvals
- POST /approvals
- GET /approvals/{id}
- PUT /approvals/{id}
- DELETE /approvals/{id}
- GET /approvals/policy
- PUT /approvals/policy
- GET /approvals/request
- GET /approvals/request/{id}
- PUT /approvals/request/{id}/approve
- PUT /approvals/request/external/{id}/approve
- PUT /approvals/request/approve
- PUT /approvals/request/{id}/reject
- PUT /approvals/request/external/{id}/reject
- PUT /approvals/request/reject
- GET /approvals/instance
- PUT /approvals/instance/step/{id}/request
- GET /approvals/instance/step/{id}/trace
- PUT /approvals/instance/step/{id}/logs
Retrieves the list of configured approval workflows in Developer Portal.
Creates a new approval workflow with the given details.
Retrieves the specified approval.
Updates the specified approval workflow with the given details.
Deletes the specified approval workflow.
Retrieves the approval workflow policy assigned to onboarding process.
Assign an approval workflow policy to onboarding process.
Retrieves the list of pending approval requests.
Retrieves the specified pending approval request.
Approves the specified approval request.
Approves the specified external approval request.
Approves the set of specified pending approval requests.
Rejects the specified approval request.
Rejects the specified external approval request.
Rejects the set of specified pending approval requests.
Retrieves the list of approval request details by their status.
Retrieves the approval request associated with the given Id.
Retrieves the approval request trace logs of the given approval Id.
Retrieves the approval request logs for the given Id.
Sample cURL Command
curl --location --request GET 'developer_portal_rest_base/approvals' \
--header 'Authorization: Basic basic_auth'
Managing backup and restore
OverviewList of resourcesSample cURL CommandOverview
This REST API is used to perform data backup and restore.
List of resources
- POST /data/backup
- POST /data/restore
- GET /data/status/{handle}/backup
- GET /data/status/{handle}
Creates a backup of the specified modules.
Restores the specified modules in the specified data file.
Downloads the specified backup file.
Retrieves the download status of the specified backup file.
Sample cURL Command
curl --location --request POST 'developer_portal_rest_base/data/backup/' \
--header 'xsrf-token: VbOuuiSA6K8YNWvN2D8Dl-I9sUU9GVM8bFZBMjVScFo' \
--header 'Authorization: Basic basic_auth' \
--header 'Content-Type: application/json' \
--data-raw '{
"modules": ["User","Collaboration","Theme","Core"]
}'
Managing comments
OverviewList of resourcesSample cURL CommandOverview
This REST API is used to add, retrieve, upvote or downvote, and delete comments under a topic.
List of resources
- GET /topics/{id}/comments
- POST /topics/{id}/comments
- GET /topics/{topicId}/comments/{id}
- PUT /topics/{topicId}/comments/{id}
- DELETE /topics/{topicId}/comments/{id}
- PUT /topics/{topicId}/comments/{id}/upvote
- PUT /topics/{topicId}/comments/{id}/downvote
- PUT /topics/{topicId}/comments/{id}/flag
Retrieves the list of comments for the given topic.
Creates a comment under the given topic.
Retrieves the details of a specified comment under the given topic.
Updates the specified comment under the given topic.
Deletes the specified comment under the given topic.
Upvotes the specified comment under the given topic.
Downvotes the specified comment under the given topic.
Adds a flag to the specified comment under the given topic.
Sample cURL Command
curl --location --request
GET 'developer_portal_rest_base/topics/topic_Id/comments' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic basic_auth' \
Managing communities
OverviewList of resourcesSample cURL CommandOverview
This REST API is used to add, view, update, or delete communities and their details.
List of resources
- GET /communities
- POST /communities
- GET /communities/{id}
- PUT /communities/{id}
- DELETE /communities/{id}
- GET /communities/{id}/apis
- PUT /communities/{id}/apis
- DELETE /communities/{id}/apis
- GET /communities/{id}/users
- PUT /communities/{id}/users
- DELETE /communities/{id}/users
- GET /communities/{id}/groups
- PUT /communities/{id}/groups
- DELETE /communities/{id}/groups
- PUT /communities/{id}/owner
- GET /communities/{id}/packages
- PUT /communities/{id}/packages
- DELETE /communities/{id}/packages
- GET /communities/{id}/ispublic
- GET /communities/{id}/administrators
- PUT /communities/{id}/packages
Retrieves the list of communities in Developer Portal.
Creates a new community with the given details.
Retrieves the details of the specified community.
Updates the specified community.
Deletes the specified community.
Retrieves the list of APIs associated with the specified community.
Add the given APIs to the specified community.
Delete the given APIs from the specified community.
Retrieves the list of users associated with the specified community.
Add the given users to the specified community.
Delete the given users from the specified community.
Retrieves the list of user groups associated with the specified community.
Add the given user groups to the specified community.
Delete the given user groups from the specified community.
Update the owner of the specified community.
Retrieves the list of packages associated with the specified community.
Add the given packages to the specified community.
Delete the given packages from the specified community.
Allows you to verify whether the specified community is a public community.
Retrieves the list of administrators of the specified community.
Add the given administrators to the specified community.
Sample cURL Command
curl --location --request GET 'developer_portal_rest_base/communities/' \
--header 'Authorization: Basic basic_auth'
Managing configurations
OverviewList of resourcesSample cURL CommandOverview
This REST API is administer Developer Portal settings such as SAML, LDAP, OAuth, user account settings, email notification templates and so on.
List of resources
- GET /configurations/smtp
- PUT /configurations/smtp
- DELETE /configurations/smtp
- GET /configurations/password_policy
- PUT /configurations/password_policy
- DELETE /configurations/password_policy
- GET /configurations/saml
- PUT /configurations/saml
- DELETE /configurations/saml
- GET /configurations/mfa
- PUT /configurations/mfa
- DELETE /configurations/mfa
- GET /configurations/oauth/{id}
- GET /configurations/oauth
- PUT /configurations/oauth
- DELETE /configurations/oauth
- GET /configurations/ldap_connection/{id}
- PUT /configurations/ldap_connection
- DELETE /configurations/ldap_connection
- GET /configurations/ldap_settings
- PUT /configurations/ldap_settings
- DELETE /configurations/ldap_settings
- POST /configurations
- GET /configurations/{category}
- POST /configurations/{category}
- DELETE /configurations/{category}
- GET /configurations/email-templates
- GET /configurations/email-templates/{templateId}
- PUT /configurations/email-templates/{templateId}
Retrieves the SMTP email server configuration.
Updates the SMTP email server configuration with the given details.
Deletes the SMTP email server configuration.
Retrieves the password policy settings.
Updates the SMTP password policy settings with the given details.
Resets the password policy settings to default.
Retrieves the SAML settings.
Updates the SAML settings with the given details.
Resets the SAML settings to default.
Retrieves the multi-factor authentication settings.
Updates the multi-factor authentication settings with the given details.
Resets the multi-factor authentication settings to default.
Retrieves the specified OAuth provider configuration.
Retrieves the OAuth configuration settings.
Updates the OAuth configuration settings with the given details.
Resets the OAuth configuration settings to default.
Retrieves the specified LDAP configuration settings.
Updates the LDAP configuration settings with the given details.
Deletes the LDAP configuration settings.
Retrieves the LDAP configuration settings.
Updates the LDAP configuration settings with the given details.
Deletes the LDAP configuration settings.
Creates a configuration payload with the given details.
Retrieves the configurations payload for the specified category.
Updates the specified configurations payload with the given details.
Deletes the specified configurations payload.
Retrieves the list email notifications templates.
Retrieves the specified email notifications template.
Updates the specified email notifications template with the given details.
Sample cURL Command
curl --location --request GET 'developer_portal_rest_base/configurations/smtp' \
--header 'Authorization: Basic basic_auth'
Viewing Developer Portal audit events
OverviewList of resourcesSample cURL CommandOverview
This REST API is used to view the audit events which will record the lifecycle of an API, Application, Packages, Plans, Community, Provider, Topic, Comment and monitor the subscriptions per package, access token requests per API, Developer Portal system usage and so on.
List of resources
- GET /events
Retrieves the list of audit events in Developer Portal.
Sample cURL Command
curl --location --request GET 'developer_portal_rest_base/events' \
--header 'Authorization: Basic basic_auth'
Viewing Developer Portal health
OverviewList of resourcesSample cURL CommandOverview
This REST API is used to view the Developer Portal health, build, and metrics.
List of resources
- GET /info
- GET /metrics
- GET /health
- GET /health/liveliness
- GET /health/readiness
- GET /env
Retrieves the Developer Portal build details.
Retrieves the Developer Portal application metrics.
Retrieves the Developer Portal health details.
Retrieves the Developer Portal health liveliness status.
Retrieves the Developer Portal health readiness status.
Retrieves the Developer Portal environment details.
Sample cURL Command
curl --location --request GET 'developer_portal_rest_base/info' \
--header 'Authorization: Basic basic_auth'
Managing notifications
OverviewList of resourcesSample cURL CommandOverview
This REST API is used to view, update, and delete notification preferences of the current user.
List of resources
- GET /users/preferences
- PUT /users/preferences
- GET /notifications
- PUT /notifications
- DELETE /notifications
- GET /notifications/_count
Retrieves the notification settings of the currently signed in user.
Updates the notification settings of the current user with the given details.
Retrieves the paginated notifications for the currently signed in user.
Updates the status of notifications as Read or Unread.
Deletes the notification settings of the currently signed in user.
Retrieves the number of unread notifications for the current user.
Sample cURL Command
curl --location --request GET 'developer_portal_rest_base/notifications/' \
--header 'Authorization: Basic basic_auth'
Getting OAuth token
OverviewList of resourcesSample cURL CommandOverview
This REST API is used to request access token and to receive authorization code for invoking APIs.
List of resources
- POST /oauth/tokens
- GET /oauth/callback
Requests token for the specified application using client credential grant.
Acts as the callback URL for receiving authorization code.
Sample cURL Command
curl --location --request POST 'developer_portal_rest_base/oauth/tokens' \
--header 'Authorization: Basic basic_auth' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "cc grant token",
"scope": "Read",
"applicationId": "application_id"
}'
Managing packages
OverviewList of resourcesSample cURL CommandOverview
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
- POST /packages
- GET /packages/{id}
- PUT /packages/{id}
- DELETE /packages/{id}
- GET /packages/{id}/plans
- PUT /packages/{id}/plans
- DELETE /packages/{id}/plans
- GET /packages/{id}/apis
- PUT /packages/{id}/apis
- DELETE /packages/{id}/apis
- GET /packages/{id}/communities
- GET /packages/{id}/topics
- GET /packages/{id}/rate
- PUT /packages/{id}/rate
- GET /packages/{id}/followers
- PUT /packages/{id}/followers
- GET /packages/{id}/followers/_count
Retrieves the list of packages in Developer Portal.
Create a package with the given details.
Retrieves the details of the specified package.
Updates the specified package with the given details.
Deletes the specified package.
Retrieves the list of plans for the specified package.
Updates the plans of the specified package with the given details.
Deletes the given plans from the specified package.
Retrieves the list of APIs in the specified package.
Updates the APIs of the specified package with the given details.
Deletes the given APIs from the specified package.
Retrieves the list of communities in the specified package.
Retrieves the list of topics in the specified package.
Retrieves the rating details of the specified package.
Updates the rating details the specified package with the given details.
Retrieves the list of followers of the specified package.
Updates the list of followers in the specified package with the given details.
Retrieves the number of followers for the specified package.
Sample cURL Command
curl --location --request GET 'developer_portal_rest_base/packages' \
--header 'Authorization: Basic basic_auth'
Managing plans
OverviewList of resourcesSample cURL CommandOverview
This REST API is used to manage plans. You can view, add, update, and delete the required plans.
List of resources
- GET /plans
- POST /plans
- GET /plans/{id}
- PUT /plans/{id}
- DELETE /plans/{id}
Retrieves the list of plans in Developer Portal.
Creates a plan with the given details.
Retrieves the details of the specified plan.
Updates the specified plan with the given details.
Deletes the specified plan.
Sample cURL Command
curl --location --request GET 'developer_portal_rest_base/plans' \
--header 'Authorization: Basic basic_auth'
Managing providers
OverviewList of resourcesSample cURL CommandOverview
This REST API is used to manage providers. You can view, add, update, and delete providers. You can also view, update and delete the APIs and packages associated with providers.
List of resources
- GET /providers
- POST /providers
- GET /providers/{id}
- PUT /providers/{id}
- DELETE /providers/{id}
- GET /providers/{id}/apis
- PUT /providers/{id}/apis
- DELETE /providers/{id}/apis
- GET /providers/{id}/packages
- PUT /providers/{id}/packages
- DELETE /providers/{id}/packages
Retrieves the list of providers in Developer Portal.
Creates or publishes a provider with the given details.
Retrieves the details of the specified provider.
Updates the specified provider with the given details.
Deletes the specified provider.
Retrieves the list of APIs associated with the specified provider.
Updates the specified APIs with the given details.
Deletes the specified APIs.
Retrieves the list of packages associated with the specified provider.
Updates the specified packages with the given details.
Deletes the specified packages.
Sample cURL Command
curl --location --request GET 'developer_portal_rest_base/providers' \
--header 'Authorization: Basic basic_auth'
Performing search
OverviewList of resourcesSample cURL CommandOverview
This REST API is used to search for an asset.
List of resources
- GET /search
- POST /search/basic
- GET /search/advanced
Searches for the APIs and packages that include the provided keyword.
Searches based on the given search criteria.
Searches for assets with provided keyword. Advanced search provides a metric which captures the number of assets matching given criteria in each asset type and also provides a detailed result on specific asset identified by `type`
.
Sample cURL Command
curl --location --request
GET 'developer_portal_rest_base/search?q=search_keyword' \
--header 'Authorization: Basic basic_auth'
Managing teams
OverviewList of resourcesSample cURL CommandOverview
This REST API is used to manage teams. You can view, add, update, and delete the required teams. You can also view, update, and delete the users associated with the team.
List of resources
- GET /teams
- POST /teams
- GET /teams/{id}
- PUT /teams/{id}
- DELETE /teams/{id}
- GET /teams/{id}/users
- PUT /teams/{id}/users
- DELETE /teams/{id}/users
- GET /teams/{id}/applications
Retrieves the list of teams in Developer Portal.
Creates a team with the given details.
Retrieves the details of the specified team.
Updates the specified team with the given details.
Deletes the specified team.
Retrieves the list of users associated with the specified team.
Updates the specified users associated with the specified team.
Updates the specified users associated with the specified team.
Retrieves the list of applications associated with the specified team.
Sample cURL Command
curl --location --request GET 'developer_portal_rest_base/teams' \
--header 'Authorization: Basic basic_auth'
Managing topics
OverviewList of resourcesSample cURL CommandOverview
This REST API is used to manage topics. You can add topics for required APIs and packages. You can also upvote, downvote, flag, or bookmark a topic.
List of resources
- POST /apis/{id}/topics
- POST /packages/{id}/topics
- GET /topics/{id}
- PUT /topics/{id}
- DELETE /topics/{id}
- PUT /topics/{id}/upvote
- PUT /topics/{id}/downvote
- PUT /topics/{id}/flag
- PUT /topics/{id}/pin
- PUT /topics/{id}/bookmarks
- GET /topics/{id}/upvote/_count
- GET /topics/{id}/downvote/_count
- GET /topics/{id}/flag/_count
- GET /topics/{id}/_count
- GET /collaboration/flags
- GET /collaboration/flagged
Creates a topic for the given API.
Creates a topic for the given package.
Retrieves the details of the given topic.
Updates the specified topic with the given details.
Deletes the specified topic.
Upvotes the specified topic.
Downvotes the specified topic.
Adds or removes flag from the specified topic.
Adds or removes pin from the specified topic.
Adds or removes bookmark from the specified topic.
Retrieves the number of upvotes for the specified topic.
Retrieves the number of downvotes for the specified topic.
Retrieves the number of flags for the specified topic.
Retrieves the number of upvotes, downvotes, and flags for the specified topic.
Retrieves the number of topics and comments that are flagged.
Retrieves the number of topics and comments that are flagged by administrators.
Sample cURL Command
curl --location --request
GET 'developer_portal_rest_base/topics/59d97968-7b25-4964-a0b7-d783ba910db2' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic basic_auth' \
--data-raw ''
Managing application and subscription requests
OverviewList of resourcesSample cURL CommandOverview
This REST API is used to manage application and subscription requests. You can view and retry application and subscription requests.
List of resources
- GET /requests
- POST /requests
- GET /requests/pending
- GET /requests/{id}
- DELETE /requests/{id}
- PUT /requests/{id}/retry
- GET /requests/{id}/trace
Retrieves the list of requests that belong to the specified type.
Creates an application or subscription request with given details.
Retrieves the list of pending requests that belong to the specified type.
Retrieves the specified request.
Deletes the specified request.
Retries the pending request for approval.
Retrieves the log trace of the specified request.
Sample cURL Command
curl --location --request GET 'developer_portal_rest_base/requests' \
--header 'Authorization: Basic basic_auth'
Managing users
OverviewList of resourcesSample cURL CommandOverview
This REST API is used to manage users and user groups. You can view, add, update, and delete users and their details.
List of resources
- POST /login
- POST /forgotpassword
- POST /resetpassword
- GET /passwordpolicy
- POST /signup
- PUT/users/updatepassword
- PUT /users/updateemail
- PUT /users/updatepicture
- GET /users
- POST /users
- GET /users/self
- GET /users/self/privileges
- GET /users/{id}
- PUT /users/{id}
- DELETE /users/{id}
- POST /users/delete
- GET /groups/{id}/users
- PUT /groups/{id}/users
- DELETE /groups/{id}/users
- GET /groups
- POST /groups
- GET /groups/{id}
- POST /groups/{id}
- DELETE /groups/{id}
Signs in to Developer Portal with the provided credentials. This API supports the Native or LDAP users login only.
Allows to recover a forgotten password via the registered email.
Allows to reset your password via the registered email.
Retrieves the details configured password policy.
Allows to sign up to Developer Portal.
Updates the password with the provided value.
Updates the email with the provided value.
Updates the profile picture with the provided image.
Retrieves the list of users.
Creates a new user with the given details.
Retrieves the details of the currently signed in user.
Retrieves the privileges of the currently signed in user.
Retrieves the details of specified user.
Updates the user name such as the first name, last name, email of specific user.
Deletes the specified user.
Deletes the account of current user.
Retrieves the users of the specified group.
Updates the users of the specified group with the given details.
Deletes the given users of the specified group.
Retrieves the list of groups.
Creates a group with the given details.
Retrieves the details of the specified group.
Updates the specified group with the given details.
Deletes the specific group.
Sample cURL Command
curl --location --request GET 'developer_portal_rest_base/users/' \
--header 'Authorization: Basic basic_auth'
Managing webhooks
OverviewList of resourcesSample cURL CommandOverview
This REST API is used to manage webhooks. You can view, add, update, and delete webhooks.
List of resources
- GET /hooks
- POST /hooks
- GET /hooks/{id}
- POST /hooks/{id}
- DELETE /hooks/{id}
- GET /hooks/events
Retrieves the list of webhooks.
Creates a webhook with the given details.
Retrieves the details of the specified webhook.
Updates the specified webhook with the given details.
Deletes the specific webhook.
Retrieve the list of events to which a webhook can be created.
Sample cURL Command
curl --location --request GET 'developer_portal_rest_base/hooks/' \
--header 'Authorization: Basic basic_auth'