Search
Preparing search index...
The search index is not available
@balena/discourse-sdk
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"api/backupsApi"
BackupsApi
Class BackupsApi
Hierarchy
BackupsApi
Index
Constructors
constructor
Properties
_base
Path
_default
Headers
_use
Querystring
interceptors
Accessors
base
Path
default
Headers
use
Querystring
Methods
add
Interceptor
admin
Backups
Filename
Get
admin
Backups
Filename
Put
admin
Backups
Json
Get
admin
Backups
Json
Post
set
Api
Key
set
Default
Authentication
Object literals
authentications
Constructors
constructor
new
Backups
Api
(
basePath
?:
undefined
|
string
)
:
BackupsApi
Parameters
Optional
basePath:
undefined
|
string
Returns
BackupsApi
Properties
Protected
_base
Path
_base
Path
:
string
= defaultBasePath
Protected
_default
Headers
_default
Headers
:
any
Protected
_use
Querystring
_use
Querystring
:
boolean
= false
Protected
interceptors
interceptors
:
Interceptor
[]
= []
Accessors
base
Path
get
basePath
(
)
:
string
set
basePath
(
basePath
:
string
)
:
void
Returns
string
Parameters
basePath:
string
Returns
void
default
Headers
get
defaultHeaders
(
)
:
any
set
defaultHeaders
(
defaultHeaders
:
any
)
:
void
Returns
any
Parameters
defaultHeaders:
any
Returns
void
use
Querystring
set
useQuerystring
(
value
:
boolean
)
:
void
Parameters
value:
boolean
Returns
void
Methods
add
Interceptor
add
Interceptor
(
interceptor
:
Interceptor
)
:
void
Parameters
interceptor:
Interceptor
Returns
void
admin
Backups
Filename
Get
admin
Backups
Filename
Get
(
filename
:
string
, token
:
string
, options
?:
{
headers
:
{}
}
)
:
Promise
<
{
body
?:
any
;
response
:
IncomingMessage
}
>
summary
Download backup
Parameters
filename:
string
token:
string
Default value
options:
{
headers
:
{}
}
= {headers: {}}
headers
:
{}
[
name:
string
]:
string
Returns
Promise
<
{
body
?:
any
;
response
:
IncomingMessage
}
>
admin
Backups
Filename
Put
admin
Backups
Filename
Put
(
filename
:
string
, options
?:
{
headers
:
{}
}
)
:
Promise
<
{
body
?:
any
;
response
:
IncomingMessage
}
>
summary
Send download backup email
Parameters
filename:
string
Default value
options:
{
headers
:
{}
}
= {headers: {}}
headers
:
{}
[
name:
string
]:
string
Returns
Promise
<
{
body
?:
any
;
response
:
IncomingMessage
}
>
admin
Backups
Json
Get
admin
Backups
Json
Get
(
options
?:
{
headers
:
{}
}
)
:
Promise
<
{
body
:
Set
<
InlineResponse200
>
;
response
:
IncomingMessage
}
>
summary
List backups
Parameters
Default value
options:
{
headers
:
{}
}
= {headers: {}}
headers
:
{}
[
name:
string
]:
string
Returns
Promise
<
{
body
:
Set
<
InlineResponse200
>
;
response
:
IncomingMessage
}
>
admin
Backups
Json
Post
admin
Backups
Json
Post
(
inlineObject
?:
InlineObject
, options
?:
{
headers
:
{}
}
)
:
Promise
<
{
body
:
InlineResponse2001
;
response
:
IncomingMessage
}
>
summary
Create backup
Parameters
Optional
inlineObject:
InlineObject
Default value
options:
{
headers
:
{}
}
= {headers: {}}
headers
:
{}
[
name:
string
]:
string
Returns
Promise
<
{
body
:
InlineResponse2001
;
response
:
IncomingMessage
}
>
set
Api
Key
set
Api
Key
(
key
:
BackupsApiApiKeys
, value
:
string
)
:
void
Parameters
key:
BackupsApiApiKeys
value:
string
Returns
void
set
Default
Authentication
set
Default
Authentication
(
auth
:
Authentication
)
:
void
Parameters
auth:
Authentication
Returns
void
Object literals
Protected
authentications
authentications
:
object
default
default
:
Authentication
= <Authentication>new VoidAuth()
Globals
"api/backups
Api"
Backups
Api
Api
Keys
Backups
Api
constructor
_base
Path
_default
Headers
_use
Querystring
interceptors
base
Path
default
Headers
use
Querystring
add
Interceptor
admin
Backups
Filename
Get
admin
Backups
Filename
Put
admin
Backups
Json
Get
admin
Backups
Json
Post
set
Api
Key
set
Default
Authentication
authentications
default
Base
Path
Generated using
TypeDoc
Download backup