-
Notifications
You must be signed in to change notification settings - Fork 64
/
DigitalOcean-public.v2.yaml
1609 lines (1242 loc) · 56.9 KB
/
DigitalOcean-public.v2.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
openapi: '3.0.0'
info:
title: DigitalOcean API
version: '2.0'
description:
$ref: 'description.yml#/introduction'
license:
name: Apache 2.0
url: 'https://www.apache.org/licenses/LICENSE-2.0.html'
contact:
name: DigitalOcean API Team
email: api-engineering@digitalocean.com
termsOfService: 'https://www.digitalocean.com/legal/terms-of-service-agreement/'
servers:
- url: 'https://api.digitalocean.com'
description: production
tags:
- name: 1-Click Applications
description: |-
1-Click applications are pre-built Droplet images or Kubernetes apps with software,
features, and configuration details already set up for you. They can be found in the
[DigitalOcean Marketplace](https://www.digitalocean.com/docs/marketplace).
- name: Account
description: Provides information about your current account.
- name: Actions
description: |-
Actions are records of events that have occurred on the resources in your account.
These can be things like rebooting a Droplet, or transferring an image to a new region.
An action object is created every time one of these actions is initiated. The action
object contains information about the current status of the action, start and complete
timestamps, and the associated resource type and ID.
Every action that creates an action object is available through this endpoint. Completed
actions are not removed from this list and are always available for querying.
**Note:** You can pass the following HTTP header with the request to have the API return
the `reserved_ips` stanza instead of the `floating_ips` stanza:
- `Accept: application/vnd.digitalocean.reserveip+json`
- name: Apps
description: |-
App Platform is a Platform-as-a-Service (PaaS) offering from DigitalOcean that allows
developers to publish code directly to DigitalOcean servers without worrying about the
underlying infrastructure.
Most API operations are centered around a few core object types. Following are the
definitions of these types. These definitions will be omitted from the operation-specific
documentation.
For documentation on app specifications (`AppSpec` objects), please refer to the
[product documentation](https://docs.digitalocean.com/products/app-platform/reference/app-spec/)).
- name: Billing
description: |-
The billing endpoints allow you to retrieve your account balance, invoices
and billing history.
**Balance:** By sending requests to the `/v2/customers/my/balance` endpoint, you can
retrieve the balance information for the requested customer account.
**Invoices:** [Invoices](https://www.digitalocean.com/docs/accounts/billing/invoices/)
are generated on the first of each month for every DigitalOcean
customer. An invoice preview is generated daily, which can be accessed
with the `preview` keyword in place of `$INVOICE_UUID`. To interact with
invoices, you will generally send requests to the invoices endpoint at
`/v2/customers/my/invoices`.
**Billing History:** Billing history is a record of billing events for your account.
For example, entries may include events like payments made, invoices
issued, or credits granted. To interact with invoices, you
will generally send requests to the invoices endpoint at
`/v2/customers/my/billing_history`.
- name: Block Storage
description: |-
[DigitalOcean Block Storage Volumes](https://www.digitalocean.com/docs/volumes/)
provide expanded storage capacity for your Droplets and can be moved
between Droplets within a specific region.
Volumes function as raw block devices, meaning they appear to the
operating system as locally attached storage which can be formatted using
any file system supported by the OS. They may be created in sizes from
1GiB to 16TiB.
By sending requests to the `/v2/volumes` endpoint, you can list, create, or
delete volumes as well as attach and detach them from Droplets
- name: Block Storage Actions
description: |-
Block storage actions are commands that can be given to a DigitalOcean
Block Storage Volume. An example would be detaching or attaching a volume
from a Droplet. These requests are made on the
`/v2/volumes/$VOLUME_ID/actions` endpoint.
An action object is returned. These objects hold the current status of the
requested action.
- name: CDN Endpoints
description: |-
Content hosted in DigitalOcean's object storage solution,
[Spaces](https://www.digitalocean.com/docs/spaces/overview/),
can optionally be served by our globally distributed Content Delivery
Network (CDN). By sending requests to `/v2/cdn/endpoints`, you can list,
create, or delete CDN Endpoints as well as purge cached content. To use a
custom subdomain to access the CDN Endpoint, provide the ID of a
DigitalOcean managed TLS certificate and the fully qualified domain name
for the custom subdomain.
- name: Certificates
description: |-
In order to perform SSL termination on load balancers, DigitalOcean offers
two types of [SSL certificate management](https://www.digitalocean.com/docs/accounts/security/#certificates):
* **Custom**: User-generated certificates may be uploaded to DigitalOcean
where they will be placed in a fully encrypted and isolated storage system.
* **Let's Encrypt**: Certificates may be automatically generated by
DigitalOcean utilizing an integration with Let's Encrypt, the free and
open certificate authority. These certificates will also be automatically
renewed as required.
- name: Container Registry
description: |-
DigitalOcean offers the ability for you to create a
[private container registry](https://www.digitalocean.com/docs/images/container-registry/quickstart/)
to store your Docker images for use with your Kubernetes clusters. This
container registry runs inside the same datacenters as your cluster,
ensuring reliable and performant rollout of image deployments.
You can only create one registry per DigitalOcean account, but you can use
that registry to create as many repositories as you wish.
- name: Databases
description: |-
DigitalOcean's [managed database service](https://www.digitalocean.com/docs/databases)
simplifies the creation and management of highly available database clusters. Currently, it
offers support for [PostgreSQL](http://www.digitalocean.com/docs/databases/postgresql/),
[Redis](https://www.digitalocean.com/docs/databases/redis/),
[MySQL](https://www.digitalocean.com/docs/databases/mysql/), and
[MongoDB](https://www.digitalocean.com/docs/databases/mongodb/).
By sending requests to the `/v2/databases` endpoint, you can list, create, or delete
database clusters as well as scale the size of a cluster, add or remove read-only replicas,
and manage other configuration details.
Database clusters may be deployed in a multi-node, high-availability configuration.
If your machine type is above the basic nodes, your node plan is above the smallest option,
or you are running MongoDB, you may additionally include up to two standby nodes in your cluster.
The size of individual nodes in a database cluster is represented by a human-readable slug,
which is used in some of the following requests. Each slug denotes the node's identifier,
CPU count, and amount of RAM, in that order.
For a list of currently available database slugs and options, use the `/v2/databases/options` endpoint or use the
`doctl databases options` [command](https://docs.digitalocean.com/reference/doctl/reference/databases/options).
- name: Domain Records
description: |-
Domain record resources are used to set or retrieve information about the
individual DNS records configured for a domain. This allows you to build
and manage DNS zone files by adding and modifying individual records for a
domain.
The [DigitalOcean DNS management interface](https://www.digitalocean.com/docs/networking/dns/)
allows you to configure the following DNS records:
Name | Description |
------|----------------------------------------------------------------------------------------------------------------------------------------------------|
A | This record type is used to map an IPv4 address to a hostname. |
AAAA | This record type is used to map an IPv6 address to a hostname. |
CAA | As specified in RFC-6844, this record type can be used to restrict which certificate authorities are permitted to issue certificates for a domain. |
CNAME | This record type defines an alias for your canonical hostname (the one defined by an A or AAAA record). |
MX | This record type is used to define the mail exchanges used for the domain. |
NS | This record type defines the name servers that are used for this zone. |
TXT | This record type is used to associate a string of text with a hostname, primarily used for verification. |
SRV | This record type specifies the location (hostname and port number) of servers for specific services. |
SOA | This record type defines administrative information about the zone. Can only have ttl changed, cannot be deleted |
- name: Domains
description: |-
Domain resources are domain names that you have purchased from a domain
name registrar that you are managing through the
[DigitalOcean DNS interface](https://www.digitalocean.com/docs/networking/dns/).
This resource establishes top-level control over each domain. Actions that
affect individual domain records should be taken on the
[Domain Records](#tag/Domain-Records) resource.
- name: Droplet Actions
description: |-
Droplet actions are tasks that can be executed on a Droplet. These can be
things like rebooting, resizing, snapshotting, etc.
Droplet action requests are generally targeted at one of the "actions"
endpoints for a specific Droplet. The specific actions are usually
initiated by sending a POST request with the action and arguments as
parameters.
Droplet action requests create a Droplet actions object, which can be used
to get information about the status of an action. Creating a Droplet
action is asynchronous: the HTTP call will return the action object before
the action has finished processing on the Droplet. The current status of
an action can be retrieved from either the Droplet actions endpoint or the
global actions endpoint. If a Droplet action is uncompleted it may block
the creation of a subsequent action for that Droplet, the locked attribute
of the Droplet will be true and attempts to create a Droplet action will
fail with a status of 422.
- name: Droplets
description: |-
A [Droplet](https://www.digitalocean.com/docs/droplets/) is a DigitalOcean
virtual machine. By sending requests to the Droplet endpoint, you can
list, create, or delete Droplets.
Some of the attributes will have an object value. The `region` and `image`
objects will all contain the standard attributes of their associated
types. Find more information about each of these objects in their
respective sections.
- name: Firewalls
description: |-
[DigitalOcean Cloud Firewalls](https://www.digitalocean.com/docs/networking/firewalls/)
provide the ability to restrict network access to and from a Droplet
allowing you to define which ports will accept inbound or outbound
connections. By sending requests to the `/v2/firewalls` endpoint, you can
list, create, or delete firewalls as well as modify access rules.
- name: Floating IP Actions
description: |-
As of 16 June 2022, we have renamed the Floating IP product to [Reserved IPs](https://docs.digitalocean.com/reference/api/api-reference/#tag/Reserved-IPs).
The Reserved IP product's endpoints function the exact same way as Floating IPs.
The only difference is the name change throughout the URLs and fields.
For example, the `floating_ips` field is now the `reserved_ips` field.
The Floating IP endpoints will remain active until fall 2023 before being
permanently deprecated.
With the exception of the [Projects API](https://docs.digitalocean.com/reference/api/api-reference/#tag/Projects),
we will reflect this change as an additional field in the responses across the API
where the `floating_ip` field is used. For example, the Droplet metadata response
will contain the field `reserved_ips` in addition to the `floating_ips` field.
Floating IPs retrieved using the Projects API will retain the original name.
Floating IP actions are commands that can be given to a DigitalOcean
floating IP. These requests are made on the actions endpoint of a specific
floating IP.
An action object is returned. These objects hold the current status of the
requested action.
- name: Floating IPs
description: |-
As of 16 June 2022, we have renamed the Floating IP product to [Reserved IPs](https://docs.digitalocean.com/reference/api/api-reference/#tag/Reserved-IPs).
The Reserved IP product's endpoints function the exact same way as Floating IPs.
The only difference is the name change throughout the URLs and fields.
For example, the `floating_ips` field is now the `reserved_ips` field.
The Floating IP endpoints will remain active until fall 2023 before being
permanently deprecated.
With the exception of the [Projects API](https://docs.digitalocean.com/reference/api/api-reference/#tag/Projects),
we will reflect this change as an additional field in the responses across the API
where the `floating_ip` field is used. For example, the Droplet metadata response
will contain the field `reserved_ips` in addition to the `floating_ips` field.
Floating IPs retrieved using the Projects API will retain the original name.
[DigitalOcean Floating IPs](https://www.digitalocean.com/docs/networking/floating-ips/)
are publicly-accessible static IP addresses that can be mapped to one of
your Droplets. They can be used to create highly available setups or other
configurations requiring movable addresses.
Floating IPs are bound to a specific region.
- name: Functions
description: |-
[Serverless functions](https://docs.digitalocean.com/products/functions) are blocks of code that run on demand without the need to manage any infrastructure.
You can develop functions on your local machine and then deploy them to a namespace using `doctl`, the [official DigitalOcean CLI tool](https://docs.digitalocean.com/reference/doctl).
The Serverless Functions API currently only supports creating and managing namespaces.
- name: Image Actions
description: |-
Image actions are commands that can be given to a DigitalOcean image. In
general, these requests are made on the actions endpoint of a specific
image.
An image action object is returned. These objects hold the current status
of the requested action.
- name: Images
description: |-
A DigitalOcean [image](https://www.digitalocean.com/docs/images/) can be
used to create a Droplet and may come in a number of flavors. Currently,
there are five types of images: snapshots, backups, applications,
distributions, and custom images.
* [Snapshots](https://www.digitalocean.com/docs/images/snapshots/) provide
a full copy of an existing Droplet instance taken on demand.
* [Backups](https://www.digitalocean.com/docs/images/backups/) are similar
to snapshots but are created automatically at regular intervals when
enabled for a Droplet.
* [Custom images](https://www.digitalocean.com/docs/images/custom-images/)
are Linux-based virtual machine images (raw, qcow2, vhdx, vdi, and vmdk
formats are supported) that you may upload for use on DigitalOcean.
* Distributions are the public Linux distributions that are available to
be used as a base to create Droplets.
* Applications, or [1-Click Apps](https://www.digitalocean.com/docs/one-clicks/),
are distributions pre-configured with additional software.
To interact with images, you will generally send requests to the images
endpoint at /v2/images.
- name: Kubernetes
description: |-
[DigitalOcean Kubernetes](https://www.digitalocean.com/docs/kubernetes/)
allows you to quickly deploy scalable and secure Kubernetes clusters. By
sending requests to the `/v2/kubernetes/clusters` endpoint, you can list,
create, or delete clusters as well as scale node pools up and down,
recycle individual nodes, and retrieve the kubeconfig file for use with
a cluster.
- name: Load Balancers
description: |-
[DigitalOcean Load Balancers](https://www.digitalocean.com/docs/networking/load-balancers/)
provide a way to distribute traffic across multiple Droplets. By sending
requests to the `/v2/load_balancers` endpoint, you can list, create, or
delete load balancers as well as add or remove Droplets, forwarding rules,
and other configuration details.
- name: Monitoring
description: |-
The DigitalOcean Monitoring API makes it possible to programmatically retrieve metrics as well as configure alert
policies based on these metrics. The Monitoring API can help you gain insight into how your apps are performing
and consuming resources.
- name: Project Resources
description: |-
Project Resources are resources that can be grouped into your projects.
You can group resources (like Droplets, Spaces, load balancers, domains,
and floating IPs) in ways that align with the applications you host on
DigitalOcean.
### Supported Resource Types Examples
Projects resources are identified by uniform resource names or URNs. A
valid URN has the following format: `do:resource_type:resource_id`. The
following resource types are supported:
Resource Type | Example URN
-------------------|------------
App Platform App | `do:app:be5aab85-851b-4cab-b2ed-98d5a63ba4e8`
Database | `do:dbaas:83c7a55f-0d84-4760-9245-aba076ec2fb2`
Domain | `do:domain:example.com`
Droplet | `do:droplet:4126873`
Floating IP | `do:floatingip:192.168.99.100`
Kubernetes Cluster | `do:kubernetes:bd5f5959-5e1e-4205-a714-a914373942af`
Load Balancer | `do:loadbalancer:39052d89-8dd4-4d49-8d5a-3c3b6b365b5b`
Space | `do:space:my-website-assets`
Volume | `do:volume:6fc4c277-ea5c-448a-93cd-dd496cfef71f`
### Resource Status Codes
When assigning and retrieving resources in projects, a `status` attribute
is returned that indicates if a resource was successfully retrieved or
assigned. The status codes can be one of the following:
Status Code | Explanation
-------------------|------------
`ok` | There was no problem retrieving or assigning a resource.
`not_found` | The resource was not found.
`assigned` | The resource was successfully assigned.
`already_assigned` | The resource was already assigned.
`service_down` | There was a problem retrieving or assigning a resource. Please try again.
- name: Projects
description: |-
Projects allow you to organize your resources into groups that fit the way
you work. You can group resources (like Droplets, Spaces, load balancers,
domains, and floating IPs) in ways that align with the applications
you host on DigitalOcean.
- name: Regions
description: Provides information about DigitalOcean data center regions.
- name: Reserved IP Actions
description: |-
As of 16 June 2022, we have renamed the [Floating IP](https://docs.digitalocean.com/reference/api/api-reference/#tag/Floating-IPs)
product to Reserved IPs. The Reserved IP product's endpoints function the exact
same way as Floating IPs. The only difference is the name change throughout the
URLs and fields. For example, the `floating_ips` field is now the `reserved_ips` field.
The Floating IP endpoints will remain active until fall 2023 before being
permanently deprecated.
With the exception of the [Projects API](https://docs.digitalocean.com/reference/api/api-reference/#tag/Projects),
we will reflect this change as an additional field in the responses across the API
where the `floating_ip` field is used. For example, the Droplet metadata response
will contain the field `reserved_ips` in addition to the `floating_ips` field.
Floating IPs retrieved using the Projects API will retain the original name.
Reserved IP actions are commands that can be given to a DigitalOcean
reserved IP. These requests are made on the actions endpoint of a specific
reserved IP.
An action object is returned. These objects hold the current status of the
requested action.
- name: Reserved IPs
description: |-
As of 16 June 2022, we have renamed the [Floating IP](https://docs.digitalocean.com/reference/api/api-reference/#tag/Floating-IPs)
product to Reserved IPs. The Reserved IP product's endpoints function the exact
same way as Floating IPs. The only difference is the name change throughout the
URLs and fields. For example, the `floating_ips` field is now the `reserved_ips` field.
The Floating IP endpoints will remain active until fall 2023 before being
permanently deprecated.
With the exception of the [Projects API](https://docs.digitalocean.com/reference/api/api-reference/#tag/Projects),
we will reflect this change as an additional field in the responses across the API
where the `floating_ip` field is used. For example, the Droplet metadata response
will contain the field `reserved_ips` in addition to the `floating_ips` field.
Floating IPs retrieved using the Projects API will retain the original name.
DigitalOcean Reserved IPs are publicly-accessible static IP addresses that can be
mapped to one of your Droplets. They can be used to create highly available
setups or other configurations requiring movable addresses.
Reserved IPs are bound to a specific region.
- name: Sizes
description: |-
The sizes objects represent different packages of hardware resources that
can be used for Droplets. When a Droplet is created, a size must be
selected so that the correct resources can be allocated.
Each size represents a plan that bundles together specific sets of
resources. This includes the amount of RAM, the number of virtual CPUs,
disk space, and transfer. The size object also includes the pricing
details and the regions that the size is available in.
- name: Snapshots
description: |-
[Snapshots](https://www.digitalocean.com/docs/images/snapshots/) are saved
instances of a Droplet or a block storage volume, which is reflected in
the `resource_type` attribute. In order to avoid problems with compressing
filesystems, each defines a `min_disk_size` attribute which is the minimum
size of the Droplet or volume disk when creating a new resource from the
saved snapshot.
To interact with snapshots, you will generally send requests to the
snapshots endpoint at `/v2/snapshots`.
- name: SSH Keys
description: Manage SSH keys available on your account.
- name: Tags
description: |-
A tag is a label that can be applied to a resource (currently Droplets,
Images, Volumes, Volume Snapshots, and Database clusters) in order to
better organize or facilitate the lookups and actions on it.
Tags have two attributes: a user defined `name` attribute and an embedded
`resources` attribute with information about resources that have been tagged.
- name: Uptime
description: >-
[DigitalOcean Uptime Checks](https://docs.digitalocean.com/products/uptime/) provide the ability to monitor your endpoints from around the world, and alert you when they're slow, unavailable, or SSL certificates are expiring.
To interact with Uptime, you will generally send requests to the Uptime endpoint at `/v2/uptime/`.
- name: VPCs
description: |-
[VPCs (virtual private clouds)](https://www.digitalocean.com/docs/networking/vpc/)
allow you to create virtual networks containing resources that can
communicate with each other in full isolation using private IP addresses.
By sending requests to the `/v2/vpcs` endpoint, you can create, configure,
list, and delete custom VPCs as well as retrieve information about the
resources assigned to them.
paths:
/v2/1-clicks:
get:
$ref: 'resources/1-clicks/oneClicks_list.yml'
/v2/1-clicks/kubernetes:
post:
$ref: 'resources/1-clicks/oneClicks_install_kubernetes.yml'
/v2/account:
get:
$ref: 'resources/account/account_get.yml'
/v2/account/keys:
get:
$ref: 'resources/ssh_keys/sshKeys_list.yml'
post:
$ref: 'resources/ssh_keys/sshKeys_create.yml'
/v2/account/keys/{ssh_key_identifier}:
get:
$ref: 'resources/ssh_keys/sshKeys_get.yml'
put:
$ref: 'resources/ssh_keys/sshKeys_update.yml'
delete:
$ref: 'resources/ssh_keys/sshKeys_delete.yml'
/v2/actions:
get:
$ref: 'resources/actions/actions_list.yml'
/v2/actions/{action_id}:
get:
$ref: 'resources/actions/actions_get.yml'
/v2/apps:
get:
$ref: 'resources/apps/apps_list.yml'
post:
$ref: 'resources/apps/apps_create.yml'
/v2/apps/{id}:
delete:
$ref: 'resources/apps/apps_delete.yml'
get:
$ref: 'resources/apps/apps_get.yml'
put:
$ref: 'resources/apps/apps_update.yml'
/v2/apps/{app_id}/components/{component_name}/logs:
get:
$ref: 'resources/apps/apps_get_logs_active_deployment.yml'
/v2/apps/{app_id}/deployments:
get:
$ref: 'resources/apps/apps_list_deployments.yml'
post:
$ref: 'resources/apps/apps_create_deployment.yml'
/v2/apps/{app_id}/deployments/{deployment_id}:
get:
$ref: 'resources/apps/apps_get_deployment.yml'
/v2/apps/{app_id}/deployments/{deployment_id}/cancel:
post:
$ref: 'resources/apps/apps_cancel_deployment.yml'
/v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/logs:
get:
$ref: 'resources/apps/apps_get_logs.yml'
/v2/apps/{app_id}/deployments/{deployment_id}/logs:
get:
$ref: 'resources/apps/apps_get_logs_aggregate.yml'
/v2/apps/{app_id}/logs:
get:
$ref: 'resources/apps/apps_get_logs_active_deployment_aggregate.yml'
/v2/apps/tiers:
get:
$ref: 'resources/apps/apps_list_tiers.yml'
/v2/apps/tiers/{slug}:
get:
$ref: 'resources/apps/apps_get_tier.yml'
/v2/apps/tiers/instance_sizes:
get:
$ref: 'resources/apps/apps_list_instanceSizes.yml'
/v2/apps/tiers/instance_sizes/{slug}:
get:
$ref: 'resources/apps/apps_get_instanceSize.yml'
/v2/apps/regions:
get:
$ref: 'resources/apps/apps_list_regions.yml'
/v2/apps/propose:
post:
$ref: 'resources/apps/apps_validate_appSpec.yml'
/v2/apps/{app_id}/alerts:
get:
$ref: 'resources/apps/apps_list_alerts.yml'
/v2/apps/{app_id}/alerts/{alert_id}/destinations:
post:
$ref: 'resources/apps/apps_assign_alertDestinations.yml'
/v2/apps/{app_id}/rollback:
post:
$ref: 'resources/apps/apps_create_rollback.yml'
/v2/apps/{app_id}/rollback/validate:
post:
$ref: 'resources/apps/apps_validate_rollback.yml'
/v2/apps/{app_id}/rollback/commit:
post:
$ref: 'resources/apps/apps_commit_rollback.yml'
/v2/apps/{app_id}/rollback/revert:
post:
$ref: 'resources/apps/apps_revert_rollback.yml'
/v2/apps/{app_id}/metrics/bandwidth_daily:
get:
$ref: 'resources/apps/apps_get_metrics_bandwidth_usage.yml'
/v2/apps/metrics/bandwidth_daily:
post:
$ref: 'resources/apps/apps_list_metrics_bandwidth_usage.yml'
/v2/cdn/endpoints:
get:
$ref: 'resources/cdn/cdn_list_endpoints.yml'
post:
$ref: 'resources/cdn/cdn_create_endpoint.yml'
/v2/cdn/endpoints/{cdn_id}:
get:
$ref: 'resources/cdn/cdn_get_endpoint.yml'
put:
$ref: 'resources/cdn/cdn_update_endpoint.yml'
delete:
$ref: 'resources/cdn/cdn_delete_endpoint.yml'
/v2/cdn/endpoints/{cdn_id}/cache:
delete:
$ref: 'resources/cdn/cdn_purge_cache.yml'
/v2/certificates:
get:
$ref: 'resources/certificates/certificates_list.yml'
post:
$ref: 'resources/certificates/certificates_create.yml'
/v2/certificates/{certificate_id}:
get:
$ref: 'resources/certificates/certificates_get.yml'
delete:
$ref: 'resources/certificates/certificates_delete.yml'
/v2/customers/my/balance:
get:
$ref: 'resources/billing/balance_get.yml'
/v2/customers/my/billing_history:
get:
$ref: 'resources/billing/billingHistory_list.yml'
/v2/customers/my/invoices:
get:
$ref: 'resources/billing/invoices_list.yml'
/v2/customers/my/invoices/{invoice_uuid}:
get:
$ref: 'resources/billing/invoices_get_byUUID.yml'
/v2/customers/my/invoices/{invoice_uuid}/csv:
get:
$ref: 'resources/billing/invoices_get_csvByUUID.yml'
/v2/customers/my/invoices/{invoice_uuid}/pdf:
get:
$ref: 'resources/billing/invoices_get_pdfByUUID.yml'
/v2/customers/my/invoices/{invoice_uuid}/summary:
get:
$ref: 'resources/billing/invoices_get_summaryByUUID.yml'
/v2/databases/options:
get:
$ref: 'resources/databases/databases_list_options.yml'
/v2/databases:
get:
$ref: 'resources/databases/databases_list_clusters.yml'
post:
$ref: 'resources/databases/databases_create_cluster.yml'
/v2/databases/{database_cluster_uuid}:
get:
$ref: 'resources/databases/databases_get_cluster.yml'
delete:
$ref: 'resources/databases/databases_destroy_cluster.yml'
/v2/databases/{database_cluster_uuid}/config:
get:
$ref: 'resources/databases/databases_get_config.yml'
patch:
$ref: 'resources/databases/databases_patch_config.yml'
/v2/databases/{database_cluster_uuid}/ca:
get:
$ref: 'resources/databases/databases_get_ca.yml'
/v2/databases/{database_cluster_uuid}/online-migration:
get:
$ref: 'resources/databases/databases_get_migrationStatus.yml'
put:
$ref: 'resources/databases/databases_update_onlineMigration.yml'
/v2/databases/{database_cluster_uuid}/online-migration/{migration_id}:
delete:
$ref: 'resources/databases/databases_delete_onlineMigration.yml'
/v2/databases/{database_cluster_uuid}/migrate:
put:
$ref: 'resources/databases/databases_update_region.yml'
/v2/databases/{database_cluster_uuid}/resize:
put:
$ref: 'resources/databases/databases_update_clusterSize.yml'
/v2/databases/{database_cluster_uuid}/firewall:
get:
$ref: 'resources/databases/databases_list_firewall_rules.yml'
put:
$ref: 'resources/databases/databases_update_firewall_rules.yml'
/v2/databases/{database_cluster_uuid}/maintenance:
put:
$ref: 'resources/databases/databases_update_maintenanceWindow.yml'
/v2/databases/{database_cluster_uuid}/backups:
get:
$ref: 'resources/databases/databases_list_backups.yml'
/v2/databases/{database_cluster_uuid}/replicas:
get:
$ref: 'resources/databases/databases_list_replicas.yml'
post:
$ref: 'resources/databases/databases_create_replica.yml'
/v2/databases/{database_cluster_uuid}/events:
get:
$ref: 'resources/databases/databases_events_logs.yml'
/v2/databases/{database_cluster_uuid}/replicas/{replica_name}:
get:
$ref: 'resources/databases/databases_get_replica.yml'
delete:
$ref: 'resources/databases/databases_destroy_replica.yml'
/v2/databases/{database_cluster_uuid}/replicas/{replica_name}/promote:
put:
$ref: 'resources/databases/databases_promote_replica.yml'
/v2/databases/{database_cluster_uuid}/users:
get:
$ref: 'resources/databases/databases_list_users.yml'
post:
$ref: 'resources/databases/databases_add_user.yml'
/v2/databases/{database_cluster_uuid}/users/{username}:
get:
$ref: 'resources/databases/databases_get_user.yml'
delete:
$ref: 'resources/databases/databases_delete_user.yml'
put:
$ref: 'resources/databases/databases_update_user.yml'
/v2/databases/{database_cluster_uuid}/users/{username}/reset_auth:
post:
$ref: 'resources/databases/databases_reset_auth.yml'
/v2/databases/{database_cluster_uuid}/dbs:
get:
$ref: 'resources/databases/databases_list.yml'
post:
$ref: 'resources/databases/databases_add.yml'
/v2/databases/{database_cluster_uuid}/dbs/{database_name}:
get:
$ref: 'resources/databases/databases_get.yml'
delete:
$ref: 'resources/databases/databases_delete.yml'
/v2/databases/{database_cluster_uuid}/pools:
get:
$ref: 'resources/databases/databases_list_connectionPools.yml'
post:
$ref: 'resources/databases/databases_add_connectionPool.yml'
/v2/databases/{database_cluster_uuid}/pools/{pool_name}:
get:
$ref: 'resources/databases/databases_get_connectionPool.yml'
put:
$ref: 'resources/databases/databases_update_connectionPool.yml'
delete:
$ref: 'resources/databases/databases_delete_connectionPool.yml'
/v2/databases/{database_cluster_uuid}/eviction_policy:
get:
$ref: 'resources/databases/databases_get_evictionPolicy.yml'
put:
$ref: 'resources/databases/databases_update_evictionPolicy.yml'
/v2/databases/{database_cluster_uuid}/sql_mode:
get:
$ref: 'resources/databases/databases_get_sql_mode.yml'
put:
$ref: 'resources/databases/databases_update_sql_mode.yml'
/v2/databases/{database_cluster_uuid}/upgrade:
put:
$ref: 'resources/databases/databases_upgrade_major_version.yml'
/v2/databases/{database_cluster_uuid}/topics:
get:
$ref: 'resources/databases/databases_list_kafka_topics.yml'
post:
$ref: 'resources/databases/databases_create_kafka_topic.yml'
/v2/databases/{database_cluster_uuid}/topics/{topic_name}:
get:
$ref: 'resources/databases/databases_get_kafka_topic.yml'
put:
$ref: 'resources/databases/databases_update_kafka_topic.yml'
delete:
$ref: 'resources/databases/databases_delete_kafka_topic.yml'
/v2/databases/metrics/credentials:
get:
$ref: 'resources/databases/databases_get_cluster_metrics_credentials.yml'
put:
$ref: 'resources/databases/databases_update_cluster_metrics_credentials.yml'
/v2/domains:
get:
$ref: 'resources/domains/domains_list.yml'
post:
$ref: 'resources/domains/domains_create.yml'
/v2/domains/{domain_name}:
get:
$ref: 'resources/domains/domains_get.yml'
delete:
$ref: 'resources/domains/domains_delete.yml'
/v2/domains/{domain_name}/records:
get:
$ref: 'resources/domains/domains_list_records.yml'
post:
$ref: 'resources/domains/domains_create_record.yml'
/v2/domains/{domain_name}/records/{domain_record_id}:
get:
$ref: 'resources/domains/domains_get_record.yml'
patch:
$ref: 'resources/domains/domains_patch_record.yml'
put:
$ref: 'resources/domains/domains_update_record.yml'
delete:
$ref: 'resources/domains/domains_delete_record.yml'
/v2/droplets:
get:
$ref: 'resources/droplets/droplets_list.yml'
post:
$ref: 'resources/droplets/droplets_create.yml'
delete:
$ref: 'resources/droplets/droplets_destroy_byTag.yml'
/v2/droplets/{droplet_id}:
get:
$ref: 'resources/droplets/droplets_get.yml'
delete:
$ref: 'resources/droplets/droplets_destroy.yml'
/v2/droplets/{droplet_id}/backups:
get:
$ref: 'resources/droplets/droplets_list_backups.yml'
/v2/droplets/{droplet_id}/snapshots:
get:
$ref: 'resources/droplets/droplets_list_snapshots.yml'
/v2/droplets/{droplet_id}/actions:
get:
$ref: 'resources/droplets/dropletActions_list.yml'
post:
$ref: 'resources/droplets/dropletActions_post.yml'
/v2/droplets/actions:
post:
$ref: 'resources/droplets/dropletActions_post_byTag.yml'
/v2/droplets/{droplet_id}/actions/{action_id}:
get:
$ref: 'resources/droplets/dropletActions_get.yml'
/v2/droplets/{droplet_id}/kernels:
get:
$ref: 'resources/droplets/droplets_list_kernels.yml'
/v2/droplets/{droplet_id}/firewalls:
get:
$ref: 'resources/droplets/droplets_list_firewalls.yml'
/v2/droplets/{droplet_id}/neighbors:
get:
$ref: 'resources/droplets/droplets_list_neighbors.yml'
/v2/droplets/{droplet_id}/destroy_with_associated_resources:
get:
$ref: 'resources/droplets/droplets_list_associatedResources.yml'
/v2/droplets/{droplet_id}/destroy_with_associated_resources/selective:
delete:
$ref: 'resources/droplets/droplets_destroy_withAssociatedResourcesSelective.yml'
/v2/droplets/{droplet_id}/destroy_with_associated_resources/dangerous:
delete:
$ref: 'resources/droplets/droplets_destroy_withAssociatedResourcesDangerous.yml'
/v2/droplets/{droplet_id}/destroy_with_associated_resources/status:
get:
$ref: 'resources/droplets/droplets_get_destroyAssociatedResourcesStatus.yml'
/v2/droplets/{droplet_id}/destroy_with_associated_resources/retry:
post:
$ref: 'resources/droplets/droplets_destroy_retryWithAssociatedResources.yml'
/v2/firewalls:
get:
$ref: 'resources/firewalls/firewalls_list.yml'
post:
$ref: 'resources/firewalls/firewalls_create.yml'
/v2/firewalls/{firewall_id}:
get:
$ref: 'resources/firewalls/firewalls_get.yml'
put:
$ref: 'resources/firewalls/firewalls_update.yml'
delete:
$ref: 'resources/firewalls/firewalls_delete.yml'
/v2/firewalls/{firewall_id}/droplets:
post:
$ref: 'resources/firewalls/firewalls_assign_droplets.yml'
delete:
$ref: 'resources/firewalls/firewalls_delete_droplets.yml'
/v2/firewalls/{firewall_id}/tags:
post:
$ref: 'resources/firewalls/firewalls_add_tags.yml'
delete:
$ref: 'resources/firewalls/firewalls_delete_tags.yml'
/v2/firewalls/{firewall_id}/rules:
post:
$ref: 'resources/firewalls/firewalls_add_rules.yml'
delete:
$ref: 'resources/firewalls/firewalls_delete_rules.yml'
/v2/floating_ips:
get:
$ref: 'resources/floating_ips/floatingIPs_list.yml'
post:
$ref: 'resources/floating_ips/floatingIPs_create.yml'
/v2/floating_ips/{floating_ip}:
get:
$ref: 'resources/floating_ips/floatingIPs_get.yml'
delete:
$ref: 'resources/floating_ips/floatingIPs_delete.yml'
/v2/floating_ips/{floating_ip}/actions:
get:
$ref: 'resources/floating_ips/floatingIPsAction_list.yml'
post:
$ref: 'resources/floating_ips/floatingIPsAction_post.yml'