Edit REST Endpoint
This page describes how to update an existing REST API endpoint definition in the Pirivision Compass module via the Edit action.
Use this flow when you need to change the endpoint path, parameters, headers, or record name.
Prerequisite
At least one REST API endpoint record must exist in the Compass list. If none, see Define REST Endpoint first.
1. Find the Record in the Compass List
Click Compass in the left menu. Locate the REST endpoint record you want to edit.
2. Click the Edit Button
Click the Edit button (pencil icon) on the right side of the card.
3. The REST Endpoint Form Opens — Pre-Filled
The REST endpoint form opens. The endpoint path, method, parameters, and headers come pre-filled with the existing values.
4. Editable Fields
| Field | Editable? | Notes |
|---|---|---|
| Endpoint Path | ✅ Yes | The relative path can be updated |
| HTTP Method | ✅ Yes | GET / POST can be changed |
| Query Parameters | ✅ Yes | Can be added, edited, or removed |
| Headers | ✅ Yes | Endpoint-specific headers can be updated |
| Body | ✅ Yes | The POST body can be updated |
| Transform Code | ✅ Yes | The JavaScript transform script can be enabled, edited, or disabled |
| Record Name | ✅ Yes | In the save panel |
| Description | ✅ Yes | In the save panel |
| Target Folder | ✅ Yes | A different folder can be selected |
| Data Source | ❌ No | Create a new endpoint record for a different REST API source |
5. Update the Endpoint and Parameters
Edit the necessary fields. After making changes, verify the response with the Test / Send button.
Token Refresh
If the endpoint uses an Authorization header and the token has expired, update the token value in the Headers section of the save panel or the Global Headers in the Port data source.
6. Update (Save)
If the test is successful, click Save. Update the necessary fields in the save panel.
Click the Save button at the bottom of the panel.
7. Common Errors
| Error / Symptom | Possible Cause | Solution |
|---|---|---|
"you already have a query named '...'" |
The new name is used by another Compass record | Choose a different name |
HTTP 401 after update |
Token expired | Update the Authorization header value |
"update failed: no rows were affected" |
Save failed | Refresh the page and retry |