Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RequestAPI

A map of API parameters.

These parameters apply if the original request URL is not absolute, and they can be used to customize the base API URL depending on the runtime environment. If you define the base API URL via config#api or globalOpts.api, these parameters will be mapped on it.

Hierarchy

  • RequestAPI

Index

Properties

Properties

Optional auth

auth?: RequestAPIValue<string>

Value for an API authorization part

example

'login:password'

Optional domain2

domain2?: RequestAPIValue<string>

Value for an API domain level 2 part

Optional domain3

domain3?: RequestAPIValue<string>

Value for an API domain level 3 part

Optional domain4

domain4?: RequestAPIValue<string>

Value for an API domain level 4 part

Optional domain5

domain5?: RequestAPIValue<string>

Value for an API domain level 5 part

Optional domain6

domain6?: RequestAPIValue<string>

Value for an API domain level 6 part

Optional namespace

namespace?: RequestAPIValue<string>

Value for an API namespace part: it follows after '/' character

Optional port

port?: RequestAPIValue<string | number>

Value for an API api port

Optional protocol

protocol?: RequestAPIValue<string>

API protocol

example

'http' 'https'

Optional url

url?: RequestAPIValue<string>

The direct value of API URL. If this parameter is defined, all other parameters will be ignored.

example

'https://google.com'

Optional zone

zone?: RequestAPIValue<string>

Value for an API domain zone part