Appearance

On this page

Directus Cloud

Everything you need to start building. Provisioned in 90 seconds. Starting at $15/month.

Get Started

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / rest / rest

Function: rest() ​

rest(config): <Schema>(client) => RestClient<Schema>

Defined in: rest/composable.ts:14

Creates a client to communicate with the Directus REST API.

Parameters ​

config ​

Partial<RestConfig> = {}

Returns ​

Function

A Directus REST client.

Type Parameters ​

• Schema

Parameters ​

client ​

DirectusClient<Schema>

Returns ​

RestClient<Schema>