REST API v2 for Client

You can now use REST API v2 to view, Create, Read, Update, and Delete (CRUD) operations for Netskope Client. Use the API to automate repetitive changes, keep configurations consistent across your organizational units (OUs) and groups, and connect the configurations to your own tools and scripts. To learn more, go to  Settings > Tools > REST API v2 > API Documentation to access the Swagger documentation.

Prerequisites

Before you manage Client using REST API v2, ensure that you have the following:

• Confirm that the endpoints are available for your tenant. Go to Settings > Tools > REST API v2 > API Documentation and search for the specific section for the set of API. For example, for Client Configuration search for clientconfiguraation section.

• Obtain a valid REST API v2 token from a service account. You can create a service account under Settings > Administration > Administrators & Roles > Administrators. Include the token in every request: [Confirm header: Authorization: Bearer <token> or Netskope-Api-Token: <token>]. For details, see REST API v2 overview.

• Ensure that the service account’s role grants View access for read operations, or Manage access to create, update, and delete operations. API calls are subject to role-based access control. To learn more, see Configure RBAC-Role Based Access Control.

• Allowlist API client source IP addresses. If IP restrictions are enabled, make sure your REST API v2 scripts and integrations connect from permitted source IP addresses:

  • If a role-based IP allowlist is enabled for the service account’s assigned role, add the source IP addresses to that allowlist. The role-based allowlist takes precedence over the global IP allowlist, so adding addresses only to the global Custom IP list doesn’t grant access.

  • If no role-based allowlist applies, add the source IP addresses to the Custom IP list under Settings > Administration > IP Allowlist. This applies when the global IP allowlist is enabled.

• Ensure that any features associated with the settings you plan to configure are enabled for your tenant. Some settings are available only when the corresponding tenant feature is enabled.

All requests use this base URL:

https://<tenant-name>.goskope.com/api/v2/

All endpoint paths in this topic are relative to this base URL. For example, clientconfiguration/client/config means https://<tenant-name>.goskope.com/api/v2/clientconfiguration/client/config . The curl examples show the full URL.  Replace <tenant-name> with your tenant name.

Send your token in the Authorization header of every request, in the format Authorization: Bearer <token>.

Client Configurations Using REST API v2

Manage Netskope Client Configurations programmatically using REST API v2, without signing in to the Netskope UI. Go to Settings > Tools > REST API v2 > API Documentation and search for clientconfiguration section for the set of REST API v2 for Client Configuration.

Endpoints

All paths are relative to :

/api/v2/clientconfiguration

Client Configurations Endpoints

The table lists the available REST API v2 endpoints for Client Configuration.

Method	Endpoint	Description
GET	/client/config	Lists Client configurations. Supports name search, paging, and filtering by target.
POST	/client/config	Creates a Client configuration.
GET	/client/config/{id}	Returns one Client configuration.
PATCH	/client/config/{id}	Updates only the fields you send.
DELETE	/client/config/{id}	Deletes one Client configuration.
POST	/client/config/bulkdelete	Starts an asynchronous job that deletes all configurations except the default one.
GET	/client/config/bulkstatus/{jobid}	Returns the status of a bulk delete job.
GET	/client/versions	Lists Client versions you can use in update policies.
GET	/client/platforms	Lists supported platforms and minimum Client versions for one-time disable.
GET	/client/gslbpops	Lists available GSLB zone options and their UUIDs for Client Configuration zone selection.
GET	/client/config/swgglobalattributes	Returns the current state of all Internet Security global attributes for your tenant.
PATCH	/client/config/swgglobalattributes	Turns one or more Internet Security global attributes on or off.