You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: openapi.yaml
+43-36Lines changed: 43 additions & 36 deletions
Original file line number
Diff line number
Diff line change
@@ -2716,12 +2716,12 @@ paths:
2716
2716
tags:
2717
2717
- Account
2718
2718
summary: Users List
2719
-
description: >
2720
-
Returns a paginated list of Users on your Account. Users may access all
2721
-
or part of your Account based on their restricted status and grants. An
2722
-
unrestricted User may access everything on the account, whereas restricted
2723
-
User may only access entities or perform actions they've been given specific
2724
-
grants to.
2719
+
description: |
2720
+
Returns a paginated list of Users on your Account.
2721
+
2722
+
This command can only be accessed by the unrestricted users of an account.
2723
+
2724
+
Users may access all or part of your Account based on their restricted status and grants. An unrestricted User may access everything on the account, whereas restricted User may only access entities or perform actions they've been given specific grants to.
2725
2725
operationId: getUsers
2726
2726
x-linode-cli-action: list
2727
2727
security:
@@ -2761,10 +2761,11 @@ paths:
2761
2761
tags:
2762
2762
- Account
2763
2763
summary: User Create
2764
-
description: >
2764
+
description: |
2765
2765
Creates a User on your Account. Once created, a confirmation message containing
2766
2766
password creation and login instructions is sent to the User's email address.
2767
2767
2768
+
This command can only be accessed by the unrestricted users of an account.
2768
2769
2769
2770
The User's account access is determined by whether or not they are restricted,
2770
2771
and what grants they have been given.
@@ -2824,8 +2825,10 @@ paths:
2824
2825
tags:
2825
2826
- Account
2826
2827
summary: User View
2827
-
description: >
2828
+
description: |
2828
2829
Returns information about a single User on your Account.
2830
+
2831
+
This command can only be accessed by the unrestricted users of an account.
2829
2832
operationId: getUser
2830
2833
x-linode-cli-action: view
2831
2834
security:
@@ -2854,11 +2857,13 @@ paths:
2854
2857
tags:
2855
2858
- Account
2856
2859
summary: User Update
2857
-
description: >
2860
+
description: |
2858
2861
Update information about a User on your Account. This can be used to
2859
2862
change the restricted status of a User. When making a User restricted,
2860
2863
no grants will be configured by default and you must then set up grants
2861
2864
in order for the User to access anything on the Account.
2865
+
2866
+
This command can only be accessed by the unrestricted users of an account.
2862
2867
operationId: updateUser
2863
2868
x-linode-cli-action: update
2864
2869
security:
@@ -2902,10 +2907,12 @@ paths:
2902
2907
tags:
2903
2908
- Account
2904
2909
summary: User Delete
2905
-
description: >
2910
+
description: |
2906
2911
Deletes a User. The deleted User will be immediately logged out and
2907
2912
may no longer log in or perform any actions. All of the User's Grants
2908
2913
will be removed.
2914
+
2915
+
This command can only be accessed by the unrestricted users of an account.
2909
2916
operationId: deleteUser
2910
2917
x-linode-cli-action: delete
2911
2918
security:
@@ -2944,11 +2951,12 @@ paths:
2944
2951
tags:
2945
2952
- Account
2946
2953
summary: User's Grants View
2947
-
description: >
2954
+
description: |
2948
2955
Returns the full grants structure for the specified account User
2949
2956
(other than the account owner, see below for details). This includes all entities
2950
2957
on the Account alongside the level of access this User has to each of them.
2951
2958
2959
+
This command can only be accessed by the unrestricted users of an account.
2952
2960
2953
2961
The current authenticated User, including the account owner, may view their
2954
2962
own grants at the [/profile/grants](/docs/api/profile/#grants-list)
@@ -2983,11 +2991,13 @@ paths:
2983
2991
tags:
2984
2992
- Account
2985
2993
summary: User's Grants Update
2986
-
description: >
2994
+
description: |
2987
2995
Update the grants a User has. This can be used to give a User access
2988
2996
to new entities or actions, or take access away. You do not need to
2989
2997
include the grant for every entity on the Account in this request; any
2990
2998
that are not included will remain unchanged.
2999
+
3000
+
This command can only be accessed by the unrestricted users of an account.
2991
3001
operationId: updateUserGrants
2992
3002
x-linode-cli-action: update-grants
2993
3003
x-linode-cli-skip: true
@@ -3729,7 +3739,6 @@ paths:
3729
3739
- url: https://api.linode.com/v4
3730
3740
- url: https://api.linode.com/v4beta
3731
3741
x-linode-cli-action: mongodb-backup-delete
3732
-
x-linode-grant: unrestricted only
3733
3742
description: |
3734
3743
Delete a single backup for an accessible Managed MongoDB Database.
3735
3744
@@ -4509,7 +4518,6 @@ paths:
4509
4518
- url: https://api.linode.com/v4
4510
4519
- url: https://api.linode.com/v4beta
4511
4520
x-linode-cli-action: mysql-backup-delete
4512
-
x-linode-grant: unrestricted only
4513
4521
description: |
4514
4522
Delete a single backup for an accessible Managed MySQL Database.
4515
4523
@@ -5280,7 +5288,6 @@ paths:
5280
5288
- url: https://api.linode.com/v4
5281
5289
- url: https://api.linode.com/v4beta
5282
5290
x-linode-cli-action: postgresql-backup-delete
5283
-
x-linode-grant: unrestricted only
5284
5291
description: |
5285
5292
Delete a single backup for an accessible Managed PostgreSQL Database.
5286
5293
@@ -11548,7 +11555,7 @@ paths:
11548
11555
tags:
11549
11556
- Managed
11550
11557
summary: Managed Contacts List
11551
-
description: >
11558
+
description: |
11552
11559
Returns a paginated list of Managed Contacts on your Account.
11553
11560
11554
11561
This command can only be accessed by the unrestricted users of an account.
@@ -11591,7 +11598,7 @@ paths:
11591
11598
tags:
11592
11599
- Managed
11593
11600
summary: Managed Contact Create
11594
-
description: >
11601
+
description: |
11595
11602
Creates a Managed Contact. A Managed Contact is someone Linode
11596
11603
special forces can contact in the course of attempting to resolve an issue
11597
11604
with a Managed Service.
@@ -11653,7 +11660,7 @@ paths:
11653
11660
tags:
11654
11661
- Managed
11655
11662
summary: Managed Contact View
11656
-
description: >
11663
+
description: |
11657
11664
Returns a single Managed Contact.
11658
11665
11659
11666
This command can only be accessed by the unrestricted users of an account.
@@ -11737,7 +11744,7 @@ paths:
11737
11744
tags:
11738
11745
- Managed
11739
11746
summary: Managed Contact Delete
11740
-
description: >
11747
+
description: |
11741
11748
Deletes a Managed Contact.
11742
11749
11743
11750
This command can only be accessed by the unrestricted users of an account.
@@ -11775,7 +11782,7 @@ paths:
11775
11782
tags:
11776
11783
- Managed
11777
11784
summary: Managed Credentials List
11778
-
description: >
11785
+
description: |
11779
11786
Returns a paginated list of Managed Credentials on your Account.
11780
11787
11781
11788
This command can only be accessed by the unrestricted users of an account.
@@ -11818,7 +11825,7 @@ paths:
11818
11825
tags:
11819
11826
- Managed
11820
11827
summary: Managed Credential Create
11821
-
description: >
11828
+
description: |
11822
11829
Creates a Managed Credential. A Managed Credential is stored securely
11823
11830
to allow Linode special forces to access your Managed Services and resolve
11824
11831
issues.
@@ -11894,7 +11901,7 @@ paths:
11894
11901
tags:
11895
11902
- Managed
11896
11903
summary: Managed Credential View
11897
-
description: >
11904
+
description: |
11898
11905
Returns a single Managed Credential.
11899
11906
11900
11907
This command can only be accessed by the unrestricted users of an account.
@@ -11983,7 +11990,7 @@ paths:
11983
11990
tags:
11984
11991
- Managed
11985
11992
summary: Managed Credential Username and Password Update
11986
-
description: >
11993
+
description: |
11987
11994
Updates the username and password for a Managed Credential.
11988
11995
11989
11996
This command can only be accessed by the unrestricted users of an account.
@@ -12053,7 +12060,7 @@ paths:
12053
12060
tags:
12054
12061
- Managed
12055
12062
summary: Managed Credential Delete
12056
-
description: >
12063
+
description: |
12057
12064
Deletes a Managed Credential. Linode special forces will no longer
12058
12065
have access to this Credential when attempting to resolve issues.
12059
12066
@@ -12089,7 +12096,7 @@ paths:
12089
12096
tags:
12090
12097
- Managed
12091
12098
summary: Managed SSH Key View
12092
-
description: >
12099
+
description: |
12093
12100
Returns the unique SSH public key assigned to your Linode account's
12094
12101
Managed service. If you [add this public key](/docs/platform/linode-managed/#adding-the-public-key) to a Linode on your account,
12095
12102
Linode special forces will be able to log in to the Linode with this key
@@ -12140,7 +12147,7 @@ paths:
12140
12147
tags:
12141
12148
- Managed
12142
12149
summary: Managed Issues List
12143
-
description: >
12150
+
description: |
12144
12151
Returns a paginated list of recent and ongoing issues detected on your
12145
12152
Managed Services.
12146
12153
@@ -12194,7 +12201,7 @@ paths:
12194
12201
tags:
12195
12202
- Managed
12196
12203
summary: Managed Issue View
12197
-
description: >
12204
+
description: |
12198
12205
Returns a single Issue that is impacting or did impact one of your
12199
12206
Managed Services.
12200
12207
@@ -12232,7 +12239,7 @@ paths:
12232
12239
tags:
12233
12240
- Managed
12234
12241
summary: Managed Linode Settings List
12235
-
description: >
12242
+
description: |
12236
12243
Returns a paginated list of Managed Settings for your Linodes. There will
12237
12244
be one entry per Linode on your Account.
12238
12245
@@ -12286,7 +12293,7 @@ paths:
12286
12293
tags:
12287
12294
- Managed
12288
12295
summary: Linode's Managed Settings View
12289
-
description: >
12296
+
description: |
12290
12297
Returns a single Linode's Managed settings.
12291
12298
12292
12299
This command can only be accessed by the unrestricted users of an account.
@@ -12373,7 +12380,7 @@ paths:
12373
12380
tags:
12374
12381
- Managed
12375
12382
summary: Managed Services List
12376
-
description: >
12383
+
description: |
12377
12384
Returns a paginated list of Managed Services on your Account. These
12378
12385
are the services Linode Managed is monitoring and will report and attempt
12379
12386
to resolve issues with.
@@ -12418,7 +12425,7 @@ paths:
12418
12425
tags:
12419
12426
- Managed
12420
12427
summary: Managed Service Create
12421
-
description: >
12428
+
description: |
12422
12429
Creates a Managed Service. Linode Managed will begin monitoring this
12423
12430
service and reporting and attempting to resolve any Issues.
12424
12431
@@ -12494,7 +12501,7 @@ paths:
12494
12501
tags:
12495
12502
- Managed
12496
12503
summary: Managed Service View
12497
-
description: >
12504
+
description: |
12498
12505
Returns information about a single Managed Service on your Account.
12499
12506
12500
12507
This command can only be accessed by the unrestricted users of an account.
@@ -12526,7 +12533,7 @@ paths:
12526
12533
tags:
12527
12534
- Managed
12528
12535
summary: Managed Service Update
12529
-
description: >
12536
+
description: |
12530
12537
Updates information about a Managed Service.
12531
12538
12532
12539
This command can only be accessed by the unrestricted users of an account.
@@ -12586,7 +12593,7 @@ paths:
12586
12593
tags:
12587
12594
- Managed
12588
12595
summary: Managed Service Delete
12589
-
description: >
12596
+
description: |
12590
12597
Deletes a Managed Service. This service will no longer be monitored by
12591
12598
Linode Managed.
12592
12599
@@ -12629,7 +12636,7 @@ paths:
12629
12636
tags:
12630
12637
- Managed
12631
12638
summary: Managed Service Disable
12632
-
description: >
12639
+
description: |
12633
12640
Temporarily disables monitoring of a Managed Service.
12634
12641
12635
12642
This command can only be accessed by the unrestricted users of an account.
@@ -12672,7 +12679,7 @@ paths:
12672
12679
tags:
12673
12680
- Managed
12674
12681
summary: Managed Service Enable
12675
-
description: >
12682
+
description: |
12676
12683
Enables monitoring of a Managed Service.
12677
12684
12678
12685
This command can only be accessed by the unrestricted users of an account.
0 commit comments