hetzner-ts
Preparing search index...
servers/servers
Servers
Class Servers
Hierarchy (
View Summary
)
BaseAPI
Servers
Index
Constructors
constructor
Properties
base
Url
token
Accessors
actions
images
isos
placement
Groups
primary
IP
server
Types
Methods
create
delete
get
get
All
get
Metrics
request
Constructors
constructor
new
Servers
(
token
:
string
,
baseUrl
?:
string
)
:
Servers
Parameters
token
:
string
Optional
baseUrl
:
string
Returns
Servers
Properties
Protected
base
Url
baseUrl
:
string
Protected
token
token
:
string
Accessors
actions
get
actions
()
:
ServerActions
Returns
ServerActions
images
get
images
()
:
Images
Returns
Images
isos
get
isos
()
:
Isos
Returns
Isos
placement
Groups
get
placementGroups
()
:
PlacementGroup
Returns
PlacementGroup
primary
IP
get
primaryIP
()
:
PrimaryIP
List all servers with optional filtering and pagination
Returns
PrimaryIP
server
Types
get
serverTypes
()
:
ServerTypes
Returns
ServerTypes
Methods
create
create
(
params
:
CreateServerParams
,
)
:
Promise
<
|
{
response
:
{
action
:
Action
;
server
:
Server
}
;
success
:
true
}
|
{
response
:
APIError
;
success
:
false
}
,
>
Parameters
params
:
CreateServerParams
Returns
Promise
<
|
{
response
:
{
action
:
Action
;
server
:
Server
}
;
success
:
true
}
|
{
response
:
APIError
;
success
:
false
}
,
>
delete
delete
(
id
:
number
,
)
:
Promise
<
|
{
response
:
Action
;
success
:
true
}
|
{
response
:
APIError
;
success
:
false
}
,
>
Parameters
id
:
number
Returns
Promise
<
|
{
response
:
Action
;
success
:
true
}
|
{
response
:
APIError
;
success
:
false
}
,
>
get
get
(
id
:
number
,
)
:
Promise
<
|
{
response
:
{
server
:
Server
}
;
success
:
true
}
|
{
response
:
APIError
;
success
:
false
}
,
>
Parameters
id
:
number
Returns
Promise
<
|
{
response
:
{
server
:
Server
}
;
success
:
true
}
|
{
response
:
APIError
;
success
:
false
}
,
>
get
All
getAll
(
params
?:
ListServersParams
,
)
:
Promise
<
|
{
response
:
ServersResponse
;
success
:
true
}
|
{
response
:
APIError
;
success
:
false
}
,
>
Parameters
Optional
params
:
ListServersParams
Returns
Promise
<
|
{
response
:
ServersResponse
;
success
:
true
}
|
{
response
:
APIError
;
success
:
false
}
,
>
get
Metrics
getMetrics
(
id
:
number
,
type
:
MetricTypes
,
start
:
string
,
end
:
string
,
step
?:
number
,
)
:
Promise
<
|
{
response
:
{
metrics
:
Metrics
}
;
success
:
true
}
|
{
response
:
APIError
;
success
:
false
}
,
>
Parameters
id
:
number
type
:
MetricTypes
start
:
string
end
:
string
Optional
step
:
number
Returns
Promise
<
|
{
response
:
{
metrics
:
Metrics
}
;
success
:
true
}
|
{
response
:
APIError
;
success
:
false
}
,
>
request
request
<
T
>
(
endpoint
:
string
,
options
?:
RequestInit
,
)
:
Promise
<
{
response
:
T
;
success
:
true
}
|
{
response
:
APIError
;
success
:
false
}
,
>
Type Parameters
T
Parameters
endpoint
:
string
options
:
RequestInit
= {}
Returns
Promise
<
{
response
:
T
;
success
:
true
}
|
{
response
:
APIError
;
success
:
false
}
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
base
Url
token
Accessors
actions
images
isos
placement
Groups
primary
IP
server
Types
Methods
create
delete
get
get
All
get
Metrics
request
hetzner-ts
Loading...
List all servers with optional filtering and pagination