@nuralogix.ai/dfx-api-client/doc/API/http/general/index.md

DeepAffex API JavaScript Client Library

[@nuralogix.ai/dfx-api-client](../../index.md) / [HTTP](../../http/index.md) / General

# General

General end points

### Sample code

```js
const apiClient = client();
const response = await apiClient.http.general.status();
const { status, body } = response;
if (status !== '200') {
    /**
     * TypeScript knows that once we are inside this block, the only response
     * shape that matches a non "200" response is the ErrorResponse
    */
    throw body;
}
/** Otherwise the shape of the response is GeneralStatus200Response */
console.log(body.Version);
```

### Methods

- [listAcceptedMimeTypes](#listacceptedmimetypes)
- [listAvailableStatuses](#listavailablestatuses)
- [listAvailableUserRoles](#listavailableuserroles)
- [regions](#regions)
- [status](#status)
- [verifyToken](#verifytoken)

### listAcceptedMimeTypes

▸ **listAcceptedMimeTypes**()

Returns a list of system-wide accepted Mime types and their IDs.

Endpoint Action ID = 101

#### Returns

`Promise`<[`ErrorResponse`](../../interfaces/ErrorResponse.md) \| [`GeneralListAcceptedMIMETypes200Response`](./interfaces/GeneralListAcceptedMIMETypes200Response.md)\>

___

### listAvailableStatuses

▸ **listAvailableStatuses**()

Retrieves a list of available status codes that can be used throughout
the application to update the StatusID field of various resources.

Endpoint Action ID = 104

#### Returns

`Promise`<[`ErrorResponse`](../../interfaces/ErrorResponse.md) \| [`GeneralListAvailableStatuses200Response`](./interfaces/GeneralListAvailableStatuses200Response.md)\>

___

### listAvailableUserRoles

▸ **listAvailableUserRoles**()

Retrieves a list of available User Roles.

Endpoint Action ID = 102

#### Returns

`Promise`<[`ErrorResponse`](../../interfaces/ErrorResponse.md) \| [`GeneralListAvailableRoles200Response`](./interfaces/GeneralListAvailableRoles200Response.md)\>

___

### regions

▸ **regions**()

Return the list of regions available for clusters.

Endpoint Action ID = 108

#### Returns

`Promise`<[`ErrorResponse`](../../interfaces/ErrorResponse.md) \| [`GeneralRegions200Response`](./interfaces/GeneralRegions200Response.md)\>

___

### status

▸ **status**()

An endpoint that propagates the current API health status and
other information. This can be used during an apps initial boot
process to determine the accessibility of the API and propagate
a general status message to users.

Endpoint Action ID = 100

#### Returns

`Promise`<[`ErrorResponse`](../../interfaces/ErrorResponse.md) \| [`GeneralServerStatus200Response`](./interfaces/GeneralServerStatus200Response.md)\>

___

### verifyToken

▸ **verifyToken**()

Checks validity of your Token and returns its encoded info.

Endpoint Action ID = 107

#### Returns

`Promise`<[`ErrorResponse`](../../interfaces/ErrorResponse.md) \| [`GeneralVerifyToken200Response`](./interfaces/GeneralVerifyToken200Response.md)\>