List of REST Endpoints

The following REST Web Service API endpoint paths are available. All calls require the following headers:

Content-Type: application/json
Accept: application/json
Authorization: {type} {authstring}

For more information, review REST — Introduction

/rest/Sessions

• POST
• GET

/rest/Sessions/{sid}

• GET
• PATCH
• DELETE

All of the following calls require the Session ID URL parameter: sid={sid}

Example

GET /rest/Settings?sid={sid}

/rest/DataSources

• GET

/rest/DataSources/{Id}

• POST
• GET
• PATCH

/rest/Entities

• POST
• GET

/rest/Entities/{Id}

• GET
• PATCH
• DELETE

/rest/Entities/{Id}/Fields

• GET

/rest/Entities/{Id}/Fields/{Field Id}

• GET
• PATCH
• POST v2019.1.13+

/rest/Folders/{Name}

• POST
• DELETE

/rest/Folders/Rename

• POST

/rest/Functions

• POST
• GET

/rest/Functions/{Id}

• GET
• PATCH
• DELETE

/rest/Joins

• POST
• GET

/rest/Joins/{Id}

• GET
• PATCH
• DELETE

/rest/Parameters

• POST
• GET

/rest/Parameters/{Id}

• GET
• PATCH
• DELETE

/rest/Reports/List

• GET

/rest/Reports/Execute/{Type}

• POST

/rest/Roles

• POST
• GET

/rest/Roles/{Id}

• GET
• PATCH

/rest/Roles/{Id}/DataObjectRows

• GET
• PATCH

/rest/Roles/{Id}/Entities

• GET
• PATCH

/rest/Roles/{Id}/Folders

• GET
• PATCH

/rest/Roles/{Id}/Settings

• GET
• PATCH

/rest/ServerEvents

• GET

/rest/ServerEvents/{Id}

• GET
• DELETE

/rest/Settings

• GET
• PATCH