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

Synack

Connection Requirements

1 - Domain

The domain of the Synack Enterprise API. Keep the default value for the Synack SaaS platform. Replace it only if your organization connects through a different Synack API host.

Default: api.synack.com

2 - Client Domain

The domain of the Synack Asset service, which hosts the attack surface assets and is served separately from the Enterprise API. Keep the default value for the commercial platform, or use client.synack.us for FedRAMP.

Default: client.synack.com

3 - Api Key

The API token used as a Bearer token in the Authorization header. It must have permission to read organization users and organization assets.

You can follow the steps below.

  1. In the Synack Client portal, navigate to Settings > API > Tokens.

  2. In the IPv4 Address field, use the ***** wildcard, or set a known consistent source IP for API requests.

  3. Optionally set an Expires At date, then create the token and copy its value.

Store the token securely. A token scoped with limited permissions will return only the users and assets it is allowed to read.

4 - Fetch Users

Collects the platform members of the Synack Client organization. Turn this off when the token has no permission to read users, or when only the attack surface hosts are wanted. (default: enabled)

5 - Proxy URL

Proxy URL (optional).

6 - Timeout

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

Last updated

Was this helpful?