Endpoints
Endpoints in the Data Repository allow you to store connection targets used by automated tests.
Endpoints are typically used when tests need to interact with external systems or services, such as servers accessed through SSH connections. By storing endpoints in the Data Repository, you can reuse them across multiple test cases and manage connection details from a single location.
Endpoints can be created, edited, and deleted within the Data Repository → Endpoints section.
Endpoint Types
Currently, TestFirst supports the following endpoint type:
SSH – used to connect to remote servers via Secure Shell (SSH)
Endpoints allow tests to interact with remote systems for actions such as:
executing commands
validating server responses
verifying remote system states
Additional endpoint types may be supported in future versions.
Add an Endpoint
To create a new endpoint:
Step 1 - Select Endpoints
Open the environment dropdown in the Data Repository and select Endpoints.
Step 2 - Open the Add Item Modal
You can create an endpoint in two ways:
Click the New Item icon in the Data Repository header
Right-click the folder where you want to add the endpoint and select Add Item
The Add Item modal will appear.
Step 3 - Enter Endpoint Details
Provide the following information:
Name – The endpoint name used to identify the connection
Folder – Folder where the endpoint will be stored
Environment – Environment where the endpoint will be used
Type – Select the endpoint type (currently SSH)
Value – The connection value or endpoint address
Step 4 - Save the Endpoint
Click SAVE.
The modal will close and a confirmation message will appear. The endpoint is now available for use in your test cases.
Edit an Endpoint
To modify an existing endpoint:
Right-click the endpoint, then select Edit. The Edit Item modal will appear.
Update the fields as needed, then click SAVE.
Delete an Endpoint
To remove an endpoint:
Right-click -> Delete from the context menu. The Delete Item confirmation modal will appear. Click YES to permanently remove the endpoint Right-click the endpoint, then select Delete. The Delete Item confirmation modal will appear. Click YES to permanently remove the endpoint.
Important
Deleted endpoints cannot be restored.
Once an item is removed from the Data Repository, it is permanently deleted and cannot be recovered. Always verify that the endpoint is no longer required before deleting it.
Best Practices
To manage endpoints effectively:
Use clear naming conventions for endpoints
Organize endpoints into folders based on environments or services
Avoid duplicating the same endpoint across multiple items
Maintain consistent connection details across environments
Keeping endpoints organized ensures that automated tests remain stable, reusable, and easy to maintain.
Last updated