---
title: "Register a new REST integration"
method: PUT
path: "/epos/integrations/rest"
tags: ["Capabilities"]
---

# Register a new REST integration

`PUT /epos/integrations/rest`

## Request

- Base URL: `https://api.dojo.tech`
- URL: `https://api.dojo.tech/epos/integrations/rest`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/dojo/apis/dojo-api/docs/epos/integrations/rest/put.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- RestIntegrationRequest: REST request
  - `url` string, required
  - `capabilities` CapabilityRequest[], required: Send a REST request
    - `name` string, required: The name of a capability. (CancelOrderById, CreateOrder, ListAreas, GetOrderById, SearchTables, SearchOrders, GetPartyById, DeletePartyById, SearchParties, UpdateParty, CreateParty, GetReservationById, SearchReservations, UpdateReservation, DeleteReservationById, CreateReservation, RecordOrderPaymentById, CreateOrderLock, DeleteOrderLock, ExtendOrderLock, GetOrderBillById)
    - `version` string, required
  - `auth` RestAuthRequest, required: The authentication details for REST adapters
    - `authType` 'basic', required: The authentication flow that Dojo will use to make requests against this REST integration
    - `basic` RestBasicAuthRequest: The basic authentication request details for REST adapters.
      - `username` string, required
      - `password` string, required

## Response `200`

Successful operation

- RestIntegrationResponse[]
  - `url` string, required
  - `capabilities` CapabilityResponse[], required: Receive a response to a REST request
    - `name` string, required
    - `version` string, required
    - `updatedAt` string, date-time, required
  - `auth` RestAuthResponse, required: The authentication details for REST adapters.
    - `authType` 'basic', required: The authentication flow that Dojo will use to make requests against this REST integration.
    - `basic` RestBasicAuthResponse: The basic authentication response details for REST adapters.
      - `username` string, required
  - `createdAt` string, date-time, required

---

[API](https://skmtc.dev/dojo/apis/dojo-api.md) - [All operations](https://skmtc.dev/dojo/apis/dojo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/dojo/apis/dojo-api/revisions/29fc8900ba37?raw)