Redox

Redox Platform API

The Redox Platform API manages Redox organization configuration as code, exposing endpoint categories for access control, alerts, audit events, configs, config modifiers, credentials, destinations, environments, filters, logs, OAuth API keys, promotions, sources, subscriptions, translation sets, and VPNs. Requests authenticate with user-level API keys issued from the Redox dashboard, and responses use a wrapper envelope with `meta` and `payload` (single `record` or plural `records`) fields, supporting GitOps-style management of integration topology across development, staging, and production environments.

Redox Platform API is one of 4 APIs that Redox publishes on the APIs.io network.

Tagged areas include Audit Events, Configuration, Connections, Destinations, and Environments. The published artifact set on APIs.io includes API documentation, an API reference, authentication docs, and rate-limit docs.

GitHub

Documentation

📖
Documentation
https://docs.redoxengine.com/api-reference/platform-api/
📖
APIReference
https://docs.redoxengine.com/api-reference/platform-api/
📖
Authentication
https://docs.redoxengine.com/api-reference/platform-api/authenticate-a-user-level-api-key/
📖
RateLimits
https://docs.redoxengine.com/api-reference/quotas-and-constraints/

Other Resources

🔗
Errors
https://docs.redoxengine.com/api-reference/error-handling-and-responses/

API entry from apis.yml

apis.yml Raw ↑ 
aid: redox-engine:redox-platform-api
name: Redox Platform API
tags:
- Audit Events
- Configuration
- Connections
- Destinations
- Environments
- Filters
- Management
- Sources
- Subscriptions
- Translation Sets
humanURL: https://docs.redoxengine.com/api-reference/platform-api/
baseURL: https://api.redoxengine.com/platform
properties:
- url: https://docs.redoxengine.com/api-reference/platform-api/
  type: Documentation
- url: https://docs.redoxengine.com/api-reference/platform-api/
  type: APIReference
- url: https://docs.redoxengine.com/api-reference/platform-api/authenticate-a-user-level-api-key/
  type: Authentication
- url: https://docs.redoxengine.com/api-reference/error-handling-and-responses/
  type: Errors
- url: https://docs.redoxengine.com/api-reference/quotas-and-constraints/
  type: RateLimits
description: The Redox Platform API manages Redox organization configuration as code, exposing endpoint
  categories for access control, alerts, audit events, configs, config modifiers, credentials, destinations,
  environments, filters, logs, OAuth API keys, promotions, sources, subscriptions, translation sets, and
  VPNs. Requests authenticate with user-level API keys issued from the Redox dashboard, and responses
  use a wrapper envelope with `meta` and `payload` (single `record` or plural `records`) fields, supporting
  GitOps-style management of integration topology across development, staging, and production environments.