Skip to main content

Netskope Source

Netskope icon

The Netskope Source provides a secure endpoint to receive event data from the Netskope API. It securely stores the required authentication, scheduling, and state tracking information.

The following event types are available to collect:

  • alert (collected by default, can be turned off with Disable Alerts)
  • application
  • audit
  • infrastructure
  • network
  • page
  • connection
  • incident
  • endpoint
note

Upgrade the Netskope source to the latest version 2.x.x for a seamless data collection experience. Older versions may be discontinued, so upgrading ensures continued support and the latest improvements. For upgrade instructions, see Cloud-to-Cloud Source Versions

Data collected​

Polling IntervalData
5 secEvent data
note
  • The Source is limited to 4 requests per second per endpoint.
  • The Source retries requests that return 429, 409, or 5xx errors, up to 10 times.
  • A new Source starts collecting from its creation time. Historical events are not backfilled.
  • If Netskope returns a 401 or 403 error, the Source shows a configuration error. Check that your API token is valid and has the required permissions.

Setup​

Vendor configuration​

Netskope REST API v2​

note

This API is used by the Sumo Logic Netskope source starting with v2.0.0.

Netskope REST API v2 provides an easy way to extend the Netskope platform to build use cases specific to your organization. Endpoints cover key areas, including Events, Alerts, Reports, Clients, and more.

To obtain a Netskope REST API v2 auth token, do the following:

  1. Log in to Netskope as the Tenant Admin.
  2. Go to the API section of Netskope: Settings > Tools > REST API v2.
  3. Click New Token and provide the token name and expiration duration, then add the READ privilege to /api/v2/events/dataexport/events/<type> for every event type you want to collect, where <type> is one of page, application, infrastructure, audit, network, connection, incident, or endpoint. Also add READ permission for /api/v2/events/dataexport/events/alert unless you enable Disable Alerts in the Source configuration.
  4. Copy the token in the next dialog box and save it somewhere, as it won't be visible after.

Netskope REST API v2 with RBAC v3​

If your Netskope tenant uses RBAC v3, you need to create a custom role and Service Account to generate a REST API v2 token for the Sumo Logic Netskope Source. The legacy token workflow described above does not apply to RBAC v3 tenants.

Step 1: Create a custom role​
  1. Log in to the Netskope Admin Console.
  2. Navigate to Settings > Administration > Administrators & Roles > Roles tab.
  3. Click New.
  4. Enter a Name for the role (for example, SumoLogic-Collector).
  5. Select the following functional areas and assign View permission to each. These permissions provide access to the REST API v2 endpoints used by the Sumo Logic Netskope Source (/api/v2/events/data/{eventType} and /api/v2/events/dataexport/events/{eventType}).
    • Under Administration:
      • Audit Log. Enables the collection of audit events.
    • Under DLP:
      • Incidents. Enables the collection of incident events.
    • Under Infrastructure:
      • Infrastructure Log and On-Premises. Enables the collection of infrastructure events.
    • Under Skope IT:
      • Alerts. Enables the collection of alert events.
      • Application Events. Enables the collection of application events.
      • Endpoint Events. Enables the collection of endpoint events.
      • Network Events. Enables the collection of network events.
      • Page Events. Enables the collection of page and connection events.
  6. Click Save.
note

You only need to enable View permissions for the event types you intend to collect. At minimum, enable Alerts unless you set Disable Alerts to true in the Source configuration, because the integration performs a health check against the alerts endpoint on startup.

Step 2: Create a Service Account​
  1. Navigate to Settings > Administration > Administrators & Roles > Administrators tab.
  2. Click Service Account.
  3. Assign the role you created in Step 1.
  4. Click Create. A REST API v2 token is automatically generated.
  5. Copy the token. This is the API Token value required for the Sumo Logic Source configuration.
info

Store the token securely. It is not displayed again after you close the dialog.

Netskope REST API v1 (Deprecated)​

Deprecated

This applies only to Sumo Logic Netskope Source version 1.3.1 and earlier. We recommend upgrading to version 2.0.0 or later.

Netskope RESTv1 APIs use an auth token to make authorized calls to the API. This section demonstrates how to obtain a token from the Netskope user interface (UI).

To obtain a Netskope auth token, do the following:

  1. Log in to Netskope as the Tenant Admin.
  2. Go to the API section of Netskope: Settings > Tools > ** REST API v1**.
  3. Copy the existing token to your clipboard, or generate a new token and copy it.

Source configuration​

When you create a Netskope Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector.

To configure a Netskope Source:

  1. New UI. In the Sumo Logic main menu, select Data Management, and then under Data Collection select Collection. You can also click the Go To... menu at the top of the screen and select Collection.  
    Classic UI. In the main Sumo Logic menu, select Manage Data > Collection > Collection.
  2. On the Collectors page, click Add Source next to a Hosted Collector.
  3. Search for and select Netskope.
  4. Enter a Name for the Source. The description is optional.
  5. (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
  6. Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM.
    note
    • The Forward to SIEM checkbox is only available if Cloud SIEM is installed.
    • For C2C sources where the checkbox is already provided, there's no need to add _siemForward=true (case-sensitive), since the checkbox alone handles forwarding to SIEM.
  7. (Optional) Fields. Click the +Add Field link to define the fields you want to associate. Each field needs a name (key) and a value.
    • Green check circle A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
    • Orange exclamation point An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, you'll see an option to automatically add or enable the nonexistent fields to the Fields table schema. If a field is sent to Sumo Logic but isn’t present or enabled in the schema, it’s ignored and marked as Dropped. 
  8. Enter your Netskope Tenant ID. Enter only the subdomain of your Netskope tenant URL, without https:// and without the top-level domain (goskope.com, or govskope.us for government accounts). The Source adds the domain automatically. For example:
    • https://tenant.goskope.com becomes tenant
    • https://tenant.eu.goskope.com becomes tenant.eu
  9. Government Account. Select Government Account if your tenant is a Netskope government account. The Source then uses https://<tenant>.govskope.us instead of goskope.com.
  10. Enter the Netskope API Token you want to use to authenticate requests.
  11. (Optional) Event Types. Select the event types to collect. If this field is empty, Netskope collects all eight event types (page, application, infrastructure, audit, network, connection, incident, and endpoint). Your token needs READ permission for every selected event type. If you collect all event types and Netskope adds a new type later, you might need to update your token.
  12. Disable Alerts. Alert events are collected by default. Select Disable Alerts to stop collecting them.
  13. Processing Rules. Configure any desired filters, such as include, exclude, hash, or mask, as described in Create a Processing Rule.
  14. When you are finished configuring the Source, click Submit.
tip

After configuring the Netskope source, consider installing the Sumo Logic app for Netskope to visualize and analyze the collected data using prebuilt dashboards and monitor alerts.

Metadata fields​

FieldValueDescription
_siemVendorNetskopeSet when Forward To SIEM is checked.
_siemProductSecurity CloudSet when Forward To SIEM is checked.
_siemFormatJSONSet when Forward To SIEM is checked.
_siemEventID<eventType>Where eventType is one of the above event types, with one exception. If the eventType is audit and the description contains logon/login or logoff/logout, the eventType field will be the eventType with the value -logon or -logoff added respectively, such as audit-logon or audit-logoff.

JSON schema​

You can configure sources using UTF-8-encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details. 

ParameterTypeValueRequiredDescription
schemaRefJSON Object{"type":"Netskope"}YesDefine the specific schema type.
sourceTypeString"Universal"YesType of source.
configJSON ObjectConfiguration objectYesSource type specific values.

Configuration Object​

ParameterTypeRequiredDefaultDescriptionExample
nameStringYesnullType a desired name of the source. The name must be unique per Collector. This value is assigned to the metadata field _source."mySource"
descriptionStringNonullType a description of the source."Testing source"
categoryStringNonullType a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details."mySource/test"
fieldsJSON ObjectNonullJSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.{"_siemForward": false, "fieldA": "valueA"}
tenantIDStringYesnullSubdomain of your Netskope tenant URL, without https:// and without the domain (goskope.com, or govskope.us for government accounts). The Source adds the domain automatically."tenant.eu"
isGovAccountBooleanNofalseSet to true for a Netskope government account. The Source then uses https://<tenant>.govskope.us instead of goskope.com.false
apiTokenStringYesnullThe Netskope API Token you want to use to authenticate requests.
eventTypesArray of StringsNoallDefines the types of events to collect. Accepted values are page, application, infrastructure, audit, network, connection, incident, and endpoint. If empty, all eight types are collected.["page","audit"]
disableAlertsBooleanNofalseAlert events are collected by default. Set to true to stop collecting them.false

JSON example​

static/files/c2c/netskope/example.json
loading...

Terraform example​

static/files/c2c/netskope/example.tf
loading...

FAQ​

info

Click here for more information about Cloud-to-Cloud sources.

Additional resources​

Legal
Privacy Statement
Terms of Use
CA Privacy Notice

© 2010 – 2026 Sumo Logic, Inc.