For the complete documentation index, see llms.txt. This page is also available as Markdown.

OX Security

Connection Requirements

1 - Domain

The domain of the OX Security API. Keep the default value for SaaS deployments. If your OX deployment is hosted on-prem, replace it with your organization's OX domain.

Default: api.cloud.ox.security

2 - Api Key

The API Key Secret generated for an API Integration key. The key must have a role and scope that allow reading organization members.

You can follow the steps below.

  1. In the OX Security console, navigate to Settings > API Key Settings.

  2. Select CREATE API KEY.

  3. Set a meaningful API Key Name, select API Integration as the API Key Type, and set an Expiration Date.

  4. Select CREATE, then copy the API Key Secret.

The secret is shown only once and must be saved somewhere. A key scoped to a subset of applications will return only the members it is allowed to see.

3 - Proxy URL

Proxy URL (optional).

4 - Timeout

The amount of time (in seconds) to wait for API responses. (default: 30)

The OX API is rate limited to 1,000 requests per hour and 15,000 requests per day per API key.

Last updated