1. SuiteCloud Platform
  2. SuiteApp Control Center
  3. Control Center REST API Endpoints

Control Center REST API Endpoints

SuiteApp Control Center REST API endpoints provide a streamlined way for SuiteApp publishers to manage and monitor SuiteApp versions. If you develop, distribute, or maintain SuiteApps, the APIs help you automate key tasks that would otherwise require manual work, making SuiteApp life cycle management more efficient and reliable.

Use the following topics to learn more about Control Center API Endpoints:

What are Control Center REST API Endpoints?

Control Center APIs are a set of REST endpoints that let you interact programmatically with the SuiteApp Control Center. The main features include:

  • Creating SuiteApp Versions - Create new versions of your applications to NetSuite by specifying the minimal required NetSuite version and SuiteApp phase. This action is completed using a POST request.

  • Tracking SuiteApp Installations - Retrieve up-to-date information about where your SuiteApp is installed, see which version is present on each account, and monitor the installation status, including any errors. This action is completed using a GET request.

  • Filtering Installations for Managed Upgrades - Retrieve only installations that are eligible for managed upgrade using a GET request. You can also filter by upgrade phase, such as LEADING or LAGGING.

  • Publishing or Deprecating SuiteApp Versions - Publish a pending SuiteApp version or deprecate a released SuiteApp version using a PATCH request.

  • Upgrading SuiteApp Installations - Upgrade selected SuiteApp installations to a specified SuiteApp version using a PUT request.

Why Use Control Center REST API Endpoints?

Control Center REST API endpoints help SuiteApp publishers automate SuiteApp lifecycle management. Instead of manually creating versions, checking installation status, publishing versions, or upgrading accounts from SuiteApp Control Center, you can use REST API calls to complete these tasks programmatically.

These endpoints can help you:

  • Automate the release of new application versions, reducing the need for manual uploads and status checks.

  • Monitor SuiteApp deployments across all customer accounts in one place.

  • Identify installations that are eligible for managed upgrade.

  • Publish or deprecate SuiteApp versions.

  • Upgrade selected SuiteApp installations to a specified version.

  • Reduce manual work and improve visibility across the SuiteApp release process.

Security and Access Considerations

All API operations require secure authentication with OAuth 2.0, using a bearer token in the HTTP Authorization header. Only users with the correct permissions (SuiteApp Release Manager profile) can perform version management and retrieve installation data. For more information about security considerations for SuiteApp Control Center APIs, see Security Considerations for Control Center Endpoints.

Related Topics:

General Notices