-
Notifications
You must be signed in to change notification settings - Fork 5
/
hcloud.json
21181 lines (21181 loc) · 817 KB
/
hcloud.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi": "3.0.3",
"info": {
"title": "Hetzner Cloud API",
"description": "Copied from the official API documentation for the Public Hetzner Cloud.",
"contact": {
"url": "https://docs.hetzner.cloud/"
},
"version": "d44500e-dirty"
},
"servers": [
{
"url": "https://api.hetzner.cloud/v1",
"description": "Official production server"
}
],
"tags": [
{
"name": "actions",
"description": "Actions show the results and progress of asynchronous requests to the API.\n"
},
{
"name": "certificates",
"description": "TLS/SSL Certificates prove the identity of a Server and are used to encrypt client traffic.\n"
},
{
"name": "datacenters",
"description": "Each Datacenter represents a _virtual_ Datacenter which is made up of possible many physical Datacenters where Servers are hosted.\n\nDatacenter names are composed from their Location and virtual Datacenter number, for example `fsn1-dc14` means virtual Datacenter `14` in Location `fsn1`.\n\nRight now there is only one Datacenter for each Location. The Datacenter numbers for `fsn`, `nbg` and `hel` are arbitrarily set to `14`, `3` and `2` for historic reasons and do not represent real physical Hetzner datacenters.\n"
},
{
"name": "firewalls",
"description": "Firewalls can limit the network access to or from your resources.\n\n- When applying a firewall with no `in` rule all inbound traffic will be dropped. The default for `in` is `DROP`.\n- When applying a firewall with no `out` rule all outbound traffic will be accepted. The default for `out` is `ACCEPT`.\n"
},
{
"name": "floating_ips",
"description": "Floating IPs help you to create highly available setups. You can assign a Floating IP to any Server. The Server can then use this IP. You can reassign it to a different Server at any time, or you can choose to unassign the IP from Servers all together.\n\nFloating IPs can be used globally. This means you can assign a Floating IP to a Server in one Location and later reassign it to a Server in a different Location. For optimal routing and latency Floating IPs should be used in the Location they were created in.\n\nFor Floating IPs to work with your Server, you must configure them inside your operation system.\n\nFloating IPs of type `ipv4` use a single IPv4 address as their `ip` property. Floating IPs of type `ipv6` use a /64 network such as `fc00::/64` as their `ip` property. Any IP address within that network can be used on your host.\n\nFloating IPs are billed on a monthly basis.\n"
},
{
"name": "images",
"description": "Images are blueprints for your VM disks. They can be of different types:\n\n### System Images\n\nDistribution Images maintained by us, e.g. “Ubuntu 20.04”\n\n### Snapshot Images\n\nMaintained by you, for example “Ubuntu 20.04 with my own settings”. These are billed per GB per month.\n\n### Backup Images\n\nDaily Backups of your Server. Will automatically be created for Servers which have backups enabled (`POST /servers/{id}/actions/enable_backup`)\n\nBound to exactly one Server. If you delete the Server, you also delete all backups bound to it. You may convert backup Images to snapshot Images to keep them.\n\nThese are billed at 20% of your instance price for 7 backup slots.\n\n### App Images\n\nPrebuild images with specific software configurations, e.g. “Wordpress”. All app images are created by us.\n"
},
{
"name": "isos",
"description": "ISOs are read-only Images of DVDs. While we recommend using our Image functionality to install your Servers we also provide some stock ISOs so you can install more exotic operating systems by yourself.\n\nOn request our support uploads a private ISO just for you. These are marked with type `private` and only visible in your Project.\n\nTo attach an ISO to your Server use `POST /servers/{id}/actions/attach_iso`.\n"
},
{
"name": "load_balancer_types",
"description": "Load Balancer types define kinds of Load Balancers offered. Each type has an hourly and a monthly cost. You will pay whichever amount is lower for your usage of this specific Load Balancer. Costs may differ between Locations.\n\nCurrency for all amounts is €. All prices exclude VAT.\n"
},
{
"name": "load_balancers"
},
{
"name": "locations",
"description": "Datacenters are organized by Locations. Datacenters in the same Location are connected with very low latency links.\n"
},
{
"name": "networks",
"description": "Networks is a private networks feature. These Networks are optional and they coexist with the public network that every Server has by default.\n\nThey allow Servers to talk to each other over a dedicated network interface using private IP addresses not available publicly.\n\nThe IP addresses are allocated and managed via the API, they must conform to [RFC1918](https://tools.ietf.org/html/rfc1918#section-3) standard. IPs and network interfaces defined under Networks do not provide public internet connectivity, you will need to use the already existing public network interface for that.\n\nEach network has a user selected `ip_range` which defines all available IP addresses which can be used for Subnets within the Network.\n\nTo assign individual IPs to Servers you will need to create Network Subnets, described below.\n\nCurrently Networks support IPv4 only.\n\n### Subnets\n\nSubnets divide the `ip_range` from the parent Network object into multiple Subnetworks that you can use for different specific purposes.\n\nFor each subnet you need to specify its own `ip_range` which must be contained within the parent Network’s `ip_range`. Additionally each subnet must belong to one of the available Network Zones described below. Subnets can not have overlapping IP ranges.\n\nCurrently there are three types of subnet:\n\n- type `cloud` is used to connect cloud Resources into your Network.\n- type `server` was used to connect only cloud Servers into your Network. This type is deprecated and is replaced by type cloud.\n- type `vswitch` allows you to connect [Dedicated Server vSwitch](https://docs.hetzner.com/robot/dedicated-server/network/vswitch) - and all Dedicated Servers attached to it - into your Network\n\nSubnets of type `vswitch` must set a `vswitch_id` which is the ID of the existing vSwitch in Hetzner Robot that should be coupled.\n\n### Network Zones\n\nNetwork Zones are groups of Locations which have special high-speed network connections between them. The [Location object](https://docs.hetzner.cloud/#locations-get-a-location) contains the `network_zone` property each Location belongs to. Currently these network zones exist:\n\n| Network Zone | Contains Locations |\n| ------------ | ------------------ |\n| eu-central | nbg1, fsn1, hel1 |\n| us-east | ash |\n| us-west | hil |\n| ap-southeast | sin |\n\n### IP address management\n\nWhen a cloud Server is attached to a network without the user specifying an IP it automatically gets an IP address assigned from a subnet of type `server` in the same network zone. If you specify the optional `ip` parameter when attaching then we will try to assign that IP. Keep in mind that the Server’s location must be covered by the Subnet’s Network Zone if you specify an IP, or that at least one Subnet with the zone covering Server’s location must exist.\n\nA cloud Server can also have more than one IP address in a Network by specifying aliases. For details see the [attach to network action](https://docs.hetzner.cloud/#server-actions-attach-a-server-to-a-network).\n\nThe following IP addresses are reserved in networks and can not be used:\n\n- the first IP of the network `ip_range` as it will be used as a default gateway for the private Network interface.\n- `172.31.1.1` as it is being used as default gateway for our public Network interfaces.\n\n### Coupling Dedicated Servers\n\nBy using subnets of type `vswitch` you can couple the Cloud Networks with an existing [Dedicated Server vSwitch](https://docs.hetzner.com/robot/dedicated-server/network/vswitch) and enable dedicated and cloud servers to\ntalk to each other over the Network.\nIn order for this to work the dedicated servers may only use IPs from the subnet and must have a special network configuration. Please refer to [FAQ](https://docs.hetzner.com/cloud/networks/connect-dedi-vswitch). vSwitch Layer 2 features are not supported.\n\n### Routes\n\nNetworks also support the notion of routes which are automatically applied to private traffic. A route makes sure that all packets for a given `destination` IP prefix will be sent to the address specified in its `gateway`.\n"
},
{
"name": "placement_groups",
"description": "Placement groups are used to influence the location of interdependent virtual servers in our data centers. The distribution of the different instances within a group is based on a pattern specified in the type. By enforcing certain rules on the placement of instances within our infrastructure, availability can be influenced in a way that fits your needs best.\n\nIn `spread` placement groups, all virtual servers will run on different physical servers. This decreases the probability that some instances might fail together.\n"
},
{
"name": "pricing",
"description": "Returns prices for resources.\n"
},
{
"name": "primary_ips",
"description": "Primary IPs help you to create more flexible networking setups. You can assign at most one Primary IP of type `ipv4` and one of type `ipv6` per Server. This Server then uses these IPs.\n\nYou can only unassign a Primary IP from a Server when it's powered off. This Primary IP can then be assigned to a different powered off Server, or you can keep it around for later use.\n\nPrimary IPs are bound to a specific Datacenter. You can not assign a Primary IP from one Datacenter to a Server in a different Datacenter. If you need this capability use Floating IPs instead.\n\nIf your Server's operating system supports cloud-init there is no further configuration needed to make Primary IPs work.\n\nPrimary IPs of type `ipv4` use a single IPv4 address as their `ip` property. Primary IPs of type `ipv6` use a /64 network such as `fc00::/64` as their `ip` property. Any IP address within that network can be used on your host.\n\nPrimary IPs are billed on an hourly basis.\n"
},
{
"name": "server_types",
"description": "Server types define kinds of Servers offered. Each type has an hourly and a monthly cost. You will pay whichever cost is lower for your usage of this specific Server. Costs may differ between Locations.\n\nCurrency for all amounts is €. All prices exclude VAT.\n"
},
{
"name": "servers",
"description": "Servers are virtual machines that can be provisioned.\n"
},
{
"name": "ssh_keys",
"description": "SSH keys are public keys you provide to the cloud system. They can be injected into Servers at creation time. We highly recommend that you use keys instead of passwords to manage your Servers.\n"
},
{
"name": "volumes",
"description": "A Volume is a highly-available, scalable, and SSD-based block storage for Servers.\n\nPricing for Volumes depends on the Volume size and Location, not the actual used storage.\n\nPlease see [Hetzner Docs](https://docs.hetzner.com/cloud/#Volumes) for more details about Volumes.\n"
}
],
"components": {
"parameters": {
"PathActionActionID": {
"description": "ID of the Action.",
"in": "path",
"name": "action_id",
"required": true,
"schema": {
"description": "ID of the Action.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathActionID": {
"description": "ID of the Action.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Action.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathCertificateID": {
"description": "ID of the Certificate.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Certificate.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathDatacenterID": {
"description": "ID of the Datacenter.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Datacenter.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathFirewallID": {
"description": "ID of the Firewall.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Firewall.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathFloatingIPID": {
"description": "ID of the Floating IP.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Floating IP.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathID": {
"description": "ID of the Resource.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Resource.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathISOID": {
"description": "ID of the ISO.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the ISO.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathImageID": {
"description": "ID of the Image.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Image.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathLoadBalancerID": {
"description": "ID of the Load Balancer.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Load Balancer.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathLoadBalancerTypeID": {
"description": "ID of the Load Balancer Type.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Load Balancer Type.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathLocationID": {
"description": "ID of the Location.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Location.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathNetworkID": {
"description": "ID of the Network.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Network.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathPlacementGroupID": {
"description": "ID of the Placement Group.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Placement Group.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathPrimaryIPID": {
"description": "ID of the Primary IP.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Primary IP.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathSSHKeyID": {
"description": "ID of the SSH Key.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the SSH Key.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathServerID": {
"description": "ID of the Server.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Server.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathServerTypeID": {
"description": "ID of the Server Type.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Server Type.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"PathVolumeID": {
"description": "ID of the Volume.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Volume.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"QueryActionID": {
"description": "Filter the actions by ID. Can be used multiple times. The response will only contain\nactions matching the specified IDs.\n",
"in": "query",
"name": "id",
"required": false,
"schema": {
"description": "ID of the Action.",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
}
},
"QueryActionSort": {
"description": "Sort actions by field and direction. Can be used multiple times. For more\ninformation, see \"[Sorting](#sorting)\".\n",
"in": "query",
"name": "sort",
"required": false,
"schema": {
"enum": [
"id",
"id:asc",
"id:desc",
"command",
"command:asc",
"command:desc",
"status",
"status:asc",
"status:desc",
"started",
"started:asc",
"started:desc",
"finished",
"finished:asc",
"finished:desc"
],
"type": "string"
}
},
"QueryActionStatus": {
"description": "Filter the actions by status. Can be used multiple times. The response will only\ncontain actions matching the specified statuses.\n",
"in": "query",
"name": "status",
"required": false,
"schema": {
"description": "Status of the Action.",
"enum": [
"running",
"success",
"error"
],
"type": "string"
}
},
"QueryCreatedAfter": {
"description": "Limit the items in the response to be created after a specified time.\n\nThe parameter is a datetime formatted as specified by RFC3339.\n",
"in": "query",
"name": "created_after",
"required": false,
"schema": {
"example": "2016-07-02T01:02:03.04Z",
"type": "string"
}
},
"QueryCreatedBefore": {
"description": "Limit the items in the response to be created before a specified time.\n\nThe parameter is a datetime formatted as specified by RFC3339.\n",
"in": "query",
"name": "created_before",
"required": false,
"schema": {
"example": "2016-07-02T01:02:03.04Z",
"type": "string"
}
},
"QueryLabelSelector": {
"description": "Filter resources by labels. The response will only contain resources matching the\nlabel selector. For more information, see \"[Label Selector](#label-selector)\".\n",
"in": "query",
"name": "label_selector",
"required": false,
"schema": {
"type": "string"
}
},
"QueryName": {
"description": "Filter resources by their name. The response will only contain the resources\nmatching the specified name.\n",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
"QueryPaginationPage": {
"description": "Page number to return. For more information, see \"[Pagination](#pagination)\".",
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"example": 2,
"format": "int64",
"type": "integer"
}
},
"QueryPaginationPerPage": {
"description": "Maximum number of entries returned per page. For more information, see \"[Pagination](#pagination)\".",
"in": "query",
"name": "per_page",
"required": false,
"schema": {
"default": 25,
"example": 25,
"format": "int64",
"type": "integer"
}
},
"QuerySortByIDAndCreated": {
"description": "Sort resources by field and direction. Can be used multiple times. For more\ninformation, see \"[Sorting](#sorting)\".\n",
"in": "query",
"name": "sort",
"required": false,
"schema": {
"enum": [
"id",
"id:asc",
"id:desc",
"created",
"created:asc",
"created:desc"
],
"type": "string"
}
},
"QuerySortByIDAndName": {
"description": "Sort resources by field and direction. Can be used multiple times. For more\ninformation, see \"[Sorting](#sorting)\".\n",
"in": "query",
"name": "sort",
"required": false,
"schema": {
"enum": [
"id",
"id:asc",
"id:desc",
"name",
"name:asc",
"name:desc"
],
"type": "string"
}
},
"QuerySortByIDAndNameAndCreated": {
"description": "Sort resources by field and direction. Can be used multiple times. For more\ninformation, see \"[Sorting](#sorting)\".\n",
"in": "query",
"name": "sort",
"required": false,
"schema": {
"enum": [
"id",
"id:asc",
"id:desc",
"name",
"name:asc",
"name:desc",
"created",
"created:asc",
"created:desc"
],
"type": "string"
}
}
},
"schemas": {
"action": {
"properties": {
"command": {
"description": "Command executed in the Action.",
"example": "start_resource",
"type": "string"
},
"error": {
"$ref": "#/components/schemas/error"
},
"finished": {
"description": "Point in time when the Action was finished (in ISO-8601 format). Only set if the Action is finished otherwise null.",
"example": "2016-01-30T23:55:00+00:00",
"nullable": true,
"type": "string"
},
"id": {
"description": "ID of the Action",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
},
"progress": {
"description": "Progress of the Action in percent.",
"example": 100,
"format": "int32",
"type": "integer"
},
"resources": {
"description": "Resources the Action relates to.",
"items": {
"$ref": "#/components/schemas/resource"
},
"type": "array"
},
"started": {
"description": "Point in time when the Action was started (in ISO-8601 format).",
"example": "2016-01-30T23:55:00+00:00",
"type": "string"
},
"status": {
"description": "Status of the Action.",
"enum": [
"error",
"running",
"success"
],
"type": "string"
}
},
"required": [
"id",
"command",
"status",
"progress",
"started",
"finished",
"resources",
"error"
],
"title": "Action",
"type": "object",
"description": "Actions show the results and progress of asynchronous requests to the API."
},
"action_optional": {
"nullable": true,
"properties": {
"command": {
"description": "Command executed in the Action.",
"example": "start_resource",
"type": "string"
},
"error": {
"$ref": "#/components/schemas/error"
},
"finished": {
"description": "Point in time when the Action was finished (in ISO-8601 format). Only set if the Action is finished otherwise null.",
"example": "2016-01-30T23:55:00+00:00",
"nullable": true,
"type": "string"
},
"id": {
"description": "ID of the Action",
"example": 42,
"format": "int64",
"maximum": 9007199254740991,
"type": "integer"
},
"progress": {
"description": "Progress of the Action in percent.",
"example": 100,
"format": "int32",
"type": "integer"
},
"resources": {
"description": "Resources the Action relates to.",
"items": {
"$ref": "#/components/schemas/resource"
},
"type": "array"
},
"started": {
"description": "Point in time when the Action was started (in ISO-8601 format).",
"example": "2016-01-30T23:55:00+00:00",
"type": "string"
},
"status": {
"description": "Status of the Action.",
"enum": [
"error",
"running",
"success"
],
"type": "string"
}
},
"required": [
"id",
"command",
"status",
"progress",
"started",
"finished",
"resources",
"error"
],
"title": "ActionNullable",
"type": "object",
"description": "Actions show the results and progress of asynchronous requests to the API."
},
"add_route_to_network_request": {
"$ref": "#/components/schemas/route"
},
"add_route_to_network_response": {
"properties": {
"action": {
"$ref": "#/components/schemas/action"
}
},
"required": [
"action"
],
"title": "ActionResponse",
"type": "object",
"description": "Response to POST https://api.hetzner.cloud/v1/networks/{id}/actions/add_route"
},
"add_server_to_placement_group_request": {
"properties": {
"placement_group": {
"description": "ID of Placement Group the Server should be added to",
"example": 1,
"format": "int64",
"type": "integer"
}
},
"required": [
"placement_group"
],
"title": "AddToPlacementGroupRequest",
"type": "object",
"description": "Request for POST https://api.hetzner.cloud/v1/servers/{id}/actions/add_to_placement_group"
},
"add_server_to_placement_group_response": {
"properties": {
"action": {
"$ref": "#/components/schemas/action"
}
},
"required": [
"action"
],
"title": "ActionResponse",
"type": "object",
"description": "Response to POST https://api.hetzner.cloud/v1/servers/{id}/actions/add_to_placement_group"
},
"add_service_request": {
"$ref": "#/components/schemas/load_balancer_service"
},
"add_service_response": {
"properties": {
"action": {
"$ref": "#/components/schemas/action"
}
},
"required": [
"action"
],
"title": "ActionResponse",
"type": "object",
"description": "Response to POST https://api.hetzner.cloud/v1/load_balancers/{id}/actions/add_service"
},
"add_subnet_to_network_request": {
"$ref": "#/components/schemas/subnet"
},
"add_subnet_to_network_response": {
"properties": {
"action": {
"$ref": "#/components/schemas/action"
}
},
"required": [
"action"
],
"title": "ActionResponse",
"type": "object",
"description": "Response to POST https://api.hetzner.cloud/v1/networks/{id}/actions/add_subnet"
},
"add_target_request": {
"$ref": "#/components/schemas/load_balancer_add_target"
},
"add_target_response": {
"properties": {
"action": {
"$ref": "#/components/schemas/action"
}
},
"required": [
"action"
],
"title": "ActionResponse",
"type": "object",
"description": "Response to POST https://api.hetzner.cloud/v1/load_balancers/{id}/actions/add_target"
},
"apply_to_resources_request": {
"properties": {
"apply_to": {
"description": "Resources to apply the [Firewall](#firewalls) to.\n\nExtends existing resources.\n",
"items": {
"$ref": "#/components/schemas/firewall_resource"
},
"type": "array"
}
},
"required": [
"apply_to"
],
"title": "ApplyToResourcesRequest",
"type": "object",
"description": "Request for POST https://api.hetzner.cloud/v1/firewalls/{id}/actions/apply_to_resources"
},
"apply_to_resources_response": {
"properties": {
"actions": {
"items": {
"$ref": "#/components/schemas/action"
},
"type": "array"
}
},
"required": [
"actions"
],
"title": "ActionListResponse",
"type": "object",
"description": "Response to POST https://api.hetzner.cloud/v1/firewalls/{id}/actions/apply_to_resources"
},
"architecture": {
"description": "Type of cpu architecture this image is compatible with. | Type of cpu architecture",
"enum": [
"arm",
"x86"
],
"example": "x86",
"type": "string"
},
"architecture_optional": {
"description": "Type of cpu architecture this iso is compatible with. Null indicates no restriction on the architecture (wildcard).",
"enum": [
"arm",
"x86"
],
"example": "x86",
"nullable": true,
"type": "string"
},
"assign_floating_ip_to_server_request": {
"description": "Request for POST https://api.hetzner.cloud/v1/floating_ips/{id}/actions/assign",
"properties": {
"server": {
"description": "[Server](#servers) the [Floating IP](#floating-ips) is assigned to.\n\n`null` if not assigned.\n",
"example": 42,
"format": "int64",
"nullable": true,
"type": "integer"
}
},
"required": [
"server"
],
"title": "FloatingIPActionsAssignRequest",
"type": "object"
},
"assign_floating_ip_to_server_response": {
"properties": {
"action": {
"$ref": "#/components/schemas/action"
}
},
"required": [
"action"
],
"title": "ActionResponse",
"type": "object",
"description": "Response to POST https://api.hetzner.cloud/v1/floating_ips/{id}/actions/assign"
},
"assign_primary_ip_to_resource_request": {
"properties": {
"assignee_id": {
"description": "ID of a resource of type `assignee_type`",
"example": 4711,
"format": "int64",
"type": "integer"
},
"assignee_type": {
"description": "Type of resource assigning the Primary IP to",
"enum": [
"server"
],
"example": "server",
"type": "string"
}
},
"required": [
"assignee_type",
"assignee_id"
],
"title": "PrimaryIPActionsAssignRequest",
"type": "object",
"description": "Request for POST https://api.hetzner.cloud/v1/primary_ips/{id}/actions/assign"
},
"assign_primary_ip_to_resource_response": {
"properties": {
"action": {
"$ref": "#/components/schemas/action"
}
},
"required": [
"action"
],
"title": "ActionResponse",
"type": "object",
"description": "Response to POST https://api.hetzner.cloud/v1/primary_ips/{id}/actions/assign"
},
"attach_iso_to_server_request": {
"properties": {
"iso": {
"description": "ID or name of ISO to attach to the Server as listed in GET `/isos`",
"example": "FreeBSD-11.0-RELEASE-amd64-dvd1",
"type": "string"
}
},
"required": [
"iso"
],
"type": "object",
"description": "Request for POST https://api.hetzner.cloud/v1/servers/{id}/actions/attach_iso"
},
"attach_iso_to_server_response": {
"properties": {
"action": {
"$ref": "#/components/schemas/action"
}
},
"required": [
"action"
],
"title": "ActionResponse",
"type": "object",
"description": "Response to POST https://api.hetzner.cloud/v1/servers/{id}/actions/attach_iso"
},
"attach_load_balancer_to_network_request": {
"properties": {
"ip": {
"description": "IP to request to be assigned to this Load Balancer; if you do not provide this then you will be auto assigned an IP address",
"example": "10.0.1.1",
"type": "string"
},
"network": {
"description": "ID of an existing network to attach the Load Balancer to",
"example": 4711,
"format": "int64",
"type": "integer"
}
},
"required": [
"network"
],
"type": "object",
"description": "Request for POST https://api.hetzner.cloud/v1/load_balancers/{id}/actions/attach_to_network"
},
"attach_load_balancer_to_network_response": {
"properties": {
"action": {
"$ref": "#/components/schemas/action"
}
},
"required": [
"action"
],
"title": "ActionResponse",
"type": "object",
"description": "Response to POST https://api.hetzner.cloud/v1/load_balancers/{id}/actions/attach_to_network"
},
"attach_server_to_network_request": {
"properties": {
"alias_ips": {
"description": "Additional IPs to be assigned to this Server",
"example": [
"10.0.1.2"
],
"items": {
"type": "string"
},
"type": "array"
},
"ip": {
"description": "IP to request to be assigned to this Server; if you do not provide this then you will be auto assigned an IP address",
"example": "10.0.1.1",
"type": "string"
},
"network": {
"description": "ID of an existing network to attach the Server to",
"example": 4711,
"format": "int64",
"type": "integer"
}
},
"required": [
"network"
],
"title": "AttachToNetworkRequest",
"type": "object",
"description": "Request for POST https://api.hetzner.cloud/v1/servers/{id}/actions/attach_to_network"
},
"attach_server_to_network_response": {
"properties": {
"action": {
"$ref": "#/components/schemas/action"
}
},
"required": [
"action"
],
"title": "ActionResponse",
"type": "object",
"description": "Response to POST https://api.hetzner.cloud/v1/servers/{id}/actions/attach_to_network"
},
"attach_volume_to_server_request": {
"properties": {
"automount": {
"description": "Auto-mount the Volume after attaching it",
"example": false,
"type": "boolean"
},
"server": {
"description": "ID of the Server the Volume will be attached to",
"example": 43,
"format": "int64",
"type": "integer"
}
},
"required": [
"server"
],
"title": "AttachVolumeRequest",
"type": "object",
"description": "Request for POST https://api.hetzner.cloud/v1/volumes/{id}/actions/attach"
},
"attach_volume_to_server_response": {
"properties": {
"action": {
"$ref": "#/components/schemas/action"
}
},
"required": [
"action"
],
"title": "ActionResponse",
"type": "object",
"description": "Response to POST https://api.hetzner.cloud/v1/volumes/{id}/actions/attach"
},
"certificate": {
"properties": {
"certificate": {
"description": "Certificate and chain in PEM format, in order so that each record directly certifies the one preceding",
"example": "-----BEGIN CERTIFICATE-----\n...",
"nullable": true,
"type": "string"
},