Skip to content

Edit REST API Data Source

This page explains updating a previously added REST API data source in the Pirivision Port module via the Edit action.

Use this flow when the API Base URL changes, when the authentication token is rotated, when Client Options need revision, or when you want to move the data source to a different folder.

Prerequisite

At least one REST API data source must be saved in the Port list. If none, see Add REST API Data Source first.

1. Find the Data Source in the Port List

Click Port in the left menu. Find the REST API data source you want to edit in the list.

Port list — REST API data source card

You can use the search bar in the list to filter by data source name or by #tag.

2. Click the Edit Button

The Edit button (pencil icon) is on the right side of the data source card.

Click the Edit button.

Tip

The Edit button appears directly on the card. Access via the More menu is not required.

3. The Edit Form Opens

When Edit is clicked, the form opens with current values pre-filled. This is the same screen as the new REST API data source form; the only differences are the pre-filled values and the Test and Update button at the bottom.

REST API Edit Form — pre-filled values

4. Editable Fields

The following fields can be edited:

Section Field Required Default Description
Display Info Name Yes — The display name of the data source within Pirivision
Display Info Description No — Short description text
Essential Connection Base URL Yes — Common base address for all API requests
Essential Connection Global Headers No — Headers added to every request (key-value pairs)
Client Options Timeout No 5000 Request timeout (ms)
Client Options Retries No 3 Number of retries for failed requests
Client Options Proxy No — Proxy server address
Client Options SSL Verify No OFF SSL certificate validation
Location Target Folder No — Location of the data source in the Port folder structure

Non-Editable Field

Field Status
Data source type Stays fixed as RestAPI; cannot be converted to SQL or MQTT types.

Token Refresh

If you use JWT or API key based authentication, when the token expires update the Authorization value in Global Headers with the new token.

5. Test and Update Button

After all fields are updated, click the Test and Update button at the bottom right.

This works in two stages:

  1. A Ping URL request is sent to the updated Base URL and reachability is tested. SSL Verify, Timeout, Proxy and Headers from the form are applied. Details → Ping URL — Connectivity Test.
  2. If the test succeeds, the updated values are saved.

The bottom of the form shows:

Connection will be saved automatically if the test is successful

Success

If the test succeeds, the updated data source is redirected to the Port list. The Compass query cache associated with the connection is automatically invalidated.

Failure

If the test fails, the updated info is not saved. Check Base URL, SSL Verify setting, Global Headers, and network access.

6. Common Errors

Error / Symptom Possible Cause Solution
a datasource with this name already exists, please choose a different name Another data source already uses the same name Enter a different Name value
you do not have permission to update this datasource or the datasource was not found The data source belongs to another user or was deleted Refresh the Port list
user not found Session expired Log in again
update failed: ... Connection test failed Verify Base URL and network access
401 Unauthorized Token or API key not current Update the Authorization value in Global Headers
Connection refused API service is down Check that the target service is up
SSL certificate error Certificate mismatch Set SSL Verify to OFF or fix the certificate
Timeout Service slow or network latency Increase the Timeout value

7. Next Step

After the data source is updated, verify that Compass HTTP queries using this source still work correctly.

flowchart LR
    A["Port<br/>REST API Edited"] --> B["Compass<br/>HTTP Query Verification"]
    B --> C["Cartography<br/>Chart / KPI (no changes)"]

Summary

The REST API data source editing process:

  1. Open the Port module.
  2. Find the REST API data source in the list.
  3. Click Edit on the card.
  4. The form opens pre-filled with current values.
  5. Update the relevant fields (Base URL, Global Headers, Client Options, etc.).
  6. Test and save the connection with Test and Update.
  7. Verify the HTTP query in Compass.