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/.

To create a REST endpoint, follow these steps.

Steps
Steps
  1. From within a project, select Home > REST Endpoints > + Add new.

  2. In the New REST Endpoint pane, select an HTTP Method.

  3. Enter a path to the endpoint.

  4. Any path parameters must be provided within curly braces, for example {id}.

  5. Click Create Endpoint.

  6. 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.

  7. Begin building the pipeline.

Example
Example
Creating a new REST endpoint
Pipeline dashboard with new endpointt

The endpoint path appears in the URL field in your browser. For example:

https://cloud.xapix.io/quick-start/first-project/pipelines/get-vehicle_id

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