Get started using the Edge APIs:
Use the Edge APIs
For details about using the Edge APIs:
Try the Edge APIs
Each API reference page contains a Try this API panel that lets you execute the API directly in the UI and provides example calls using tools such as curl.
Before you can execute an API in the Try this API panel, you must enter your credentials.
Click Authorize.
Enter your credentials.
Note: Apigee recommends using OAuth2 tokens with Bearer authorization to access the Edge API.For OAuth, enter Bearer <your-token>. See Get the tokens.
For Basic Auth, enter your Apigee Edge username (email address) and password.
Note: If your Apigee account has MFA enabled, Basic Authentication will not work.
Click Authorize.
Click OK to close the Authorization dialog.
To execute an API in the Try this API panel:
- Enter values for the request parameters, as required.
For more API calls, you need to provide your organization name. - Enter values for the request body, as required.
- Select whether you want to use Basic or OAuth credentials for the call.
Ensure that the credentials are defined, as described above. - Click Execute to execute the API call.
Troubleshoot
If you encounter the following error when executing an API in the Try this API panel:
An unknown error occurred while making the request.
Ensure the following:
- You have provided your credentials for the selected authorization type.
- The path and query parameters and request payload are entered correctly.
- The API can be executed in the Try this API panel.
APIs that cannot be executed in the Try this API panel are noted in the documentation.
View response payloads
View response payloads without having to execute the API.
Download OpenAPI Specifications
Download the OpenAPI Specification for an API by clicking Download Spec.
Filter APIs by category
Filter APIs by clicking a category under Filter by category.