-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathrest-api.yaml
16756 lines (16738 loc) · 622 KB
/
rest-api.yaml
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
definitions:
Access:
items:
$ref: '#/definitions/AccessEntry'
title: Access represents everyone that may access a particular resource.
type: array
x-go-package: github.com/lxc/incus/v6/shared/api
AccessEntry:
properties:
identifier:
description: Certificate fingerprint
example: 636b69519d27ae3b0e398cb7928043846ce1e3842f0ca7a589993dd913ab8cc9
type: string
x-go-name: Identifier
provider:
description: Which authorization method the certificate uses
example: tls, openfga
type: string
x-go-name: Provider
role:
description: The role associated with the certificate
example: admin, view, operator
type: string
x-go-name: Role
title: AccessEntry represents an entity having access to the resource.
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
Certificate:
description: Certificate represents a certificate
properties:
certificate:
description: The certificate itself, as PEM encoded X509 (or as base64 encoded X509 on POST)
example: X509 PEM certificate
type: string
x-go-name: Certificate
description:
description: Certificate description
example: X509 certificate
type: string
x-go-name: Description
fingerprint:
description: SHA256 fingerprint of the certificate
example: fd200419b271f1dc2a5591b693cc5774b7f234e1ff8c6b78ad703b6888fe2b69
readOnly: true
type: string
x-go-name: Fingerprint
name:
description: Name associated with the certificate
example: castiana
type: string
x-go-name: Name
projects:
description: List of allowed projects (applies when restricted)
example:
- default
- foo
- bar
items:
type: string
type: array
x-go-name: Projects
restricted:
description: Whether to limit the certificate to listed projects
example: true
type: boolean
x-go-name: Restricted
type:
description: Usage type for the certificate
example: client
type: string
x-go-name: Type
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
CertificateAddToken:
properties:
addresses:
description: The addresses of the server
example:
- 10.98.30.229:8443
items:
type: string
type: array
x-go-name: Addresses
client_name:
description: The name of the new client
example: user@host
type: string
x-go-name: ClientName
expires_at:
description: The token's expiry date.
example: "2021-03-23T17:38:37.753398689-04:00"
format: date-time
type: string
x-go-name: ExpiresAt
fingerprint:
description: The fingerprint of the network certificate
example: 57bb0ff4340b5bb28517e062023101adf788c37846dc8b619eb2c3cb4ef29436
type: string
x-go-name: Fingerprint
secret:
description: The random join secret
example: 2b2284d44db32675923fe0d2020477e0e9be11801ff70c435e032b97028c35cd
type: string
x-go-name: Secret
title: CertificateAddToken represents the fields contained within an encoded certificate add token.
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
CertificatePut:
description: CertificatePut represents the modifiable fields of a certificate
properties:
certificate:
description: The certificate itself, as PEM encoded X509 (or as base64 encoded X509 on POST)
example: X509 PEM certificate
type: string
x-go-name: Certificate
description:
description: Certificate description
example: X509 certificate
type: string
x-go-name: Description
name:
description: Name associated with the certificate
example: castiana
type: string
x-go-name: Name
projects:
description: List of allowed projects (applies when restricted)
example:
- default
- foo
- bar
items:
type: string
type: array
x-go-name: Projects
restricted:
description: Whether to limit the certificate to listed projects
example: true
type: boolean
x-go-name: Restricted
type:
description: Usage type for the certificate
example: client
type: string
x-go-name: Type
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
CertificatesPost:
description: CertificatesPost represents the fields of a new certificate
properties:
certificate:
description: The certificate itself, as PEM encoded X509 (or as base64 encoded X509 on POST)
example: X509 PEM certificate
type: string
x-go-name: Certificate
description:
description: Certificate description
example: X509 certificate
type: string
x-go-name: Description
name:
description: Name associated with the certificate
example: castiana
type: string
x-go-name: Name
projects:
description: List of allowed projects (applies when restricted)
example:
- default
- foo
- bar
items:
type: string
type: array
x-go-name: Projects
restricted:
description: Whether to limit the certificate to listed projects
example: true
type: boolean
x-go-name: Restricted
token:
description: Whether to create a certificate add token
example: true
type: boolean
x-go-name: Token
trust_token:
description: Trust token (used to add an untrusted client)
example: blah
type: string
x-go-name: TrustToken
type:
description: Usage type for the certificate
example: client
type: string
x-go-name: Type
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
Cluster:
properties:
enabled:
description: Whether clustering is enabled
example: true
type: boolean
x-go-name: Enabled
member_config:
description: List of member configuration keys (used during join)
example: []
items:
$ref: '#/definitions/ClusterMemberConfigKey'
type: array
x-go-name: MemberConfig
server_name:
description: Name of the cluster member answering the request
example: server01
type: string
x-go-name: ServerName
title: Cluster represents high-level information about a cluster.
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ClusterCertificatePut:
description: ClusterCertificatePut represents the certificate and key pair for all cluster members
properties:
cluster_certificate:
description: The new certificate (X509 PEM encoded) for the cluster
example: X509 PEM certificate
type: string
x-go-name: ClusterCertificate
cluster_certificate_key:
description: The new certificate key (X509 PEM encoded) for the cluster
example: X509 PEM certificate key
type: string
x-go-name: ClusterCertificateKey
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ClusterGroup:
properties:
config:
additionalProperties:
type: string
description: Cluster group configuration map
example:
user.mykey: foo
type: object
x-go-name: Config
description:
description: The description of the cluster group
example: amd64 servers
type: string
x-go-name: Description
members:
description: List of members in this group
example:
- server01
- server02
items:
type: string
type: array
x-go-name: Members
name:
description: The new name of the cluster group
example: group1
type: string
x-go-name: Name
title: ClusterGroup represents a cluster group.
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ClusterGroupPost:
properties:
name:
description: The new name of the cluster group
example: group1
type: string
x-go-name: Name
title: ClusterGroupPost represents the fields required to rename a cluster group.
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ClusterGroupPut:
properties:
config:
additionalProperties:
type: string
description: Cluster group configuration map
example:
user.mykey: foo
type: object
x-go-name: Config
description:
description: The description of the cluster group
example: amd64 servers
type: string
x-go-name: Description
members:
description: List of members in this group
example:
- server01
- server02
items:
type: string
type: array
x-go-name: Members
title: ClusterGroupPut represents the modifiable fields of a cluster group.
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ClusterGroupsPost:
properties:
config:
additionalProperties:
type: string
description: Cluster group configuration map
example:
user.mykey: foo
type: object
x-go-name: Config
description:
description: The description of the cluster group
example: amd64 servers
type: string
x-go-name: Description
members:
description: List of members in this group
example:
- server01
- server02
items:
type: string
type: array
x-go-name: Members
name:
description: The new name of the cluster group
example: group1
type: string
x-go-name: Name
title: ClusterGroupsPost represents the fields available for a new cluster group.
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ClusterMember:
properties:
architecture:
description: The primary architecture of the cluster member
example: x86_64
type: string
x-go-name: Architecture
config:
additionalProperties:
type: string
description: Additional configuration information
example:
scheduler.instance: all
type: object
x-go-name: Config
database:
description: Whether the cluster member is a database server
example: true
type: boolean
x-go-name: Database
description:
description: Cluster member description
example: AMD Epyc 32c/64t
type: string
x-go-name: Description
failure_domain:
description: Name of the failure domain for this cluster member
example: rack1
type: string
x-go-name: FailureDomain
groups:
description: List of cluster groups this member belongs to
example:
- group1
- group2
items:
type: string
type: array
x-go-name: Groups
message:
description: Additional status information
example: fully operational
type: string
x-go-name: Message
roles:
description: List of roles held by this cluster member
example:
- database
items:
type: string
type: array
x-go-name: Roles
server_name:
description: Name of the cluster member
example: server01
type: string
x-go-name: ServerName
status:
description: Current status
example: Online
type: string
x-go-name: Status
url:
description: URL at which the cluster member can be reached
example: https://10.0.0.1:8443
type: string
x-go-name: URL
title: ClusterMember represents a member of a cluster.
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ClusterMemberConfigKey:
description: |-
The Value field is empty when getting clustering information with GET
1.0/cluster, and should be filled by the joining server when performing a PUT
1.0/cluster join request.
properties:
description:
description: A human friendly description key
example: '"source" property for storage pool "local"'
type: string
x-go-name: Description
entity:
description: The kind of configuration key (network, storage-pool, ...)
example: storage-pool
type: string
x-go-name: Entity
key:
description: The name of the key
example: source
type: string
x-go-name: Key
name:
description: The name of the object requiring this key
example: local
type: string
x-go-name: Name
value:
description: The value on the answering cluster member
example: /dev/sdb
type: string
x-go-name: Value
title: |-
ClusterMemberConfigKey represents a single config key that a new member of
the cluster is required to provide when joining.
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ClusterMemberJoinToken:
properties:
addresses:
description: The addresses of existing online cluster members
example:
- 10.98.30.229:8443
items:
type: string
type: array
x-go-name: Addresses
expires_at:
description: The token's expiry date.
example: "2021-03-23T17:38:37.753398689-04:00"
format: date-time
type: string
x-go-name: ExpiresAt
fingerprint:
description: The fingerprint of the network certificate
example: 57bb0ff4340b5bb28517e062023101adf788c37846dc8b619eb2c3cb4ef29436
type: string
x-go-name: Fingerprint
secret:
description: The random join secret.
example: 2b2284d44db32675923fe0d2020477e0e9be11801ff70c435e032b97028c35cd
type: string
x-go-name: Secret
server_name:
description: The name of the new cluster member
example: server02
type: string
x-go-name: ServerName
title: ClusterMemberJoinToken represents the fields contained within an encoded cluster member join token.
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ClusterMemberPost:
properties:
server_name:
description: The new name of the cluster member
example: server02
type: string
x-go-name: ServerName
title: ClusterMemberPost represents the fields required to rename a cluster member.
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ClusterMemberPut:
description: ClusterMemberPut represents the modifiable fields of a cluster member
properties:
config:
additionalProperties:
type: string
description: Additional configuration information
example:
scheduler.instance: all
type: object
x-go-name: Config
description:
description: Cluster member description
example: AMD Epyc 32c/64t
type: string
x-go-name: Description
failure_domain:
description: Name of the failure domain for this cluster member
example: rack1
type: string
x-go-name: FailureDomain
groups:
description: List of cluster groups this member belongs to
example:
- group1
- group2
items:
type: string
type: array
x-go-name: Groups
roles:
description: List of roles held by this cluster member
example:
- database
items:
type: string
type: array
x-go-name: Roles
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ClusterMemberState:
properties:
storage_pools:
additionalProperties:
$ref: '#/definitions/StoragePoolState'
type: object
x-go-name: StoragePools
sysinfo:
$ref: '#/definitions/ClusterMemberSysInfo'
title: ClusterMemberState represents the state of a cluster member.
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ClusterMemberStatePost:
properties:
action:
description: The action to be performed. Valid actions are "evacuate" and "restore".
example: evacuate
type: string
x-go-name: Action
mode:
description: Override the configured evacuation mode.
example: stop
type: string
x-go-name: Mode
title: ClusterMemberStatePost represents the fields required to evacuate a cluster member.
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ClusterMemberSysInfo:
properties:
buffered_ram:
format: uint64
type: integer
x-go-name: BufferRAM
free_ram:
format: uint64
type: integer
x-go-name: FreeRAM
free_swap:
format: uint64
type: integer
x-go-name: FreeSwap
load_averages:
items:
format: double
type: number
type: array
x-go-name: LoadAverages
processes:
format: uint16
type: integer
x-go-name: Processes
shared_ram:
format: uint64
type: integer
x-go-name: SharedRAM
total_ram:
format: uint64
type: integer
x-go-name: TotalRAM
total_swap:
format: uint64
type: integer
x-go-name: TotalSwap
uptime:
format: int64
type: integer
x-go-name: Uptime
title: ClusterMemberSysInfo represents the sysinfo of a cluster member.
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ClusterMembersPost:
properties:
server_name:
description: The name of the new cluster member
example: server02
type: string
x-go-name: ServerName
title: ClusterMembersPost represents the fields required to request a join token to add a member to the cluster.
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ClusterPut:
properties:
cluster_address:
description: The address of the cluster you wish to join
example: 10.0.0.1:8443
type: string
x-go-name: ClusterAddress
cluster_certificate:
description: The expected certificate (X509 PEM encoded) for the cluster
example: X509 PEM certificate
type: string
x-go-name: ClusterCertificate
cluster_token:
description: The cluster join token for the cluster you're trying to join
example: blah
type: string
x-go-name: ClusterToken
enabled:
description: Whether clustering is enabled
example: true
type: boolean
x-go-name: Enabled
member_config:
description: List of member configuration keys (used during join)
example: []
items:
$ref: '#/definitions/ClusterMemberConfigKey'
type: array
x-go-name: MemberConfig
server_address:
description: The local address to use for cluster communication
example: 10.0.0.2:8443
type: string
x-go-name: ServerAddress
server_name:
description: Name of the cluster member answering the request
example: server01
type: string
x-go-name: ServerName
title: ClusterPut represents the fields required to bootstrap or join a cluster.
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
Event:
description: Event represents an event entry (over websocket)
properties:
location:
description: Originating cluster member
example: server01
type: string
x-go-name: Location
metadata:
description: JSON encoded metadata (see EventLogging, EventLifecycle or Operation)
example:
action: instance-started
context: {}
source: /1.0/instances/c1
type: object
x-go-name: Metadata
project:
description: Project the event belongs to.
example: default
type: string
x-go-name: Project
timestamp:
description: Time at which the event was sent
example: "2021-02-24T19:00:45.452649098-05:00"
format: date-time
type: string
x-go-name: Timestamp
type:
description: Event type (one of operation, logging or lifecycle)
example: lifecycle
type: string
x-go-name: Type
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
Image:
description: Image represents an image
properties:
aliases:
description: List of aliases
items:
$ref: '#/definitions/ImageAlias'
type: array
x-go-name: Aliases
architecture:
description: Architecture
example: x86_64
type: string
x-go-name: Architecture
auto_update:
description: Whether the image should auto-update when a new build is available
example: true
type: boolean
x-go-name: AutoUpdate
cached:
description: Whether the image is an automatically cached remote image
example: true
type: boolean
x-go-name: Cached
created_at:
description: When the image was originally created
example: "2021-03-23T20:00:00-04:00"
format: date-time
type: string
x-go-name: CreatedAt
expires_at:
description: When the image becomes obsolete
example: "2025-03-23T20:00:00-04:00"
format: date-time
type: string
x-go-name: ExpiresAt
filename:
description: Original filename
example: 06b86454720d36b20f94e31c6812e05ec51c1b568cf3a8abd273769d213394bb.rootfs
type: string
x-go-name: Filename
fingerprint:
description: Full SHA-256 fingerprint
example: 06b86454720d36b20f94e31c6812e05ec51c1b568cf3a8abd273769d213394bb
type: string
x-go-name: Fingerprint
last_used_at:
description: Last time the image was used
example: "2021-03-22T20:39:00.575185384-04:00"
format: date-time
type: string
x-go-name: LastUsedAt
profiles:
description: List of profiles to use when creating from this image (if none provided by user)
example:
- default
items:
type: string
type: array
x-go-name: Profiles
project:
description: Project name
example: project1
type: string
x-go-name: Project
properties:
additionalProperties:
type: string
description: Descriptive properties
example:
os: Ubuntu
release: jammy
variant: cloud
type: object
x-go-name: Properties
public:
description: Whether the image is available to unauthenticated users
example: false
type: boolean
x-go-name: Public
size:
description: Size of the image in bytes
example: 272237676
format: int64
type: integer
x-go-name: Size
type:
description: Type of image (container or virtual-machine)
example: container
type: string
x-go-name: Type
update_source:
$ref: '#/definitions/ImageSource'
uploaded_at:
description: When the image was added to this server
example: "2021-03-24T14:18:15.115036787-04:00"
format: date-time
type: string
x-go-name: UploadedAt
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ImageAlias:
description: ImageAlias represents an alias from the alias list of an image
properties:
description:
description: Description of the alias
example: Our preferred Ubuntu image
type: string
x-go-name: Description
name:
description: Name of the alias
example: ubuntu-22.04
type: string
x-go-name: Name
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ImageAliasesEntry:
description: ImageAliasesEntry represents an image alias
properties:
description:
description: Alias description
example: Our preferred Ubuntu image
type: string
x-go-name: Description
name:
description: Alias name
example: ubuntu-22.04
type: string
x-go-name: Name
target:
description: Target fingerprint for the alias
example: 06b86454720d36b20f94e31c6812e05ec51c1b568cf3a8abd273769d213394bb
type: string
x-go-name: Target
type:
description: Alias type (container or virtual-machine)
example: container
type: string
x-go-name: Type
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ImageAliasesEntryPost:
description: ImageAliasesEntryPost represents the required fields to rename an image alias
properties:
name:
description: Alias name
example: ubuntu-22.04
type: string
x-go-name: Name
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ImageAliasesEntryPut:
description: ImageAliasesEntryPut represents the modifiable fields of an image alias
properties:
description:
description: Alias description
example: Our preferred Ubuntu image
type: string
x-go-name: Description
target:
description: Target fingerprint for the alias
example: 06b86454720d36b20f94e31c6812e05ec51c1b568cf3a8abd273769d213394bb
type: string
x-go-name: Target
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ImageAliasesPost:
description: ImageAliasesPost represents a new image alias
properties:
description:
description: Alias description
example: Our preferred Ubuntu image
type: string
x-go-name: Description
name:
description: Alias name
example: ubuntu-22.04
type: string
x-go-name: Name
target:
description: Target fingerprint for the alias
example: 06b86454720d36b20f94e31c6812e05ec51c1b568cf3a8abd273769d213394bb
type: string
x-go-name: Target
type:
description: Alias type (container or virtual-machine)
example: container
type: string
x-go-name: Type
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ImageExportPost:
description: ImageExportPost represents the fields required to export an image
properties:
aliases:
description: List of aliases to set on the image
items:
$ref: '#/definitions/ImageAlias'
type: array
x-go-name: Aliases
certificate:
description: Remote server certificate
example: X509 PEM certificate
type: string
x-go-name: Certificate
profiles:
description: List of profiles to use
example:
- default
items:
type: string
type: array
x-go-name: Profiles
project:
description: Project name
example: project1
type: string
x-go-name: Project
secret:
description: Image receive secret
example: RANDOM-STRING
type: string
x-go-name: Secret
target:
description: Target server URL
example: https://1.2.3.4:8443
type: string
x-go-name: Target
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ImageMetadata:
description: ImageMetadata represents image metadata (used in image tarball)
properties:
architecture:
description: Architecture name
example: x86_64
type: string
x-go-name: Architecture
creation_date:
description: Image creation data (as UNIX epoch)
example: 1620655439
format: int64
type: integer
x-go-name: CreationDate
expiry_date:
description: Image expiry data (as UNIX epoch)
example: 1620685757
format: int64
type: integer
x-go-name: ExpiryDate
properties:
additionalProperties:
type: string
description: Descriptive properties
example:
os: Ubuntu
release: jammy
variant: cloud
type: object
x-go-name: Properties
templates:
additionalProperties:
$ref: '#/definitions/ImageMetadataTemplate'
description: Template for files in the image
type: object
x-go-name: Templates
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ImageMetadataTemplate:
description: ImageMetadataTemplate represents a template entry in image metadata (used in image tarball)
properties:
create_only:
description: Whether to trigger only if the file is missing
example: false
type: boolean
x-go-name: CreateOnly
gid:
description: The file owner gid.
example: "1000"
type: string
x-go-name: GID
mode:
description: The file permissions.
example: "644"
type: string
x-go-name: Mode
properties:
additionalProperties:
type: string
description: Key/value properties to pass to the template
example:
foo: bar
type: object
x-go-name: Properties
template:
description: The template itself as a valid pongo2 template
example: pongo2-template
type: string
x-go-name: Template
uid:
description: The file owner uid.
example: "1000"
type: string
x-go-name: UID
when:
description: When to trigger the template (create, copy or start)
example: create
items:
type: string
type: array
x-go-name: When
type: object
x-go-package: github.com/lxc/incus/v6/shared/api
ImagePut:
description: ImagePut represents the modifiable fields of an image
properties:
auto_update:
description: Whether the image should auto-update when a new build is available
example: true