# RestClientOptions (/docs/rest/api/interfaces/RestClientOptions)



[@kysoql/rest](/docs/rest/api) / RestClientOptions

Connection, authentication, and transport options for the Salesforce REST
client.

## Extends [#extends]

* [`HttpOptions`](/docs/rest/api/interfaces/HttpOptions)

## Properties [#properties]

| Property                                          | Modifier   | Type                                                                                    | Description                                                                           | Inherited from                                                                                                                     |
| ------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| <a id="api-property-instanceurl" /> `instanceUrl` | `readonly` | `string`                                                                                | Salesforce instance origin used for REST requests.                                    | -                                                                                                                                  |
| <a id="api-property-accesstoken" /> `accessToken` | `readonly` | \| `string` \| [`AccessTokenProvider`](/docs/rest/api/type-aliases/AccessTokenProvider) | Provider is called lazily, then again only after INVALID\_SESSION\_ID.                | -                                                                                                                                  |
| <a id="api-property-apiversion" /> `apiVersion?`  | `readonly` | `string`                                                                                | Salesforce REST API version, for example `65.0`; defaults to `DEFAULT_API_VERSION`.   | -                                                                                                                                  |
| <a id="api-property-fetch" /> `fetch?`            | `readonly` | (`input`, `init?`) => `Promise`\<`Response`>                                            | Native fetch by default. An injected implementation must honour signal and redirect.  | [`HttpOptions`](/docs/rest/api/interfaces/HttpOptions).[`fetch`](/docs/rest/api/interfaces/HttpOptions#api-property-fetch)         |
| <a id="api-property-signal" /> `signal?`          | `readonly` | `AbortSignal`                                                                           | Combines with the client's signal; cancelling one operation does not cancel others.   | [`HttpOptions`](/docs/rest/api/interfaces/HttpOptions).[`signal`](/docs/rest/api/interfaces/HttpOptions#api-property-signal)       |
| <a id="api-property-timeoutms" /> `timeoutMs?`    | `readonly` | `number`                                                                                | Per HTTP request, including token acquisition and response body. Default: 30 seconds. | [`HttpOptions`](/docs/rest/api/interfaces/HttpOptions).[`timeoutMs`](/docs/rest/api/interfaces/HttpOptions#api-property-timeoutms) |