API Reference
Introduction Authentication Core API Connectors API Workflows API Monitoring API Error Handling Rate Limits
Resources
Documentation SDK Downloads Postman Collection OpenAPI Specification Service Status

NexxusBridge API Reference

Complete reference documentation for the NexxusBridge API, including request formats, response schemas, and example code.

Introduction

Base URL

All API requests should be made to the following base URL:

https://api.nexxusbridge.com/v1

For organizations with dedicated environments, use your custom domain.

Request Format

The NexxusBridge API accepts requests with JSON-encoded bodies. All requests must include the following headers:

Header Description
Content-Type Must be set to application/json
Authorization Your API key in the format Bearer YOUR_API_KEY
Accept Should be set to application/json

Response Format

All API responses are returned as JSON objects with the following structure:

{
  "status": "success",
  "data": {
    // Response data
  },
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 25
  }
}

For error responses, the structure is:

{
  "status": "error",
  "error": {
    "code": "invalid_request",
    "message": "Detailed error message",
    "details": { }
  }
}

Authentication

API Keys

All API requests must include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

You can manage your API keys from your account dashboard.

API Key Rotation

We recommend rotating your API keys periodically for security. When rotating keys, create a new key first, update your applications to use the new key, then disable the old key.

Core API

Returns a list of all accounts associated with your organization.

Parameters
Parameter Type Description
page integer Page number for paginated results (optional, default: 1)
per_page integer Number of results per page (optional, default: 10, max: 100)
status string Filter by account status (optional, values: active, inactive, pending)
Example Request
curl -X GET https://api.nexxusbridge.com/v1/accounts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Example Response
{
  "status": "success",
  "data": [
    {
      "id": "acc_12345",
      "name": "Example Account",
      "status": "active",
      "created_at": "2025-01-15T12:00:00Z",
      "updated_at": "2025-04-01T10:30:00Z"
    },
    {
      "id": "acc_67890",
      "name": "Demo Account",
      "status": "active",
      "created_at": "2025-02-20T14:30:00Z",
      "updated_at": "2025-02-20T14:30:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 2
  }
}

Creates a new connection to a third-party service.

Request Body
Parameter Type Description
name string A name for the connection (required)
service_type string The type of service (required, e.g., aws, azure, gcp, workday)
credentials object The credentials for the connection (required, format depends on service_type)
Example Request
curl -X POST https://api.nexxusbridge.com/v1/connections \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "My AWS Connection",
    "service_type": "aws",
    "credentials": {
      "access_key_id": "AKIA123456789EXAMPLE",
      "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
      "region": "us-west-2"
    }
  }'
Example Response
{
  "status": "success",
  "data": {
    "id": "conn_12345",
    "name": "My AWS Connection",
    "service_type": "aws",
    "status": "active",
    "created_at": "2025-05-01T09:00:00Z",
    "updated_at": "2025-05-01T09:00:00Z"
  }
}