Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ApiSettings

Settings for an API (host).

Hierarchy

Index

Properties

Properties

Optional allowed

allowed: string | string[]

One or more allowed IP addresses in CIDR format.

Optional autoStart

autoStart: boolean

Auto start host or not.

Optional description

description: string

A description for the host.

Optional endpoints

endpoints: deploy_contracts.KeyValuePairs<ApiEndpoint>

One or more custom endpoints.

Optional name

name: string

The name.

Optional realm

realm: string

The custom name of the real for basic authentification.

Optional ssl

ssl: object

SSL settings.

Type declaration

  • Optional ca?: string

    The path to the ca file.

  • Optional cert?: string

    The path to the file of the certificate.

  • Optional key?: string

    The path to the key file.

  • Optional passphrase?: string

    The required password for the key file.

  • Optional rejectUnauthorized?: boolean

    Request unauthorized or not.

Optional useBuildIn

useBuildIn: boolean

Use build-in endpoints or not.

Optional users

users: ApiUserList

One or more users to define.

Generated using TypeDoc