Zscaler Cloud & Branch Connector

https://help.zscaler.com/cloud-branch-connector
Admin
Zscaler Cloud & Branch Connector provides zero-trust security and secure connectivity for cloud...
Tokens:332,645
Snippets:903
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Zscaler Cloud & Branch Connector API - Getting Started

Source: https://help.zscaler.com/cloud-branch-connector/release-notes

Information on how to get started with the Zscaler Cloud & Branch Connector API, including initial setup and prerequisites.

```APIDOC
## Zscaler Cloud & Branch Connector API - Getting Started

### Description
This section provides an overview of how to begin using the Zscaler Cloud & Branch Connector API. It covers essential steps and prerequisites for successful integration.

### Method
GET

### Endpoint
/api/v1/getting-started

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your unique API key for authentication.

### Request Example
```json
{
  "description": "Example request to get started with the API."
}
```

### Response
#### Success Response (200)
- **message** (string) - A success message indicating you can proceed.
- **documentation_link** (string) - A link to more detailed API documentation.

#### Response Example
```json
{
  "message": "Welcome to the Zscaler Cloud & Branch Connector API. You are authenticated successfully.",
  "documentation_link": "/api/v1/reference"
}
```
```

--------------------------------

### Zscaler Cloud & Branch Connector API - Getting Started

Source: https://help.zscaler.com/cloud-branch-connector/forwarding/log-and-control-forwarding

Guides users on how to get started with the Zscaler Cloud & Branch Connector API, including initial setup and configuration.

```APIDOC
## Zscaler Cloud & Branch Connector API - Getting Started

### Description
This endpoint provides a starting point for developers looking to integrate with the Zscaler Cloud & Branch Connector API.

### Method
GET

### Endpoint
/api/v1/help/cloud-branch-connector-api/getting-started

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **documentation** (string) - General introductory information and prerequisites for using the API.

#### Response Example
```json
{
  "documentation": "Welcome to the Zscaler Cloud & Branch Connector API! This guide will help you set up and start using our powerful API..."
}
```
```

--------------------------------

### Zscaler Cloud & Branch Connector API - Getting Started

Source: https://help.zscaler.com/cloud-branch-connector/forwarding/traffic-forwarding

Introduction to the Zscaler Cloud & Branch Connector API, including setup and basic usage.

```APIDOC
## Zscaler Cloud & Branch Connector API - Getting Started

### Description
This section provides an overview and initial steps for using the Zscaler Cloud & Branch Connector API.

### Method
N/A (Documentation Overview)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### API Developer & Reference Guide

Source: https://help.zscaler.com/cloud-branch-connector/analytics-monitoring

Details on getting started with the API, configuring Postman, understanding response codes, error messages, and rate limits.

```APIDOC
## API Developer & Reference Guide

### Description
This guide covers essential aspects for developers using the Zscaler Cloud & Branch Connector API, including initial setup, error handling, and performance considerations.

### Sections:
- **Getting Started**: Initial steps to begin using the API.
- **Configuring the Postman REST API Client**: Instructions for setting up Postman for API testing.
- **API Response Codes and Error Messages**: Explanations of common response codes and error messages.
- **Understanding Rate Limits**: Information on API request limits to prevent abuse and ensure service stability.
```

--------------------------------

### API Developer & Reference Guide

Source: https://help.zscaler.com/cloud-branch-connector/administration

Guides for developers using the Zscaler Cloud & Branch Connector API, including getting started, configuration, response codes, and rate limits.

```APIDOC
## API Developer & Reference Guide

### Description
This guide covers essential information for developers working with the Zscaler Cloud & Branch Connector API.

### Sections
- **Getting Started**: Initial steps to begin using the API.
- **Configuring the Postman REST API Client**: Instructions for setting up Postman for API testing.
- **API Response Codes and Error Messages**: Understanding the meaning of different API responses and error indicators.
- **Understanding Rate Limits**: Information on API usage limitations to prevent abuse.
```

--------------------------------

### API Developer & Reference Guide

Source: https://help.zscaler.com/cloud-branch-connector/deployment-management-virtual-devices

Guides for developers using the Zscaler Cloud & Branch Connector API, including setup, response codes, rate limits, and detailed reference information.

```APIDOC
## API Developer & Reference Guide

### Description
This guide covers essential information for developers working with the Zscaler Cloud & Branch Connector API, including initial setup, error handling, and usage best practices.

### Method
N/A (Documentation Section)

### Endpoint
N/A (Documentation Section)

### Parameters
N/A

### Request Example
N/A

### Response
N/A

#### Getting Started
Guides on how to begin using the API.

#### Configuring the Postman REST API Client
Instructions for setting up Postman to interact with the API.

#### API Response Codes and Error Messages
Details on understanding and handling API responses and errors.

#### Understanding Rate Limits
Information regarding the API's rate limiting policies.

#### Reference Guide
Detailed reference for various API resources:

##### Activation
Information on API endpoints related to activation processes.

##### Admin and Role Management
Details on managing administrators and roles via the API.

##### Authentication
Information on how to authenticate API requests.

##### Cloud & Branch Connector Groups
Endpoints for managing Cloud & Branch Connector groups.

##### Forwarding Gateways
API details for configuring forwarding gateways.
```

--------------------------------

### API Developer & Reference Guide

Source: https://help.zscaler.com/cloud-branch-connector/deployment-management/cloud-connector-deployment-management

Guides for developers using the Zscaler Cloud & Branch Connector API, covering setup, response codes, rate limits, and reference details.

```APIDOC
## API Developer & Reference Guide

### Description
This guide offers comprehensive information for developers working with the Zscaler Cloud & Branch Connector API. It includes getting started instructions, details on API response codes and error messages, and an explanation of rate limits.

### Method
N/A (Guide)

### Endpoint
N/A (Guide)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Getting Started with the API

### Description
This section provides initial steps and prerequisites for using the Zscaler Cloud & Branch Connector API.

### Method
N/A (Guide)

### Endpoint
N/A (Guide)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Configuring the Postman REST API Client

### Description
Instructions on how to set up and configure the Postman REST API client for interacting with the Zscaler Cloud & Branch Connector API.

### Method
N/A (Guide)

### Endpoint
N/A (Guide)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## API Response Codes and Error Messages

### Description
A comprehensive list and explanation of the API response codes and error messages returned by the Zscaler Cloud & Branch Connector API.

### Method
N/A (Guide)

### Endpoint
N/A (Guide)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Understanding Rate Limits

### Description
Information on the rate limits imposed on the Zscaler Cloud & Branch Connector API, including details on how they are applied and managed.

### Method
N/A (Guide)

### Endpoint
N/A (Guide)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Zscaler Cloud & Branch Connector API - Overview

Source: https://help.zscaler.com/cloud-branch-connector/administration/branch-connector-device-management

This section provides an overview of the Zscaler Cloud & Branch Connector API, including getting started guides, authentication, and general usage information.

```APIDOC
## Understanding the Zscaler Cloud & Branch Connector API

### Description
This API allows for programmatic management and configuration of Zscaler Cloud and Branch Connectors.

### Getting Started
Guides on how to begin using the API.

### API Developer & Reference Guide

#### Configuring the Postman REST API Client
Instructions for setting up Postman to interact with the API.

#### API Response Codes and Error Messages
Details on the meaning of different response codes and common error messages.

#### Understanding Rate Limits
Information about usage limits and how to manage them.

### Reference Guide

#### Activation
Endpoints related to activating or deactivating connectors.

#### Admin and Role Management
APIs for managing administrative users and their roles.

#### Authentication
Details on how to authenticate API requests.

#### Cloud & Branch Connector Groups
Endpoints for managing groups of connectors.

#### Forwarding Gateways
APIs for configuring forwarding gateways.
```

--------------------------------

### API Developer & Reference Guide

Source: https://help.zscaler.com/cloud-branch-connector/forwarding/dns-policies

Detailed guides for developers using the Zscaler Cloud & Branch Connector API, including setup, authentication, error handling, and rate limits.

```APIDOC
## API Developer & Reference Guide

### Description
This guide covers essential information for developers working with the Zscaler Cloud & Branch Connector API, from initial setup to understanding response codes and limits.

#### Getting Started
Instructions on how to begin using the API.

#### Configuring the Postman REST API Client
Step-by-step guide to set up Postman for testing API calls.

#### API Response Codes and Error Messages
Explanation of common response codes and error messages returned by the API.

#### Understanding Rate Limits
Information on API rate limits and best practices to adhere to them.

```

--------------------------------

### API Developer & Reference Guide

Source: https://help.zscaler.com/cloud-branch-connector/administration/administrator-role-management

Guides and references for developers using the Zscaler Cloud & Branch Connector API, including setup, response codes, and rate limits.

```APIDOC
## API Developer & Reference Guide

### Description
This guide covers essential information for developers using the Zscaler Cloud & Branch Connector API. It includes getting started instructions, client configuration, understanding API responses, and rate limiting.

### Method
N/A (Documentation Section)

### Endpoint
N/A (Documentation Section)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Getting Started with the API

### Description
Provides initial steps and prerequisites for using the Zscaler Cloud & Branch Connector API.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Configuring the Postman REST API Client

### Description
Instructions on how to set up and configure Postman for interacting with the Zscaler Cloud & Branch Connector API.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## API Response Codes and Error Messages

### Description
Details about the standard HTTP response codes and common error messages returned by the Zscaler Cloud & Branch Connector API.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Understanding Rate Limits

### Description
Information regarding the rate limits imposed on API requests to ensure service stability and fair usage.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Zscaler Cloud & Branch Connector API - Getting Started

Source: https://help.zscaler.com/cloud-branch-connector/getting-started

This section provides an overview and initial steps for using the Zscaler Cloud & Branch Connector API.

```APIDOC
## Introduction to the Zscaler Cloud & Branch Connector API

### Description
This API allows programmatic access to manage and configure Zscaler Cloud and Branch Connector services. It enables automation of deployment, configuration, and monitoring tasks.

### Method
GET

### Endpoint
/api/v1/getting_started

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **documentation_url** (string) - URL to the detailed getting started guide.
- **api_version** (string) - The current version of the API.

#### Response Example
```json
{
  "documentation_url": "https://config.zscaler.com/zia/api/v1/getting_started",
  "api_version": "v1"
}
```
```

--------------------------------

### Zscaler Cloud & Branch Connector API - Getting Started

Source: https://help.zscaler.com/cloud-branch-connector/reference-architecture

Provides an overview and initial steps for using the Zscaler Cloud & Branch Connector API.

```APIDOC
## Zscaler Cloud & Branch Connector API

### Description
This section covers the foundational aspects of the Zscaler Cloud & Branch Connector API, including how to get started and understand its capabilities.

### API Developer & Reference Guide
This guide details the resources available for developers working with the Zscaler Cloud & Branch Connector API.

#### Getting Started
*   **Description**: An introduction to the API, outlining prerequisites and initial setup.
*   **Endpoint**: N/A (Conceptual Guide)
*   **Method**: N/A

#### Configuring the Postman REST API Client
*   **Description**: Instructions on setting up Postman to interact with the Zscaler API.
*   **Endpoint**: N/A (Configuration Guide)
*   **Method**: N/A

#### API Response Codes and Error Messages
*   **Description**: A comprehensive list of API response codes and common error messages to aid in troubleshooting.
*   **Endpoint**: N/A (Reference)
*   **Method**: N/A

#### Understanding Rate Limits
*   **Description**: Information on API rate limits to ensure efficient and compliant usage.
*   **Endpoint**: N/A (Reference)
*   **Method**: N/A

### Reference Guide
Detailed reference information for various API functionalities.

#### Activation
*   **Description**: API endpoints and details related to activation processes.

#### Admin and Role Management
*   **Description**: API functionalities for managing administrative users and their roles.

#### Authentication
*   **Description**: Information on authentication methods and token management for API access.

#### Cloud & Branch Connector Groups
*   **Description**: API endpoints for managing groups of Cloud and Branch Connectors.

#### Forwarding Gateways
*   **Description**: API details for configuring and managing forwarding gateways.
```

--------------------------------

### Zscaler Cloud & Branch Connector API - General Information

Source: https://help.zscaler.com/cloud-branch-connector/zero-trust-gateway-management

Overview of the Zscaler Cloud & Branch Connector API, getting started guides, and essential concepts.

```APIDOC
## Zscaler Cloud & Branch Connector API

### Description
This API allows programmatic management and interaction with Zscaler Cloud and Branch Connector functionalities.

### Getting Started
Provides initial steps and guidance for developers to begin using the API.

### Configuring the Postman REST API Client
Instructions on setting up Postman for testing and interacting with the API.

### API Response Codes and Error Messages
Details on standard API response codes and common error messages for troubleshooting.

### Understanding Rate Limits
Information on API rate limits to ensure efficient and compliant usage.
```

--------------------------------

### API Developer & Reference Guide

Source: https://help.zscaler.com/cloud-branch-connector/nanolog-streaming-service/nss-feeds/adding-nss-feeds

Guides for developers on using the Zscaler Cloud & Branch Connector API, including setup, response codes, rate limits, and specific API references.

```APIDOC
## API Developer & Reference Guide

### Description
This guide covers essential information for developers using the Zscaler Cloud & Branch Connector API. It includes setup instructions for REST API clients, understanding response codes and error messages, and managing API rate limits.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Getting Started with the API

### Description
This section provides the initial steps required to begin using the Zscaler Cloud & Branch Connector API, including any prerequisites or setup.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Configuring the Postman REST API Client

### Description
Instructions on how to configure Postman, a popular REST API client, to interact with the Zscaler Cloud & Branch Connector API. This includes setting up authentication and common request configurations.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## API Response Codes and Error Messages

### Description
A comprehensive list and explanation of the API response codes and error messages returned by the Zscaler Cloud & Branch Connector API, helping to diagnose and resolve issues.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Understanding Rate Limits

### Description
Information regarding the rate limits imposed on the Zscaler Cloud & Branch Connector API. This section details the limits, how they are enforced, and strategies for managing them.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Zscaler Cloud & Branch Connector API - Overview

Source: https://help.zscaler.com/cloud-branch-connector/analytics-monitoring/insights/logs

This section provides an overview of the Zscaler Cloud & Branch Connector API, including getting started guides, authentication, and general usage information.

```APIDOC
## Zscaler Cloud & Branch Connector API

### Description
This API allows programmatic management and configuration of Zscaler Cloud and Branch Connectors.

### Reference Guide

#### Getting Started
Provides initial steps and prerequisites for using the API.

#### Configuring the Postman REST API Client
Instructions on setting up Postman for interacting with the API.

#### API Response Codes and Error Messages
Details on common response codes and error messages returned by the API.

#### Understanding Rate Limits
Information on API rate limits and best practices for handling them.

### Reference Guide Details

#### Activation
Endpoints related to activating and deactivating services or devices.

#### Admin and Role Management
APIs for managing administrator accounts and their associated roles and permissions.

#### Authentication
Details on how to authenticate API requests, including supported methods and examples.

#### Cloud & Branch Connector Groups
Endpoints for managing groups of Cloud and Branch Connectors.

#### Forwarding Gateways
APIs for configuring and managing forwarding gateways.
```

--------------------------------

### Zscaler Cloud & Branch Connector API - Developer & Reference Guide

Source: https://help.zscaler.com/cloud-branch-connector/administration/location-management

This section covers the foundational aspects of the Zscaler Cloud & Branch Connector API, including getting started, setting up development tools, and understanding API constraints.

```APIDOC
## Zscaler Cloud & Branch Connector API

### Description
Guides and references for interacting with the Zscaler Cloud & Branch Connector API.

## API Developer & Reference Guide

### Description
This guide covers essential information for developers working with the Zscaler Cloud & Branch Connector API, including initial setup, authentication, and understanding API responses.

### Getting Started

### Description
An introduction to the Zscaler Cloud & Branch Connector API and how to begin integrating it into your workflows.

### Method
N/A (Informational)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

---

### Configuring the Postman REST API Client

### Description
Instructions on how to configure Postman to interact with the Zscaler Cloud & Branch Connector API for testing and development.

### Method
N/A (Informational)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

---

### API Response Codes and Error Messages

### Description
Details on the standard HTTP response codes and specific error messages returned by the Zscaler Cloud & Branch Connector API.

### Method
N/A (Informational)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

---

### Understanding Rate Limits

### Description
Information regarding the API rate limits to help manage request frequency and avoid throttling.

### Method
N/A (Informational)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

---

## Reference Guide

### Description
Detailed reference documentation for various API resources and operations.

### Activation

### Description
API endpoints and details related to activating or managing Zscaler services.

### Method
N/A (Reference)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

---

### Admin and Role Management

### Description
API operations for managing administrative users and their roles within the Zscaler platform.

### Method
N/A (Reference)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

---

### Authentication

### Description
Information on authentication mechanisms and API keys required to access the Zscaler Cloud & Branch Connector API.

### Method
N/A (Reference)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

---

### Cloud & Branch Connector Groups

### Description
API endpoints for managing groups of Cloud and Branch Connectors.

### Method
N/A (Reference)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

---

### Forwarding Gateways

### Description
API details for configuring and managing forwarding gateways within the Zscaler network.

### Method
N/A (Reference)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

--------------------------------

### Zscaler Cloud & Branch Connector API Overview

Source: https://help.zscaler.com/cloud-branch-connector/deployment-management-virtual-devices/cloud-connector-deployment-management/cloud-connector-deployment-management-azure

This section provides an overview of the Zscaler Cloud & Branch Connector API, including general concepts, getting started guides, and essential information for developers.

```APIDOC
## Zscaler Cloud & Branch Connector API

### Description
This API allows for programmatic management and configuration of Zscaler Cloud and Branch Connectors. It provides endpoints for various operational tasks, including deployment, monitoring, and policy management.

### Getting Started
Provides initial steps and prerequisites for using the API.

### API Developer & Reference Guide
Detailed documentation for API developers.

#### Configuring the Postman REST API Client
Instructions on setting up Postman for interacting with the API.

#### API Response Codes and Error Messages
Explanation of common response codes and error messages returned by the API.

#### Understanding Rate Limits
Information on API rate limits to ensure efficient usage.

### Reference Guide
Comprehensive reference for available API resources and operations.

#### Activation
Endpoints related to API key activation and management.

#### Admin and Role Management
APIs for managing administrative users and their roles.

#### Authentication
Details on authentication methods and token management.

#### Cloud & Branch Connector Groups
APIs for managing groups of Cloud and Branch Connectors.

#### Forwarding Gateways
Endpoints for configuring and managing forwarding gateways.
```

--------------------------------

### Zscaler Cloud & Branch Connector API Overview

Source: https://help.zscaler.com/cloud-branch-connector/deployment-management/cloud-connector-deployment-management

An overview of the Zscaler Cloud & Branch Connector API, its purpose, and how to get started with its usage.

```APIDOC
## Understanding the Zscaler Cloud & Branch Connector API

### Description
This section provides an overview of the Zscaler Cloud & Branch Connector API, detailing its capabilities and general usage.

### Method
N/A (Overview)

### Endpoint
N/A (Overview)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Zscaler Cloud & Branch Connector API Overview

Source: https://help.zscaler.com/cloud-branch-connector/deployment-management-virtual-devices

This section provides an overview of the Zscaler Cloud & Branch Connector API, its purpose, and how to get started.

```APIDOC
## Understanding the Zscaler Cloud & Branch Connector API

### Description
Provides an overview of the Zscaler Cloud & Branch Connector API, its capabilities, and integration possibilities.

### Method
N/A (Conceptual Overview)

### Endpoint
N/A (Conceptual Overview)
```

--------------------------------

### Zscaler Cloud & Branch Connector API Overview

Source: https://help.zscaler.com/cloud-branch-connector/forwarding

This section provides an overview of the Zscaler Cloud & Branch Connector API, guiding users on how to get started and understand the API's capabilities.

```APIDOC
## Understanding the Zscaler Cloud & Branch Connector API

### Description
Provides an introduction to the Zscaler Cloud & Branch Connector API, explaining its purpose and how it can be used to manage Zscaler services.

### Getting Started

### Description
Guides users through the initial steps required to start using the Zscaler Cloud & Branch Connector API, including any prerequisites or setup instructions.

### Configuring the Postman REST API Client

### Description
Instructions on how to configure Postman to interact with the Zscaler Cloud & Branch Connector API, enabling easier testing and development.

### API Response Codes and Error Messages

### Description
Details common API response codes and error messages, helping developers understand and troubleshoot issues when interacting with the API.

### Understanding Rate Limits

### Description
Information regarding API rate limits, including expected limits and best practices for handling them to ensure efficient API usage.

## Reference Guide

### Description
The API Reference Guide provides detailed information about specific API endpoints and resources available for managing Zscaler Cloud & Branch Connector configurations.

### Activation

### Description
Information related to the activation endpoints within the API, likely for activating or managing specific Zscaler services or components.

### Admin and Role Management

### Description
Details on API endpoints for managing administrator accounts and user roles within the Zscaler platform.

### Authentication

### Description
Information on authentication methods supported by the API, including how to obtain and use API keys or tokens for secure access.

### Cloud & Branch Connector Groups

### Description
API endpoints for managing groups of Cloud and Branch Connectors, allowing for bulk operations and configuration management.

### Forwarding Gateways

### Description
Documentation for API endpoints related to the configuration and management of forwarding gateways used by Zscaler services.
```

--------------------------------

### Zscaler Cloud & Branch Connector API Overview

Source: https://help.zscaler.com/cloud-branch-connector/getting-started/admin-portal

This section provides an overview of the Zscaler Cloud & Branch Connector API, including how to get started, authentication, and general concepts.

```APIDOC
## Zscaler Cloud & Branch Connector API

### Description
This API provides programmatic access to manage and configure Zscaler Cloud and Branch Connectors. It enables automation of tasks related to deployment, management, and monitoring.

### Getting Started

This guide will walk you through the initial steps required to start using the Zscaler Cloud & Branch Connector API. It covers essential setup and configuration.

### Postman REST API Client Configuration

Learn how to configure Postman to interact with the Zscaler Cloud & Branch Connector API. This includes setting up environments and requests.

### API Response Codes and Error Messages

Understand the meaning of various API response codes and error messages to effectively troubleshoot and handle API interactions.

### Rate Limits

Information on API rate limits to ensure efficient and compliant usage of the API. Adhering to these limits prevents service disruption.

### Reference Guide

This comprehensive reference guide details various API resources and operations available for managing Zscaler Cloud & Branch Connectors.

#### Activation

Details on API endpoints and methods related to activating or provisioning connectors.

#### Admin and Role Management

Endpoints for managing administrator accounts and their associated roles and permissions within the Zscaler platform.

#### Authentication

Information on how to authenticate your API requests, including supported authentication methods and token management.

#### Cloud & Branch Connector Groups

APIs for creating, retrieving, updating, and deleting groups of Cloud & Branch Connectors.

#### Forwarding Gateways

Endpoints related to the configuration and management of forwarding gateways used by the connectors.
```

--------------------------------

### Zscaler Cloud & Branch Connector API Overview

Source: https://help.zscaler.com/cloud-branch-connector/deployment-management-virtual-devices/cloud-connector-deployment-management/cloud-connector-deployment-management-gcp

This section provides an overview of the Zscaler Cloud & Branch Connector API, including introductory guides and setup instructions.

```APIDOC
## Zscaler Cloud & Branch Connector API

### Description
Provides programmatic access to manage and configure Zscaler Cloud and Branch Connectors.

### Getting Started

This guide covers the initial steps to begin using the Zscaler Cloud & Branch Connector API.

### Configuring the Postman REST API Client

Instructions on setting up Postman to interact with the Zscaler Cloud & Branch Connector API.

### API Response Codes and Error Messages

Details on understanding the various response codes and error messages returned by the API.

### Understanding Rate Limits

Information regarding the API's rate limits to ensure efficient usage.

### Reference Guide

Detailed reference for various API resources and operations:

*   **Activation**: Endpoints related to API activation.
*   **Admin and Role Management**: Endpoints for managing administrators and roles.
*   **Authentication**: Information on API authentication mechanisms.
*   **Cloud & Branch Connector Groups**: Endpoints for managing connector groups.
*   **Forwarding Gateways**: Endpoints for configuring forwarding gateways.
```

--------------------------------

### Zscaler Cloud & Branch Connector API Overview

Source: https://help.zscaler.com/cloud-branch-connector/nanolog-streaming-service/nss-feeds/adding-cloud-nss-feeds

This section provides an overview of the Zscaler Cloud & Branch Connector API, including getting started guides, configuration details, and common API concepts.

```APIDOC
## Zscaler Cloud & Branch Connector API

### Description
This API allows for programmatic management and configuration of Zscaler Cloud and Branch Connectors.

### Endpoint
`/api/v1/cloud_branch_connector`

### Getting Started
- **Guide**: Provides initial steps to begin using the API.
- **Postman Configuration**: Instructions on setting up Postman for API testing.
- **Response Codes**: Explanation of API response codes and error messages.
- **Rate Limits**: Information on API rate limiting policies.
```

--------------------------------

### API Reference Guide - Key Resources

Source: https://help.zscaler.com/cloud-branch-connector/zscaler-client-connector-vdi-management

Detailed documentation for core API resources, including Activation, Admin and Role Management, Authentication, and Cloud & Branch Connector Groups.

```APIDOC
## API Reference Guide

### Activation
Details on how to activate or manage the activation status of Cloud and Branch Connectors via the API.

### Admin and Role Management
APIs for managing administrative users, roles, and permissions within the Zscaler Cloud & Branch Connector platform.

### Authentication
Information on authentication mechanisms supported by the API, including obtaining and using API keys or tokens.

### Cloud & Branch Connector Groups
APIs for managing groups of Cloud and Branch Connectors, allowing for bulk operations and policy application.

### Forwarding Gateways
Documentation for managing forwarding gateways associated with Cloud Connectors, including configuration and status retrieval.
```

--------------------------------

### Zscaler Cloud & Branch Connector API Overview

Source: https://help.zscaler.com/cloud-branch-connector/deployment-management-physical-devices

This section provides an introduction to the Zscaler Cloud & Branch Connector API, including how to get started, authentication, and general usage guidelines.

```APIDOC
## Zscaler Cloud & Branch Connector API

### Description
This API allows for programmatic interaction with Zscaler Cloud and Branch Connector functionalities, enabling automation and integration with other systems.

### Getting Started
Provides initial steps and prerequisites for using the API.

### Postman REST API Client Configuration
Instructions on how to set up and use Postman for testing and interacting with the API.

### API Response Codes and Error Messages
Details on the different response codes and error messages returned by the API, crucial for troubleshooting and handling API interactions.

### Rate Limits
Information regarding the API rate limits to ensure efficient and compliant usage.
```

--------------------------------

### Zscaler Client Connector Install Options Example

Source: https://help.zscaler.com/cloud-branch-connector/customizing-zscaler-client-connector-vdi-install-options-msi

This is an example command line demonstrating the usage of various install options for Zscaler Client Connector for VDI. These options control tunneling modes, IP addressing, onboarding behavior, timeouts, and application display.

```bash
msiexec /i ZCCVDIInstaller.msi SERVERIP="185.46.212.80" ONBOARD="1" CONFIGREADTIMEOUT="300" HIDEAPPONUILAUNCH="1" USEEMBEDDEDBROWSER="1"
```

--------------------------------

### Zscaler Cloud & Branch Connector API Overview

Source: https://help.zscaler.com/cloud-branch-connector/analytics-monitoring/nanolog-streaming-service/nss-deployment-guides

Provides an overview of the Zscaler Cloud & Branch Connector API, including getting started, configuration, response codes, and rate limits.

```APIDOC
## Zscaler Cloud & Branch Connector API

### Description
This API allows for programmatic management and interaction with Zscaler Cloud and Branch Connectors.

### Method
N/A (Documentation Overview)

### Endpoint
N/A (Documentation Overview)

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## API Developer & Reference Guide

### Description
This guide covers essential information for developers using the Zscaler Cloud & Branch Connector API, including initial setup, common issues, and detailed reference.

#### Getting Started
Provides initial steps and concepts for API integration.

#### Configuring the Postman REST API Client
Instructions on setting up Postman for API testing and development.

#### API Response Codes and Error Messages
Details on interpreting API responses and understanding error codes.

#### Understanding Rate Limits
Information on API usage limits and best practices to avoid throttling.
```

--------------------------------

### Zscaler Cloud & Branch Connector API Reference

Source: https://help.zscaler.com/cloud-branch-connector/nanolog-streaming-service

This section provides detailed API documentation for the Zscaler Cloud & Branch Connector API. It includes information on getting started, configuring API clients, understanding response codes and rate limits, and a comprehensive reference guide for various API entities.

```APIDOC
## Zscaler Cloud & Branch Connector API

### Description
This API allows programmatic management and retrieval of information related to Zscaler Cloud and Branch Connectors.

### Getting Started
Information on initial setup and requirements for using the API.

### Configuring the Postman REST API Client
Guides on setting up Postman for testing and interacting with the API.

### API Response Codes and Error Messages
Details on common HTTP status codes and error messages returned by the API.

### Understanding Rate Limits
Information about the usage limits and policies for API requests.

### Reference Guide

#### Activation
API endpoints related to activating or managing services.

#### Admin and Role Management
APIs for managing administrative users and their roles.

#### Authentication
Details on how to authenticate API requests, including token generation and usage.

#### Cloud & Branch Connector Groups
Endpoints for managing groups of Cloud and Branch Connectors.

#### Forwarding Gateways
APIs related to configuring and managing forwarding gateways.
```

--------------------------------

### Zscaler Client Connector Command Line Install Example

Source: https://help.zscaler.com/cloud-branch-connector/customizing-zscaler-vdi-agent-install-options-msi

This example demonstrates a command-line installation of Zscaler Client Connector for VDI, utilizing various configuration parameters to customize its behavior and deployment. It showcases how to set server IP, onboarding behavior, read timeouts, application minimization, and embedded browser usage.

```bash
msiexec /i ZCCVDIInstaller.msi SERVERIP="185.46.212.80" ONBOARD=1 CONFIGREADTIMEOUT=120 HIDEAPPONUILAUNCH=1 USEEMBEDDEDBROWSER=0
```

--------------------------------

### API Reference Guide - Core Resources

Source: https://help.zscaler.com/cloud-branch-connector/deployment-management/cloud-connector-deployment-management

Detailed reference for core API resources including Activation, Admin and Role Management, Authentication, Cloud & Branch Connector Groups, and Forwarding Gateways.

```APIDOC
## API Reference Guide - Core Resources

### Description
This section provides detailed reference information for key resources available through the Zscaler Cloud & Branch Connector API.

### Method
N/A (Reference)

### Endpoint
N/A (Reference)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Activation API Reference

### Description
Reference documentation for the API endpoints related to activation processes within the Zscaler Cloud & Branch Connector system.

### Method
N/A (Reference)

### Endpoint
N/A (Reference)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Admin and Role Management API Reference

### Description
Reference documentation for API endpoints used for managing administrators and roles within the Zscaler platform.

### Method
N/A (Reference)

### Endpoint
N/A (Reference)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Authentication API Reference

### Description
Reference documentation for API endpoints related to authentication mechanisms and processes for the Zscaler Cloud & Branch Connector API.

### Method
N/A (Reference)

### Endpoint
N/A (Reference)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Cloud & Branch Connector Groups API Reference

### Description
Reference documentation for API endpoints used to manage groups of Cloud & Branch Connectors.

### Method
N/A (Reference)

### Endpoint
N/A (Reference)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Forwarding Gateways API Reference

### Description
Reference documentation for API endpoints related to the management and configuration of forwarding gateways within the Zscaler system.

### Method
N/A (Reference)

### Endpoint
N/A (Reference)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### API Reference Guide

Source: https://help.zscaler.com/cloud-branch-connector/administration/administrator-role-management

Detailed reference for various API resources, including Activation, Admin and Role Management, Authentication, and more.

```APIDOC
## Reference Guide

### Description
This section provides a detailed reference for the available API endpoints and their functionalities, covering various management aspects of Zscaler Cloud & Branch Connector.

### Method
N/A (Reference Documentation)

### Endpoint
N/A (Reference Documentation)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Activation API

### Description
APIs related to the activation process for Zscaler Cloud & Branch Connectors.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Admin and Role Management API

### Description
APIs for managing administrative users, roles, and permissions within the Zscaler Cloud & Branch Connector portal.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Authentication API

### Description
APIs related to user authentication, token generation, and session management for accessing the Zscaler Cloud & Branch Connector API.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Cloud & Branch Connector Groups API

### Description
APIs for managing groups of Cloud & Branch Connectors, enabling bulk operations and policy application.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

```APIDOC
## Forwarding Gateways API

### Description
APIs for configuring and managing forwarding gateways used by Cloud & Branch Connectors.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Zscaler Cloud & Branch Connector API Overview

Source: https://help.zscaler.com/cloud-branch-connector/zscaler-client-connector-vdi-management

An overview of the Zscaler Cloud & Branch Connector API, including introductory guides and essential concepts.

```APIDOC
## Zscaler Cloud & Branch Connector API

### Description
This API allows programmatic management and interaction with Zscaler Cloud and Branch Connectors. It enables automation of deployment, configuration, and monitoring tasks.

### Getting Started
This guide provides the initial steps required to begin using the Zscaler Cloud & Branch Connector API, including prerequisites and basic setup.

### Configuring the Postman REST API Client
Instructions on how to set up and configure Postman to interact with the Zscaler Cloud & Branch Connector API for testing and development.

### API Response Codes and Error Messages
A reference for understanding the various HTTP status codes and error messages returned by the API, crucial for debugging and handling API responses.

### Understanding Rate Limits
Information on the API's rate limiting policies to ensure efficient and compliant usage, preventing excessive requests.

### Reference Guide
This section details specific API resources and operations available for managing your Zscaler Cloud & Branch Connector deployment.
```

--------------------------------

### Get Public Cloud Account Status - JSON Example

Source: https://help.zscaler.com/cloud-branch-connector/provisioning

This JSON example demonstrates the response structure for retrieving the status of public cloud accounts. It indicates whether the account and subscription are enabled.

```json
{
  "accountIdEnabled": true,
  "subIdEnabled": true
}
```

--------------------------------

### API Reference Guide

Source: https://help.zscaler.com/cloud-branch-connector/deployment-management-virtual-devices/cloud-connector-deployment-management/cloud-connector-deployment-management-aws

Detailed reference for various API endpoints, covering management of activations, admin roles, authentication, and connector groups.

```APIDOC
## API Reference Guide

### Description
This section details the available API endpoints for managing Zscaler Cloud and Branch Connector resources.

### Reference Guide

#### Activation
Endpoints related to activating and managing Zscaler services.

#### Admin and Role Management
APIs for managing administrator accounts and their roles within the Zscaler platform.

#### Authentication
Details on authentication methods and procedures for accessing the API.

#### Cloud & Branch Connector Groups
Endpoints for creating, retrieving, updating, and deleting groups of Cloud and Branch Connectors.

#### Forwarding Gateways
APIs for managing forwarding gateways used by Cloud and Branch Connectors.
```

--------------------------------

### GET /ipSourceGroups/lite

Source: https://help.zscaler.com/cloud-branch-connector/policy-resources

Retrieves a list of source IP groups with basic information (name and ID). Use `GET /ipSourceGroups` for extensive details.

```APIDOC
## GET /ipSourceGroups/lite

### Description
Retrieves the list of source IP groups with basic information.

### Method
GET

### Endpoint
/ipSourceGroups/lite

### Parameters
No parameters

### Response
#### Success Response (200)
- **id** (integer) - Identifier that uniquely identifies an entity.
- **name** (string) - The configured name of the entity.
- **isNameL10nTag** (boolean) - General purpose.
- **extensions** (object) - General purpose.
- **deleted** (boolean) - General purpose.
- **externalId** (string) - General purpose.
- **associationTime** (integer) - General purpose.

#### Response Example
```json
{
  "id": 1,
  "name": "DefaultSourceGroup",
  "isNameL10nTag": false,
  "extensions": {},
  "deleted": false,
  "externalId": "",
  "associationTime": 1678886400
}
```
```

--------------------------------

### Get Public Cloud Account Details - JSON Example

Source: https://help.zscaler.com/cloud-branch-connector/provisioning

This code snippet provides an example of the JSON response when retrieving public cloud account details. It includes fields such as internal ID, account ID, and platform ID.

```json
{
  "id": 0,
  "accountId": "string",
  "platformId": "AWS"
}
```

--------------------------------

### API Reference Guide

Source: https://help.zscaler.com/cloud-branch-connector/nanolog-streaming-service/nss-feeds/adding-cloud-nss-feeds

Detailed reference for various API resources including Activation, Admin and Role Management, Authentication, and Cloud & Branch Connector Groups.

```APIDOC
## API Reference Guide

### Description
This guide details the available API endpoints for managing Zscaler Cloud & Branch Connector configurations.

### Endpoints

#### Activation
- **Method**: POST
- **Endpoint**: `/api/v1/cloud_branch_connector/activation`
- **Description**: Manages the activation status of connectors.

#### Admin and Role Management
- **Method**: GET, POST, PUT, DELETE
- **Endpoint**: `/api/v1/admin/roles`
- **Description**: Manages administrative users and their roles.

#### Authentication
- **Method**: POST
- **Endpoint**: `/api/v1/auth/token`
- **Description**: Obtains authentication tokens for API access.

#### Cloud & Branch Connector Groups
- **Method**: GET, POST, PUT, DELETE
- **Endpoint**: `/api/v1/cloud_branch_connector/groups`
- **Description**: Manages groups of Cloud and Branch Connectors.

#### Forwarding Gateways
- **Method**: GET, POST, PUT, DELETE
- **Endpoint**: `/api/v1/forwarding/gateways`
- **Description**: Manages forwarding gateways for connector traffic.
```

--------------------------------

### API Reference Guide - Core Resources

Source: https://help.zscaler.com/cloud-branch-connector/forwarding/dns-policies

Reference documentation for core API resources including Activation, Admin and Role Management, Authentication, and Cloud & Branch Connector Groups.

```APIDOC
## Reference Guide - Core Resources

### Description
This section details the available API endpoints for managing core Zscaler Cloud & Branch Connector resources.

#### Activation
Endpoints related to the activation process of services.

#### Admin and Role Management
APIs for managing administrative users and their roles.

#### Authentication
Details on how to authenticate API requests.

#### Cloud & Branch Connector Groups
Endpoints for managing groups of Cloud & Branch Connectors.

#### Forwarding Gateways
APIs for configuring and managing forwarding gateways.

```

--------------------------------

### GET /adminUsers

Source: https://help.zscaler.com/cloud-branch-connector/policy-resources

Retrieves a list of administrator users.

```APIDOC
## GET /adminUsers

### Description
Retrieves the list of administrator users.

### Method
GET

### Endpoint
/adminUsers

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **userId** (string) - The unique identifier for the user.
- **username** (string) - The username of the administrator.
- **roleId** (string) - The ID of the role assigned to the user.
- **email** (string) - The email address of the administrator.

#### Response Example
```json
{
  "userId": "string",
  "username": "string",
  "roleId": "string",
  "email": "string"
}
```
```
Tokens:
Raw