Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Integration Service

TABLE OF CONTENTS

API Documentation

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedJul 30, 2026
  • 2 minute read

Provides REST endpoints to manage and exchange engineering data between AVEVA tools and third-party systems.

Host and authentication type

AIS Data API can be accessed using either AIS Local (on‑premises) or AIS Cloud (CONNECT). The host/base URL and authentication method depend on the deployment:

  • AIS Local (on‑premises) uses Windows (NTLM) authentication. Authorization is enforced through IIS URL Authorization rules, therefore the calling Windows user/service account must be granted access in IIS.

  • AIS Cloud (CONNECT) uses Bearer token (CONNECT) authentication. The CONNECT user/service application must be granted the appropriate CONNECT roles/permissions to access the API.

API version

The Data API is versioned. v1.0 and v1.1 remain operational for backward compatibility; however, v1.2 is recommended for new integrations. Use the versioned URL format shown in Base URL.

Local vs cloud

The functional API surface is the same conceptually across Local and Cloud deployments; however, the following differences apply:

  • Authentication/authorization model (NTLM/IIS vs CONNECT/Bearer token)

  • Endpoint host (customer IIS vs CONNECT cloud endpoint)

Base URL

Select the appropriate base URL for your deployment:

  • AIS Local (on‑premises): https://{aisServer}:60930/api/v1.2/

  • AIS Cloud (CONNECT): https://eu.ais.connect.aveva.com/data/api/v1.2/

    Note: Replace the version segment (e.g., v1.2) only when you explicitly need an older supported version (e.g., v1.1) for backward compatibility.

Data expiry

When uploading data, an expiry value can be provided. If not specified, the default expiry is applied. Expired acknowledgements and related data are cleaned up by a background cleanup process.

Examples and deployment/version coverage

The examples in this guide are shown using AIS Cloud and API version v1.2 for simplicity. The same endpoints are available for AIS Local (on‑premises) using the corresponding AIS Local base URL and NTLM authentication.

If you are using API v1.1, update the base URL to use /api/v1.1/.