REST Endpoints

Learn how to create a REST endpoint for use in building pipeline.

You create a REST endpoint by choosing an HTTP method and add a path and any required path parameters.

Any created endpoint is also reachable with a trailing slash. For example, if your published endpoint is .../foo, then it is also reachable by .../foo/.

REST HTTP methods

The following table describes the REST HTTP methods supported by Xapix.

Method

Description

GET

Request to retrieve data (resource).

POST

Request to create a new resource using data provided in the body of the request.

PUT

Request to update (or completely replace) an existing resource using the data you want to change.

PATCH

Request to modify an existing resource using the data you want to change.

DELETE

Request to delete the resource.

Creating REST endpoints

To create a REST endpoint, follow these steps.

Steps
Steps
  1. From within a project, select Home.

  2. Click REST Endpoint.

  3. In New REST Endpoint, do the following:

    • Select an HTTP Method (GET, POST, PUT, PATCH or DELETE).

    • Enter the end point a path (including any required parameters enclosed in { } , for example {id} .

  4. Click Create Endpoint.

  5. The new endpoint appears in the list of REST Endpoints in the Home menu and the Pipeline dashboard appears with a Request and Endpoint units.

  6. Begin building the pipeline.

The path to the new REST endpoint appears in the URL field of a browser, as in the following example.

https://cloud.xapix.io/1st-org/my-first-project/pipelines/get-full_car-vehicle_id
Example
Example
Create new REST endpoint
New REST endpoint in Pipeline dashboard

You can now start building a pipeline with your new REST endpoint.