@truenas/api-client
GitHub
Preparing search index...
@truenas/api-client
Namespaces
v25_10_0
v25_10_1
v25_10_2
v25_10_3
v25_10_4
v25_10_5
v26_0_0
v27_0_0
Enumerations
AppState
AuthErrorCode
JobState
TrueNasAuthMechanism
VersionCompatibility
Classes
AuthError
InvalidVersionResponseError
NoCompatibleVersionsError
TrueNasApiClient
TrueNasApiClientV2510
TrueNasApiClientV26
VersionDiscovery
VersionDiscoveryError
VersionDiscoveryNetworkError
VersionDiscoveryTimeoutError
VersionEndpointNotFoundError
VersionTooNewError
VersionTooOldError
Interfaces
ApiCallDirectoryV25_10_0
ApiDirectoryByVersion
ApiDirectoryShape
ApiEventDirectoryV25_10_0
ApiJobDirectoryV25_10_0
ApiKeyCreate
ApiVersion
AuthResponse
BaseApiDirectory
Container
CreateClientOptions
Logger
OperationMappings
Type Aliases
ApiCallDirectoryV25_10_1
ApiCallDirectoryV25_10_2
ApiCallDirectoryV25_10_3
ApiCallDirectoryV25_10_4
ApiCallDirectoryV25_10_5
ApiCallDirectoryV26_0_0
ApiCallDirectoryV27_0_0
ApiError
ApiEventDirectoryV25_10_1
ApiEventDirectoryV25_10_2
ApiEventDirectoryV25_10_3
ApiEventDirectoryV25_10_4
ApiEventDirectoryV25_10_5
ApiEventDirectoryV26_0_0
ApiEventDirectoryV27_0_0
ApiJobDirectoryV25_10_1
ApiJobDirectoryV25_10_2
ApiJobDirectoryV25_10_3
ApiJobDirectoryV25_10_4
ApiJobDirectoryV25_10_5
ApiJobDirectoryV26_0_0
ApiJobDirectoryV27_0_0
ApiVersionResponse
ArgsOf
CallMethod
CallParams
CallResponse
DefaultApiDirectory
EventKind
EventName
EventUnion
Job
JobMethod
JobParams
JobProgress
JobResult
QueryDirectory
QueryEntity
QueryListOptions
QueryMethod
QuerySingleOptions
SupportedApiVersion
TrueNasDate
Variables
consoleLogger
noopLogger
SUPPORTED_API_VERSIONS
Functions
createTrueNasClient
getApiErrorMessage
isJobFinished
References
ApiDirectoryV25_10_0
→
v25_10_0
.
ApiDirectory
ApiDirectoryV25_10_1
→
v25_10_1
.
ApiDirectory
ApiDirectoryV25_10_2
→
v25_10_2
.
ApiDirectory
ApiDirectoryV25_10_3
→
v25_10_3
.
ApiDirectory
ApiDirectoryV25_10_4
→
v25_10_4
.
ApiDirectory
ApiDirectoryV25_10_5
→
v25_10_5
.
ApiDirectory
ApiDirectoryV26_0_0
→
v26_0_0
.
ApiDirectory
ApiDirectoryV27_0_0
→
v27_0_0
.
ApiDirectory
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Namespaces
v25_
10_
0
v25_
10_
1
v25_
10_
2
v25_
10_
3
v25_
10_
4
v25_
10_
5
v26_
0_
0
v27_
0_
0
Enumerations
App
State
Auth
Error
Code
Job
State
True
Nas
Auth
Mechanism
Version
Compatibility
Classes
Auth
Error
Invalid
Version
Response
Error
No
Compatible
Versions
Error
True
Nas
Api
Client
True
Nas
Api
Client
V2510
True
Nas
Api
Client
V26
Version
Discovery
Version
Discovery
Error
Version
Discovery
Network
Error
Version
Discovery
Timeout
Error
Version
Endpoint
Not
Found
Error
Version
Too
New
Error
Version
Too
Old
Error
Interfaces
Api
Call
Directory
V25_
10_
0
Api
Directory
By
Version
Api
Directory
Shape
Api
Event
Directory
V25_
10_
0
Api
Job
Directory
V25_
10_
0
Api
Key
Create
Api
Version
Auth
Response
Base
Api
Directory
Container
Create
Client
Options
Logger
Operation
Mappings
Type Aliases
Api
Call
Directory
V25_
10_
1
Api
Call
Directory
V25_
10_
2
Api
Call
Directory
V25_
10_
3
Api
Call
Directory
V25_
10_
4
Api
Call
Directory
V25_
10_
5
Api
Call
Directory
V26_
0_
0
Api
Call
Directory
V27_
0_
0
Api
Error
Api
Event
Directory
V25_
10_
1
Api
Event
Directory
V25_
10_
2
Api
Event
Directory
V25_
10_
3
Api
Event
Directory
V25_
10_
4
Api
Event
Directory
V25_
10_
5
Api
Event
Directory
V26_
0_
0
Api
Event
Directory
V27_
0_
0
Api
Job
Directory
V25_
10_
1
Api
Job
Directory
V25_
10_
2
Api
Job
Directory
V25_
10_
3
Api
Job
Directory
V25_
10_
4
Api
Job
Directory
V25_
10_
5
Api
Job
Directory
V26_
0_
0
Api
Job
Directory
V27_
0_
0
Api
Version
Response
Args
Of
Call
Method
Call
Params
Call
Response
Default
Api
Directory
Event
Kind
Event
Name
Event
Union
Job
Job
Method
Job
Params
Job
Progress
Job
Result
Query
Directory
Query
Entity
Query
List
Options
Query
Method
Query
Single
Options
Supported
Api
Version
True
Nas
Date
Variables
console
Logger
noop
Logger
SUPPORTED_
API_
VERSIONS
Functions
create
True
Nas
Client
get
Api
Error
Message
is
Job
Finished
References
Api
Directory
V25_
10_
0
Api
Directory
V25_
10_
1
Api
Directory
V25_
10_
2
Api
Directory
V25_
10_
3
Api
Directory
V25_
10_
4
Api
Directory
V25_
10_
5
Api
Directory
V26_
0_
0
Api
Directory
V27_
0_
0
GitHub
@truenas/api-client
Loading...