webconsole-cloudapi-client
v1.1.0
Published
Triton Console CloudApi client
Downloads
11
Keywords
Readme
CloudApi fetch client
API
Constructor
token
- included as'X-Auth-Token'
HTTP header on all requests for this client. Require for production.key
- private key used to sign request, must be a string or an object with{ key, passphrase }
keyId
- CloudAPI formatted key ID, usually in the form 'user/keys/md5 id'url
- base URL for CloudAPI servicepathPrefix
- default path prefix for all requests, defaults to'/my'
.log
- function used to log errors for debugging purposestracer
- optional object used for OpenTracing tracing. Must have function forstartSpan
fetch(path[, options ])
path
- is a string of the resource to requestoptions
- object with the following propertiesincludeRes
- boolean, indicates if the rawres
object should be returned. Defaults to only returning thepayload
span
- parent OpenTracing span that initiated this requestmethod
- HTTP method, defaults to 'GET'query
- object with any query string name/values to includepayload
- object to JSON stringify and send to the serverheaders
- any additional HTTP headers to include