The Redox Platform API is an API tool that allows you to manage your Redox organization. Learn more about the Redox Platform API.
To send a Platform API request, you must create and authenticate a user-level API key, which authorizes an individual requesting user. Some API functionalities might be restricted, depending on the individual user’s permissions.
- A user must be assigned to an engineer role to create or authenticate API keys. Learn about user roles.
- If you choose option 2 for creating a user-level API key, you must have an existing public key. This can be either a JWKS URL or or JWKS entry.
- Log in to the Redox dashboard.
- Click your username at the bottom of the navigation menu.
- From the user menu, select the User settings option.
![The User settings option appears in the user menu at the bottom left of the Redox dashboard.]( "The User settings option appears in the user menu at the bottom left of the Redox dashboard.")
User settings option - By default, the User info tab opens. Click the User API keys tab.
- The User API keys page opens with any existing user-level API keys. Click the New button.
- The Details page opens. In the Name field, enter the API key name.
- Choose one of the following options to continue:
Next, you must request an access token with an auth request. Follow the OAuth API key instructions for requesting and storing an access token.
After getting an access token, you’re ready to initiate API requests to any of the Platform API endpoints: https://api.redoxengine.com/platform/{endpoint}.
Each Platform endpoint has different requirements, path parameters, or request parameters. Explore each endpoint schema for their respective requirements.