From e12815239389e9bc2f0877413504b93712e4067e Mon Sep 17 00:00:00 2001 From: hzoppetti Date: Mon, 28 Sep 2020 15:52:20 -0400 Subject: [PATCH 1/8] changed summary names to noun-verb --- openapi.yaml | 516 +++++++++++++++++++++++++-------------------------- 1 file changed, 258 insertions(+), 258 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 88bc3474f..40a05e6fd 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -382,7 +382,7 @@ paths: x-linode-grant: read_only tags: - Account - summary: View Account + summary: Account View description: > Returns the contact and billing information related to your Account. @@ -413,7 +413,7 @@ paths: x-linode-grant: read_write tags: - Account - summary: Update Account + summary: Account Update description: > Updates contact and billing information related to your Account. @@ -470,7 +470,7 @@ paths: x-linode-grant: read_write tags: - Account - summary: Cancel Account + summary: Account Cancel description: > Cancels an active Linode account. This action will cause Linode to attempt to charge the credit card on file for the remaining @@ -553,7 +553,7 @@ paths: x-linode-grant: read_write tags: - Account - summary: Add/Edit Credit Card + summary: Credit Card Add/Edit description: > Adds/edit credit card information to your Account. @@ -616,7 +616,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Account - summary: List Events + summary: Events List description: > Returns a collection of Event objects representing actions taken on your Account from the last 90 days. @@ -670,7 +670,7 @@ paths: x-linode-grant: read_only tags: - Account - summary: View Event + summary: Event View description: > Returns a single Event object. operationId: getEvent @@ -709,7 +709,7 @@ paths: x-linode-grant: read_write tags: - Account - summary: Mark Event as Read + summary: Event Mark as Read description: Marks a single Event as read. operationId: eventRead x-linode-cli-action: mark-read @@ -749,7 +749,7 @@ paths: x-linode-grant: read_write tags: - Account - summary: Mark Event as Seen + summary: Event Mark as Seen description: > Marks all Events up to and including this Event by ID as seen. operationId: eventSeen @@ -786,7 +786,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Account - summary: List Invoices + summary: Invoices List description: > Returns a paginated list of Invoices against your Account. operationId: getInvoices @@ -836,7 +836,7 @@ paths: x-linode-grant: read_only tags: - Account - summary: View Invoice + summary: Invoice View description: Returns a single Invoice object. operationId: getInvoice x-linode-cli-action: invoice-view @@ -877,7 +877,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Account - summary: List Invoice Items + summary: Invoice Items List description: Returns a paginated list of Invoice items. operationId: getInvoiceItems x-linode-cli-action: invoice-items @@ -918,7 +918,7 @@ paths: get: tags: - Account - summary: List All User Logins + summary: User Logins List All description: > Returns a collection of successful logins for all users on the account during the last 90 days. This command can only be accessed by the unrestricted users of an account. @@ -964,7 +964,7 @@ paths: get: tags: - Account - summary: View Login + summary: Login View description: > Returns a Login object that displays information about a successful login. The logins that can be viewed can be for any user on the account, and are not @@ -1001,7 +1001,7 @@ paths: - url: https://api.linode.com/v4beta tags: - Account - summary: List Maintenance + summary: Maintenance List description: > Returns a collection of Maintenance objects for any entity a user has permissions to view. @@ -1054,7 +1054,7 @@ paths: x-linode-grant: read_only tags: - Account - summary: List Notifications + summary: Notifications List description: > Returns a collection of Notification objects representing important, often time-sensitive items related to your Account. @@ -1106,7 +1106,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Account - summary: List OAuth Clients + summary: OAuth Clients List description: > Returns a paginated list of OAuth Clients registered to your Account. OAuth Clients allow users to log into applications you write or host using their @@ -1149,7 +1149,7 @@ paths: post: tags: - Account - summary: Create OAuth Client + summary: OAuth Client Create description: > Creates an OAuth Client, which can be used to allow users (using their Linode account) to log in to your own application, and optionally grant @@ -1214,7 +1214,7 @@ paths: get: tags: - Account - summary: View OAuth Client + summary: OAuth Client View description: > Returns information about a single OAuth client. operationId: getClient @@ -1244,7 +1244,7 @@ paths: put: tags: - Account - summary: Update OAuth Client + summary: OAuth Client Update description: > Update information about an OAuth Client on your Account. This can be especially useful to update the `redirect_uri` of your client in the event @@ -1289,7 +1289,7 @@ paths: delete: tags: - Account - summary: Delete OAuth Client + summary: OAuth Client Delete description: > Deletes an OAuth Client registered with Linode. The Client ID and Client secret will no longer be accepted by https://login.linode.com, @@ -1332,7 +1332,7 @@ paths: post: tags: - Account - summary: Reset OAuth Client Secret + summary: OAuth Client Secret Reset description: > Resets the OAuth Client secret for a client you own, and returns the OAuth Client with the plaintext secret. This secret is not supposed to @@ -1378,7 +1378,7 @@ paths: get: tags: - Account - summary: View OAuth Client Thumbnail + summary: OAuth Client Thumbnail View description: > Returns the thumbnail for this OAuth Client. This is a publicly-viewable endpoint, and can be accessed without authentication. @@ -1403,7 +1403,7 @@ paths: put: tags: - Account - summary: Update OAuth Client Thumbnail + summary: OAuth Client Thumbnail Update description: > Upload a thumbnail for a client you own. You must upload an image file that will be returned when the thumbnail is retrieved. This image will @@ -1449,7 +1449,7 @@ paths: x-linode-grant: read_only tags: - Account - summary: List Payments + summary: Payments List description: > Returns a paginated list of Payments made on this Account. operationId: getPayments @@ -1490,7 +1490,7 @@ paths: x-linode-grant: read_write tags: - Account - summary: Make Payment + summary: Payment Make description: > Makes a Payment to your Account via credit card. This will charge your credit card the requested amount. @@ -1544,7 +1544,7 @@ paths: x-linode-grant: read_only tags: - Account - summary: View Payment + summary: Payment View description: > Returns information about a specific Payment. operationId: getPayment @@ -1576,7 +1576,7 @@ paths: x-linode-grant: read_only tags: - Account - summary: Stage PayPal Payment + summary: PayPal Payment Stage description: > This begins the process of submitting a Payment via PayPal. After calling this endpoint, you must take the resulting `payment_id` along with @@ -1642,7 +1642,7 @@ paths: x-linode-grant: read_write tags: - Account - summary: Execute Staged/Approved PayPal Payment + summary: Staged/Approved PayPal Payment Execute description: > Given a PaymentID and PayerID - as generated by PayPal during the transaction authorization process - this endpoint executes the Payment @@ -1689,7 +1689,7 @@ paths: x-linode-grant: read_only tags: - Account - summary: View Account Settings + summary: Account Settings View description: > Returns information related to your Account settings: Managed service subscription, Longview @@ -1721,7 +1721,7 @@ paths: x-linode-grant: read_write tags: - Account - summary: Update Account Settings + summary: Account Settings Update description: > Updates your Account settings. @@ -1768,7 +1768,7 @@ paths: x-linode-grant: read_write tags: - Account - summary: Enable Linode Managed + summary: Linode Managed Enable description: > Enables Linode Managed for the entire account and sends a welcome email to the account's associated email address. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. See @@ -1804,7 +1804,7 @@ paths: x-linode-grant: read_only tags: - Account - summary: View Network Utilization + summary: Network Utilization View description: > Returns a Transfer object showing your network utilization, in GB, for the current month. @@ -1840,7 +1840,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Account - summary: List Users + summary: Users List description: > Returns a paginated list of Users on your Account. Users may access all or part of your Account based on their restricted status and grants. An @@ -1885,7 +1885,7 @@ paths: x-linode-grant: unrestricted only tags: - Account - summary: Create User + summary: User Create description: > Creates a User on your Account. Once created, the User will be able to log in and access portions of your Account. Access is @@ -1968,7 +1968,7 @@ paths: x-linode-grant: unrestricted only tags: - Account - summary: View User + summary: User View description: > Returns information about a single User on your Account. operationId: getUser @@ -1998,7 +1998,7 @@ paths: x-linode-grant: unrestricted only tags: - Account - summary: Update User + summary: User Update description: > Update information about a User on your Account. This can be used to change the restricted status of a User. When making a User restricted, @@ -2044,7 +2044,7 @@ paths: x-linode-grant: unrestricted only tags: - Account - summary: Delete User + summary: User Delete description: > Deletes a User. The deleted User will be immediately logged out and may no longer log in or perform any actions. All of the User's Grants @@ -2086,7 +2086,7 @@ paths: x-linode-grant: unrestricted only tags: - Account - summary: View User's grants + summary: User's Grants View description: > Returns the full grants structure for the specified account User (other than the account owner, see below for details). This includes all entities @@ -2125,7 +2125,7 @@ paths: x-linode-grant: unrestricted only tags: - Account - summary: Update User's grants + summary: User's Grants Update description: > Update the grants a User has. This can be used to give a User access to new entities or actions, or take access away. You do not need to @@ -2241,7 +2241,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Domains - summary: List Domains + summary: Domains List description: > This is a collection of Domains that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for these to work you @@ -2284,7 +2284,7 @@ paths: x-linode-grant: add_domains tags: - Domains - summary: Create Domain + summary: Domain Create description: > Adds a new Domain to Linode's DNS Manager. Linode is not a registrar, and you must own the domain before adding it here. Be sure to point your @@ -2352,7 +2352,7 @@ paths: x-linode-grant: read_only tags: - Domains - summary: View Domain + summary: Domain View description: > This is a single Domain that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for this Domain record to work you @@ -2385,7 +2385,7 @@ paths: x-linode-grant: read_write tags: - Domains - summary: Update Domain + summary: Domain Update description: | Update information about a Domain in Linode's DNS Manager. operationId: updateDomain @@ -2439,7 +2439,7 @@ paths: x-linode-grant: read_write tags: - Domains - summary: Delete Domain + summary: Domain Delete description: > Deletes a Domain from Linode's DNS Manager. The Domain will be removed from Linode's nameservers shortly after this operation completes. This @@ -2474,7 +2474,7 @@ paths: x-linode-cli-command: domains tags: - Domains - summary: Import Domain + summary: Domain Import description: > Imports a domain zone from a remote nameserver. @@ -2545,7 +2545,7 @@ paths: x-linode-grant: read_write tags: - Domains - summary: Clone Domain + summary: Domain Clone description: > Clones a Domain and all associated DNS records from a Domain that is registered in Linode's DNS manager. @@ -2611,7 +2611,7 @@ paths: - personalAccessToken: [] - oauth: - domains:read_only - summary: List Domain Records + summary: Domain Records List description: | Returns a paginated list of Records configured on a Domain in Linode's DNS Manager. @@ -2651,7 +2651,7 @@ paths: - personalAccessToken: [] - oauth: - domains:read_write - summary: Create Domain Record + summary: Domain Record Create description: > Adds a new Domain Record to the zonefile this Domain represents. operationId: createDomainRecord @@ -2726,7 +2726,7 @@ paths: - personalAccessToken: [] - oauth: - domains:read_only - summary: View Domain Record + summary: Domain Record View description: > View a single Record on this Domain. operationId: getDomainRecord @@ -2756,7 +2756,7 @@ paths: - personalAccessToken: [] - oauth: - domains:read_write - summary: Update Domain Record + summary: Domain Record Update description: > Updates a single Record on this Domain. operationId: updateDomainRecord @@ -2813,7 +2813,7 @@ paths: - personalAccessToken: [] - oauth: - domains:read_write - summary: Delete Domain Record + summary: Domain Record Delete description: > Deletes a Record on this Domain. operationId: deleteDomainRecord @@ -2845,7 +2845,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Images - summary: List Images + summary: Images List description: > Returns a paginated list of Images. @@ -2892,7 +2892,7 @@ paths: x-linode-grant: read_write tags: - Images - summary: Create Image + summary: Image Create description: > Creates a private gold-master Image from a Linode Disk. There is no additional charge to store Images for Linode users. @@ -2966,7 +2966,7 @@ paths: get: tags: - Images - summary: View Image + summary: Image View description: > Get information about a single Image. operationId: getImage @@ -2991,7 +2991,7 @@ paths: x-linode-grant: read_write tags: - Images - summary: Update Image + summary: Image Update description: > Updates a private Image that you have permission to `read_write`. @@ -3038,7 +3038,7 @@ paths: x-linode-grant: read_write tags: - Images - summary: Delete Image + summary: Image Delete description: | Deletes a private Image you have permission to `read_write`. @@ -3075,7 +3075,7 @@ paths: parameters: - $ref: '#/components/parameters/pageOffset' - $ref: '#/components/parameters/pageSize' - summary: List Linodes + summary: Linodes List description: > Returns a paginated list of Linodes you have permission to view. tags: @@ -3117,7 +3117,7 @@ paths: post: x-linode-charge: true x-linode-grant: add_linodes - summary: Create Linode + summary: Linode Create description: | Creates a Linode Instance on your Account. In order for this request to complete successfully, your User must have the `add_linodes` grant. Creating a @@ -3356,7 +3356,7 @@ paths: x-linode-grant: read_only tags: - Linode Instances - summary: View Linode + summary: Linode View description: Get a specific Linode by ID. operationId: getLinodeInstance x-linode-cli-action: view @@ -3406,7 +3406,7 @@ paths: x-linode-grant: read_write tags: - Linode Instances - summary: Update Linode + summary: Linode Update description: > Updates a Linode that you have permission to `read_write`. @@ -3476,7 +3476,7 @@ paths: x-linode-grant: read_write tags: - Linode Instances - summary: Delete Linode + summary: Linode Delete description: | Deletes a Linode you have permission to `read_write`. @@ -3523,7 +3523,7 @@ paths: x-linode-cli-command: linodes get: x-linode-grant: read_only - summary: List Backups + summary: Backups List description: > Returns information about this Linode's available backups. tags: @@ -3576,7 +3576,7 @@ paths: linode-cli linodes backups-list 123 post: x-linode-grant: read_write - summary: Create Snapshot + summary: Snapshot Create description: > Creates a snapshot Backup of a Linode. @@ -3637,7 +3637,7 @@ paths: x-linode-cli-command: linodes post: x-linode-grant: read_write - summary: Cancel Backups + summary: Backups Cancel description: > Cancels the Backup service on the given Linode. Deletes all of this Linode's existing backups forever. @@ -3679,7 +3679,7 @@ paths: x-linode-cli-command: linodes post: x-linode-grant: read_write - summary: Enable Backups + summary: Backups Enable description: > Enables backups for the specified Linode. tags: @@ -3726,7 +3726,7 @@ paths: x-linode-cli-command: linodes get: x-linode-grant: read_only - summary: View Backup + summary: Backup View description: > Returns information about a Backup. tags: @@ -3771,7 +3771,7 @@ paths: x-linode-cli-command: linodes post: x-linode-grant: read_write - summary: Restore Backup + summary: Backup Restore description: > Restores a Linode's Backup to the specified Linode. tags: @@ -3842,7 +3842,7 @@ paths: x-linode-cli-command: linodes post: x-linode-grant: read_write - summary: Boot Linode + summary: Linode Boot description: | Boots a Linode you have permission to modify. If no parameters are given, a Config profile will be chosen for this boot based on the following criteria: @@ -3904,7 +3904,7 @@ paths: post: x-linode-charge: true x-linode-grant: add_linodes - summary: Clone Linode + summary: Linode Clone description: | You can clone your Linode's existing Disks or Configuration profiles to another Linode on your Account. In order for this request to complete @@ -4086,7 +4086,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Linode Instances - summary: List Configuration Profiles + summary: Configuration Profiles List description: | Lists Configuration profiles associated with a Linode. operationId: getLinodeConfigs @@ -4125,7 +4125,7 @@ paths: post: tags: - Linode Instances - summary: Create Configuration Profile + summary: Configuration Profile Create description: > Adds a new Configuration profile to a Linode. operationId: addLinodeConfig @@ -4210,7 +4210,7 @@ paths: tags: - Linode Instances x-linode-grant: read_only - summary: View Configuration Profile + summary: Configuration Profile View description: > Returns information about a specific Configuration profile. operationId: getLinodeConfig @@ -4238,7 +4238,7 @@ paths: linode-cli linodes config-view 123 23456 put: x-linode-grant: read_write - summary: Update Configuration Profile + summary: Configuration Profile Update description: > Updates a Configuration profile. tags: @@ -4373,7 +4373,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' delete: - summary: Delete Configuration Profile + summary: Configuration Profile Delete description: > Deletes the specified Configuration profile from the specified Linode. x-linode-grant: read_write @@ -4420,7 +4420,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Linode Instances - summary: List Disks + summary: Disks List description: > View Disk information for Disks associated with this Linode. operationId: getLinodeDisks @@ -4460,7 +4460,7 @@ paths: post: tags: - Linode Instances - summary: Create Disk + summary: Disk Create description: > Adds a new Disk to a Linode. You can optionally create a Disk from an Image (see [/images](/api/v4/images) for a list of available public images, @@ -4542,7 +4542,7 @@ paths: x-linode-grant: read_only tags: - Linode Instances - summary: View Disk + summary: Disk View description: > View Disk information for a Disk associated with this Linode. operationId: getLinodeDisk @@ -4572,7 +4572,7 @@ paths: x-linode-grant: read_write tags: - Linode Instances - summary: Update Disk + summary: Disk Update description: > Updates a Disk that you have permission to `read_write`. operationId: updateDisk @@ -4615,7 +4615,7 @@ paths: x-linode-grant: read_write tags: - Linode Instances - summary: Delete Disk + summary: Disk Delete description: | Deletes a Disk you have permission to `read_write`. @@ -4663,7 +4663,7 @@ paths: x-linode-grant: read_write tags: - Linode Instances - summary: Clone Disk + summary: Disk Clone description: > Copies a disk, byte-for-byte, into a new Disk belonging to the same Linode. The Linode must have enough storage space available to accept a new Disk @@ -4702,7 +4702,7 @@ paths: x-linode-grant: read_write tags: - Linode Instances - summary: Reset Disk Root Password + summary: Disk Root Password Reset description: > Resets the password of a Disk you have permission to `read_write`. operationId: resetDiskPassword @@ -4769,7 +4769,7 @@ paths: x-linode-grant: read_write tags: - Linode Instances - summary: Resize Disk + summary: Disk Resize description: > Resizes a Disk you have permission to `read_write`. @@ -4836,7 +4836,7 @@ paths: x-linode-grant: read_only tags: - Linode Instances - summary: List Networking Information + summary: Networking Information List description: > Returns networking information for a single Linode. operationId: getLinodeIPs @@ -4912,7 +4912,7 @@ paths: x-linode-grant: read_write tags: - Linode Instances - summary: Allocate IPv4 Address + summary: IPv4 Address Allocate description: > Allocates a public or private IPv4 address to a Linode. Public IP Addresses, after the one included with each Linode, @@ -4993,7 +4993,7 @@ paths: x-linode-grant: read_only tags: - Linode Instances - summary: View IP Address + summary: IP Address View description: > View information about the specified IP address associated with the specified Linode. @@ -5024,7 +5024,7 @@ paths: x-linode-grant: read_write tags: - Linode Instances - summary: Update IP Address + summary: IP Address Update description: > Updates a particular IP Address associated with this Linode. Only allows setting/resetting reverse DNS. @@ -5068,7 +5068,7 @@ paths: x-linode-grant: read_write tags: - Linode Instances - summary: Delete IPv4 Address + summary: IPv4 Address Delete description: > Deletes a public IPv4 address associated with this Linode. This will fail if it is the Linode's last remaining public IPv4 address. Private @@ -5106,7 +5106,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Linode Instances - summary: List Kernels + summary: Kernels List description: | Lists available Kernels. operationId: getKernels @@ -5150,7 +5150,7 @@ paths: get: tags: - Linode Instances - summary: View Kernel + summary: Kernel View description: > Returns information about a single Kernel. operationId: getKernel @@ -5182,7 +5182,7 @@ paths: x-linode-cli-command: linodes post: x-linode-grant: read_write - summary: Initiate DC Migration/Pending Host Migration + summary: DC Migration/Pending Host Migration Initiate description: > Initiate a pending host migration that has been scheduled by Linode or initiate a cross data center (DC) migration. A list of pending migrations, @@ -5276,7 +5276,7 @@ paths: x-linode-cli-command: linodes post: x-linode-grant: read_write - summary: Upgrade Linode + summary: Linode Upgrade description: > Linodes created with now-deprecated Types are entitled to a free upgrade to the next generation. A mutating Linode will be allocated any new @@ -5339,7 +5339,7 @@ paths: x-linode-cli-command: linodes post: x-linode-grant: read_write - summary: Reset Linode Root Password + summary: Linode Root Password Reset description: > Resets the root password for this Linode. @@ -5405,7 +5405,7 @@ paths: x-linode-cli-command: linodes post: x-linode-grant: read_write - summary: Reboot Linode + summary: Linode Reboot description: > Reboots a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can initiate a reboot. @@ -5462,7 +5462,7 @@ paths: x-linode-cli-command: linodes post: x-linode-grant: read_write - summary: Rebuild Linode + summary: Linode Rebuild description: > Rebuilds a Linode you have the `read_write` permission to modify. @@ -5547,7 +5547,7 @@ paths: x-linode-cli-command: linodes post: x-linode-grant: read_write - summary: Boot Linode into Rescue Mode + summary: Linode Boot into Rescue Mode description: > Rescue Mode is a safe environment for performing many system recovery and disk management tasks. Rescue Mode is based on the Finnix recovery @@ -5617,7 +5617,7 @@ paths: x-linode-cli-command: linodes post: x-linode-grant: read_write - summary: Resize Linode + summary: Linode Resize description: > Resizes a Linode you have the `read_write` permission to a different Type. If any actions are currently running or queued, those actions must @@ -5694,7 +5694,7 @@ paths: x-linode-cli-command: linodes post: x-linode-grant: read_write - summary: Shut Down Linode + summary: Linode Shut Down description: > Shuts down a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can initiate a shutdown. @@ -5738,7 +5738,7 @@ paths: x-linode-grant: read_only tags: - Linode Instances - summary: View Network Transfer + summary: Network Transfer View description: > Returns a Linode's network transfer pool statistics for the current month. operationId: getLinodeTransfer @@ -5811,7 +5811,7 @@ paths: x-linode-grant: read_only tags: - Linode Instances - summary: View Network Transfer (year/month) + summary: Network Transfer View (year/month) description: > Returns a Linode's network transfer statistics for a specific month. The year/month values must be either a date in the past, or the current month. @@ -5871,7 +5871,7 @@ paths: get: tags: - Linode Instances - summary: View Linode Statistics + summary: Linode Statistics View description: > Returns CPU, IO, IPv4, and IPv6 statistics for your Linode for the past 24 hours. @@ -5922,7 +5922,7 @@ paths: get: tags: - Linode Instances - summary: View Statistics (year/month) + summary: Statistics View (year/month) description: > Returns statistics for a specific month. The year/month values must be either a date in the past, or the current month. If the @@ -5963,7 +5963,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Linode Instances - summary: List Linode's Volumes + summary: Linode's Volumes List description: > View Block Storage Volumes attached to this Linode. operationId: getLinodeVolumes @@ -6010,7 +6010,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - StackScripts - summary: List StackScripts + summary: StackScripts List description: > If the request is not authenticated, only public StackScripts are returned. @@ -6056,7 +6056,7 @@ paths: x-linode-grant: add_stackscripts tags: - StackScripts - summary: Create StackScript + summary: StackScript Create description: > Creates a StackScript in your Account. operationId: addStackScript @@ -6126,7 +6126,7 @@ paths: x-linode-grant: read_only tags: - StackScripts - summary: View StackScript + summary: StackScript View description: > Returns all of the information about a specified StackScript, including the contents of the script. @@ -6156,7 +6156,7 @@ paths: x-linode-grant: read_write tags: - StackScripts - summary: Update StackScript + summary: StackScript Update description: > Updates a StackScript. @@ -6215,7 +6215,7 @@ paths: x-linode-grant: read_write tags: - StackScripts - summary: Delete StackScript + summary: StackScript Delete description: > Deletes a private StackScript you have permission to `read_write`. You cannot delete a public StackScript. operationId: deleteStackScript @@ -6247,7 +6247,7 @@ paths: get: tags: - Linode Types - summary: List Types + summary: Types List description: > Returns collection of Linode Types, including pricing and specifications for each Type. These are used when @@ -6296,7 +6296,7 @@ paths: get: tags: - Linode Types - summary: View Type + summary: Type View description: > Returns information about a specific Linode Type, including pricing and specifications. This is used when @@ -6333,7 +6333,7 @@ paths: - lke:read_only tags: - Linode Kubernetes Engine (LKE) - summary: List Kubernetes Clusters + summary: Kubernetes Clusters List description: > Lists current Kubernetes clusters available on your account. responses: @@ -6375,7 +6375,7 @@ paths: - lke:read_write tags: - Linode Kubernetes Engine (LKE) - summary: Create Kubernetes Cluster + summary: Kubernetes Cluster Create description: | Creates a Kubernetes cluster. The Kubernetes cluster will be created asynchronously. You can use the events system to determine when the @@ -6468,7 +6468,7 @@ paths: - lke:read_only tags: - Linode Kubernetes Engine (LKE) - summary: View Kubernetes Cluster + summary: Kubernetes Cluster View description: > Get a specific Cluster by ID. responses: @@ -6497,7 +6497,7 @@ paths: - lke:read_write tags: - Linode Kubernetes Engine (LKE) - summary: Update Kubernetes Cluster + summary: Kubernetes Cluster Update description: > Updates a Kubernetes cluster. requestBody: @@ -6576,7 +6576,7 @@ paths: - lke:read_write tags: - Linode Kubernetes Engine (LKE) - summary: Delete Kubernetes Cluster + summary: Kubernetes Cluster Delete description: | Deletes a Cluster you have permission to `read_write`. @@ -6625,7 +6625,7 @@ paths: - lke:read_only tags: - Linode Kubernetes Engine (LKE) - summary: List Node Pools + summary: Node Pools List description: > Returns all active Node Pools on a Kubernetes cluster. responses: @@ -6679,7 +6679,7 @@ paths: - lke:read_write tags: - Linode Kubernetes Engine (LKE) - summary: Create Node Pool + summary: Node Pool Create description: > Creates a new Node Pool for the designated Kubernetes cluster. requestBody: @@ -6753,7 +6753,7 @@ paths: - lke:read_only tags: - Linode Kubernetes Engine (LKE) - summary: View Node Pool + summary: Node Pool View description: > Get a specific Node Pool by ID. responses: @@ -6791,7 +6791,7 @@ paths: - lke:read_write tags: - Linode Kubernetes Engine (LKE) - summary: Update Node Pool + summary: Node Pool Update description: | Updates a Node Pool's count. @@ -6846,7 +6846,7 @@ paths: - lke:read_write tags: - Linode Kubernetes Engine (LKE) - summary: Delete Node Pool + summary: Node Pool Delete description: | Delete a specific Node Pool from a Kubernetes cluster. @@ -6895,7 +6895,7 @@ paths: - lke:read_write tags: - Linode Kubernetes Engine (LKE) - summary: Recycle Node Pool + summary: Node Pool Recycle description: | Recycles a Node Pool for the designated Kubernetes Cluster. All Linodes within the Node Pool will be deleted and replaced with new Linodes on a rolling basis, which may take several minutes. Replacement Nodes are @@ -6939,7 +6939,7 @@ paths: - lke:read_only tags: - Linode Kubernetes Engine (LKE) - summary: List Kubernetes API Endpoints + summary: Kubernetes API Endpoints List description: > List the Kubernetes API server endpoints for this cluster. Please note that it often takes 2-5 minutes before the endpoint is ready after first [creating a new cluster](/api/v4/lke-clusters/#post). @@ -6998,7 +6998,7 @@ paths: - lke:read_write tags: - Linode Kubernetes Engine (LKE) - summary: View Kubeconfig + summary: Kubeconfig View description: | Get the Kubeconfig file for a Cluster. Please note that it often takes 2-5 minutes before the Kubeconfig file is ready after first [creating a new cluster](/api/v4/lke-clusters/#post). @@ -7037,7 +7037,7 @@ paths: - lke:read_only tags: - Linode Kubernetes Engine (LKE) - summary: List Kubernetes Versions + summary: Kubernetes Versions List description: > List the Kubernetes versions available for deployment to a Kubernetes cluster. @@ -7090,7 +7090,7 @@ paths: - lke:read_only tags: - Linode Kubernetes Engine (LKE) - summary: View Kubernetes Version + summary: Kubernetes Version View description: > View a Kubernetes version available for deployment to a Kubernetes cluster. @@ -7122,7 +7122,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Longview - summary: List Longview Clients + summary: Longview Clients List description: > Returns a paginated list of Longview Clients you have access to. Longview Client is used to monitor stats on your Linode @@ -7165,7 +7165,7 @@ paths: x-linode-grant: add_longview tags: - Longview - summary: Create Longview Client + summary: Longview Client Create description: > Creates a Longview Client. This Client will not begin monitoring the status of your server until you configure the Longview @@ -7219,7 +7219,7 @@ paths: x-linode-grant: read_only tags: - Longview - summary: View Longview Client + summary: Longview Client View description: > Returns a single Longview Client you can access. operationId: getLongviewClient @@ -7249,7 +7249,7 @@ paths: x-linode-grant: read_write tags: - Longview - summary: Update Longview Client + summary: Longview Client Update description: > Updates a Longview Client. This cannot update how it monitors your server; use the Longview Client application on your Linode for @@ -7293,7 +7293,7 @@ paths: x-linode-grant: read_write tags: - Longview - summary: Delete Longview Client + summary: Longview Client Delete description: > Deletes a Longview Client from your Account. @@ -7332,7 +7332,7 @@ paths: get: tags: - Longview - summary: View Longview Plan + summary: Longview Plan View description: > Get the details of your current Longview plan. This returns a `LongviewSubscription` object for your current Longview Pro plan, or an empty set `{}` if your current plan is Longview Free. @@ -7374,7 +7374,7 @@ paths: put: tags: - Longview - summary: Update Longview Plan + summary: Longview Plan Update description: > Update your Longview plan to that of the given subcription ID. This returns a `LongviewSubscription` object for the updated Longview Pro plan, or an empty set `{}` if the updated plan is Longview Free. @@ -7428,7 +7428,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Longview - summary: List Longview Subscriptions + summary: Longview Subscriptions List description: > Returns a paginated list of available Longview Subscriptions. This is a public endpoint and requires no authentication. @@ -7474,7 +7474,7 @@ paths: get: tags: - Longview - summary: View Longview Subscription + summary: Longview Subscription View description: > Get the Longview plan details as a single `LongviewSubscription` object for the provided subscription ID. This is a public endpoint and requires no authentication. @@ -7507,7 +7507,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Managed - summary: List Managed Contacts + summary: Managed Contacts List description: > Returns a paginated list of Managed Contacts on your Account. operationId: getManagedContacts @@ -7548,7 +7548,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: Create Managed Contact + summary: Managed Contact Create description: > Creates a Managed Contact. A Managed Contact is someone Linode special forces can contact in the course of attempting to resolve an issue @@ -7608,7 +7608,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: View Managed Contact + summary: Managed Contact View description: > Returns a single Managed Contact. operationId: getManagedContact @@ -7638,7 +7638,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: Update Managed Contact + summary: Managed Contact Update description: > Updates information about a Managed Contact. operationId: updateManagedContact @@ -7688,7 +7688,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: Delete Managed Contact + summary: Managed Contact Delete description: > Deletes a Managed Contact. operationId: deleteManagedContact @@ -7724,7 +7724,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Managed - summary: List Managed Credentials + summary: Managed Credentials List description: > Returns a paginated list of Managed Credentials on your Account. operationId: getManagedCredentials @@ -7765,7 +7765,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: Create Managed Credential + summary: Managed Credential Create description: > Creates a Managed Credential. A Managed Credential is stored securely to allow Linode special forces to access your Managed Services and resolve @@ -7839,7 +7839,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: View Managed Credential + summary: Managed Credential View description: > Returns a single Managed Credential. operationId: getManagedCredential @@ -7869,7 +7869,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: Update Managed Credential + summary: Managed Credential Update description: > Updates the label of a Managed Credential. This endpoint does not update the username and password for a Managed Credential. @@ -7924,7 +7924,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: Update Managed Credential Username and Password + summary: Managed Credential Username and Password Update description: > Updates the username and password for a Managed Credential. operationId: updateManagedCredentialUsernamePassword @@ -7992,7 +7992,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: Delete Managed Credential + summary: Managed Credential Delete description: > Deletes a Managed Credential. Linode special forces will no longer have access to this Credential when attempting to resolve issues. @@ -8026,7 +8026,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: View Managed SSH Key + summary: Managed SSH Key View description: > Returns the unique SSH public key assigned to your Linode account's Managed service. If you [add this public key](https://linode.com/docs/platform/linode-managed/#adding-the-public-key) to a Linode on your account, @@ -8075,7 +8075,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Managed - summary: List Managed Issues + summary: Managed Issues List description: > Returns a paginated list of recent and ongoing issues detected on your Managed Services. @@ -8127,7 +8127,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: View Managed Issue + summary: Managed Issue View description: > Returns a single Issue that is impacting or did impact one of your Managed Services. @@ -8163,7 +8163,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Managed - summary: List Managed Linode Settings + summary: Managed Linode Settings List description: > Returns a paginated list of Managed Settings for your Linodes. There will be one entry per Linode on your Account. @@ -8215,7 +8215,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: View Linode's Managed Settings + summary: Linode's Managed Settings View description: > Returns a single Linode's Managed settings. operationId: getManagedLinodeSetting @@ -8245,7 +8245,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: Update Linode's Managed Settings + summary: Linode's Managed Settings Update description: > Updates a single Linode's Managed settings. operationId: updateManagedLinodeSetting @@ -8298,7 +8298,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: List Managed Services + summary: Managed Services List description: > Returns a paginated list of Managed Services on your Account. These are the services Linode Managed is monitoring and will report and attempt @@ -8341,7 +8341,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: Create Managed Service + summary: Managed Service Create description: > Creates a Managed Service. Linode Managed will begin monitoring this service and reporting and attempting to resolve any Issues. @@ -8415,7 +8415,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: View Managed Service + summary: Managed Service View description: > Returns information about a single Managed Service on your Account. operationId: getManagedService @@ -8445,7 +8445,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: Update Managed Service + summary: Managed Service Update description: > Updates information about a Managed Service. operationId: updateManagedService @@ -8503,7 +8503,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: Delete Managed Service + summary: Managed Service Delete description: > Deletes a Managed Service. This service will no longer be monitored by Linode Managed. @@ -8544,7 +8544,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: Disable Managed Service + summary: Managed Service Disable description: > Temporarily disables monitoring of a Managed Service. operationId: disableManagedService @@ -8585,7 +8585,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: Enable Managed Service + summary: Managed Service Enable description: > Enables monitoring of a Managed Service. operationId: enableManagedService @@ -8621,7 +8621,7 @@ paths: x-linode-grant: unrestricted only tags: - Managed - summary: List Managed Stats + summary: Managed Stats List description: | Returns a list of Managed Stats on your Account in the form of x and y data points. You can use these data points to plot your own graph visualizations. These stats @@ -8675,7 +8675,7 @@ paths: x-linode-grant: read_only tags: - Networking - summary: List IP Addresses + summary: IP Addresses List description: > Returns a paginated list of IP Addresses on your Account, excluding private addresses. @@ -8717,7 +8717,7 @@ paths: x-linode-grant: read_write tags: - Networking - summary: Allocate IP Address + summary: IP Address Allocate description: > Allocates a new IPv4 Address on your Account. The Linode must be configured to support additional addresses - please @@ -8800,7 +8800,7 @@ paths: x-linode-grant: read_only tags: - Networking - summary: View IP Address + summary: IP Address View description: > Returns information about a single IP Address on your Account. operationId: getIP @@ -8830,7 +8830,7 @@ paths: x-linode-grant: read_write tags: - Networking - summary: Update IP Address RDNS + summary: IP Address RDNS Update description: > Sets RDNS on an IP Address. Forward DNS must already be set up for reverse DNS to be applied. If you set the RDNS to `null` for public @@ -8883,7 +8883,7 @@ paths: x-linode-grant: read_write tags: - Networking - summary: Assign IPs to Linodes + summary: Linodes Assign IPs description: > Assign multiple IPs to multiple Linodes in one Region. This allows swapping, shuffling, or otherwise reorganizing IPv4 Addresses to your @@ -8984,7 +8984,7 @@ paths: x-linode-grant: read_write tags: - Networking - summary: Configure IP Sharing + summary: IP Sharing Configure description: > Configure shared IPs. A shared IP may be brought up on a Linode other than the one it lists in its response. This can be used to allow one @@ -9058,7 +9058,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Networking - summary: List IPv6 Pools + summary: IPv6 Pools List description: > Displays the IPv6 pools on your Account. A pool of IPv6 addresses are routed to all of your Linodes in a single [Region](https://developers.linode.com/api/v4/regions). Any Linode on your Account may bring up any address in this @@ -9105,7 +9105,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Networking - summary: List IPv6 Ranges + summary: IPv6 Ranges List description: > Displays the IPv6 ranges on your Account. @@ -9160,7 +9160,7 @@ paths: - url: https://api.linode.com/v4beta tags: - Networking - summary: List Firewalls + summary: Firewalls List description: | Returns a paginated list of your Firewalls. @@ -9213,7 +9213,7 @@ paths: - url: https://api.linode.com/v4beta tags: - Networking - summary: Create Firewall + summary: Firewall Create description: | Creates a Firewall to filter network traffic. Use the `rules` property to create inbound and outbound access rules. Use the `devices` property to assign the @@ -9361,7 +9361,7 @@ paths: - url: https://api.linode.com/v4beta tags: - Networking - summary: View Firewall + summary: Firewall View operationId: getFirewall x-linode-cli-action: view security: @@ -9407,7 +9407,7 @@ paths: - url: https://api.linode.com/v4beta tags: - Networking - summary: Update Firewall + summary: Firewall Update description: | Updates information for a Firewall. Some parts of a Firewall's configuration cannot be manipulated by this endpoint: @@ -9485,7 +9485,7 @@ paths: - url: https://api.linode.com/v4beta tags: - Networking - summary: Delete Firewall + summary: Firewall Delete operationId: deleteFirewall x-linode-cli-action: delete security: @@ -9545,7 +9545,7 @@ paths: parameters: - $ref: '#/components/parameters/pageOffset' - $ref: '#/components/parameters/pageSize' - summary: List Firewall Devices + summary: Firewall Devices List description: | Returns a paginated list of a Firewall's Devices. A Firewall Device assigns a Firewall to a Linode service (referred to as the Device's `entity`). Currently, @@ -9600,7 +9600,7 @@ paths: - url: https://api.linode.com/v4beta tags: - Networking - summary: Create Firewall Device + summary: Firewall Device Create description: | Creates a Firewall Device, which assigns a Firewall to a Linode service (referred to as the Device's `entity`). Currently, only Devices with an entity of type `linode` are accepted. @@ -9688,7 +9688,7 @@ paths: - url: https://api.linode.com/v4beta tags: - Networking - summary: View Firewall Device + summary: Firewall Device View description: | Returns information for a Firewall Device, which assigns a Firewall to a Linode service (referred to as the Device's `entity`). Currently, @@ -9733,7 +9733,7 @@ paths: - url: https://api.linode.com/v4beta tags: - Networking - summary: Delete Firewall Device + summary: Firewall Device Delete operationId: deleteFirewallDevice x-linode-cli-action: device-delete security: @@ -9792,7 +9792,7 @@ paths: - url: https://api.linode.com/v4beta tags: - Networking - summary: List Firewall Rules + summary: Firewall Rules List description: | Returns the inbound and outbound Rules for a Firewall. @@ -9834,7 +9834,7 @@ paths: - url: https://api.linode.com/v4beta tags: - Networking - summary: Update Firewall Rules + summary: Firewall Rules Update description: | Updates the inbound and outbound Rules for a Firewall. Using this endpoint will replace all of a Firewall's ruleset with the Rules specified in your request. @@ -9921,7 +9921,7 @@ paths: parameters: - $ref: '#/components/parameters/pageOffset' - $ref: '#/components/parameters/pageSize' - summary: List NodeBalancers + summary: NodeBalancers List description: > Returns a paginated list of NodeBalancers you have access to. operationId: getNodeBalancers @@ -9962,7 +9962,7 @@ paths: x-linode-grant: add_nodebalancers tags: - NodeBalancers - summary: Create NodeBalancer + summary: NodeBalancer Create description: > Creates a NodeBalancer in the requested Region. This NodeBalancer will not start serving requests until it is configured. @@ -10047,7 +10047,7 @@ paths: x-linode-grant: read_only tags: - NodeBalancers - summary: View NodeBalancer + summary: NodeBalancer View description: > Returns a single NodeBalancer you can access. operationId: getNodeBalancer @@ -10077,7 +10077,7 @@ paths: x-linode-grant: read_write tags: - NodeBalancers - summary: Update NodeBalancer + summary: NodeBalancer Update description: > Updates information about a NodeBalancer you can access. operationId: updateNodeBalancer @@ -10121,7 +10121,7 @@ paths: x-linode-grant: read_write tags: - NodeBalancers - summary: Delete NodeBalancer + summary: NodeBalancer Delete description: > Deletes a NodeBalancer. @@ -10173,7 +10173,7 @@ paths: parameters: - $ref: '#/components/parameters/pageOffset' - $ref: '#/components/parameters/pageSize' - summary: List Configs + summary: Configs List description: > Returns a paginated list of NodeBalancer Configs associated with this NodeBalancer. NodeBalancer Configs represent @@ -10221,7 +10221,7 @@ paths: x-linode-grant: read_write tags: - NodeBalancers - summary: Create Config + summary: Config Create description: > Creates a NodeBalancer Config, which allows the NodeBalancer to accept traffic on a new port. You will need to add NodeBalancer Nodes @@ -10303,7 +10303,7 @@ paths: x-linode-grant: read_only tags: - NodeBalancers - summary: View Config + summary: Config View description: > Returns configuration information for a single port of this NodeBalancer. @@ -10335,7 +10335,7 @@ paths: x-linode-grant: read_write tags: - NodeBalancers - summary: Update Config + summary: Config Update description: > Updates the configuration for a single port on a NodeBalancer. operationId: updateNodeBalancerConfig @@ -10402,7 +10402,7 @@ paths: x-linode-grant: read_write tags: - NodeBalancers - summary: Delete Config + summary: Config Delete description: > Deletes the Config for a port of this NodeBalancer. @@ -10458,7 +10458,7 @@ paths: x-linode-grant: add_nodebalancers tags: - NodeBalancers - summary: Rebuild Config + summary: Config Rebuild description: > Rebuilds a NodeBalancer Config and its Nodes that you have permission to modify. @@ -10586,7 +10586,7 @@ paths: parameters: - $ref: '#/components/parameters/pageOffset' - $ref: '#/components/parameters/pageSize' - summary: List Nodes + summary: Nodes List description: > Returns a paginated list of NodeBalancer nodes associated with this Config. These are the backends that will be sent traffic @@ -10629,7 +10629,7 @@ paths: x-linode-grant: read_write tags: - NodeBalancers - summary: Create Node + summary: Node Create description: > Creates a NodeBalancer Node, a backend that can accept traffic for this NodeBalancer Config. Nodes are routed @@ -10705,7 +10705,7 @@ paths: x-linode-grant: read_only tags: - NodeBalancers - summary: View Node + summary: Node View description: > Returns information about a single Node, a backend for this NodeBalancer's configured port. @@ -10736,7 +10736,7 @@ paths: x-linode-grant: read_write tags: - NodeBalancers - summary: Update Node + summary: Node Update description: > Updates information about a Node, a backend for this NodeBalancer's configured port. @@ -10786,7 +10786,7 @@ paths: x-linode-grant: read_write tags: - NodeBalancers - summary: Delete Node + summary: Node Delete description: > Deletes a Node from this Config. This backend will no longer receive traffic for the configured port of this NodeBalancer. @@ -10832,7 +10832,7 @@ paths: x-linode-grant: read_only tags: - NodeBalancers - summary: View NodeBalancer Statistics + summary: NodeBalancer Statistics View description: > Returns detailed statistics about the requested NodeBalancer. x-linode-cli-action: stats @@ -10856,7 +10856,7 @@ paths: x-linode-cli-skip: true servers: - url: https://api.linode.com/v4 - summary: List Object Storage Buckets + summary: Object Storage Buckets List description: | Returns a paginated list of all Object Storage Buckets that you own. @@ -10899,7 +10899,7 @@ paths: x-linode-cli-skip: true servers: - url: https://api.linode.com/v4 - summary: Create Object Storage Bucket + summary: Object Storage Bucket Create description: | Creates an Object Storage Bucket in the cluster specified. If the bucket already exists and is owned by you, this endpoint will return a @@ -11001,7 +11001,7 @@ paths: x-linode-cli-skip: true servers: - url: https://api.linode.com/v4 - summary: View Object Storage Bucket + summary: Object Storage Bucket View description: | Returns a single Object Storage Bucket. @@ -11033,7 +11033,7 @@ paths: x-linode-cli-skip: true servers: - url: https://api.linode.com/v4 - summary: Remove Object Storage Bucket + summary: Object Storage Bucket Remove description: > Removes a single bucket. While buckets containing objects _may_ be deleted by including the `force` option in the request, such operations @@ -11078,7 +11078,7 @@ paths: x-linode-cli-skip: true servers: - url: https://api.linode.com/v4 - summary: List Object Storage Buckets in Cluster + summary: Object Storage Buckets in Cluster List description: | Returns a list of Buckets in this cluster belonging to this Account. @@ -11135,7 +11135,7 @@ paths: x-linode-cli-skip: true servers: - url: https://api.linode.com/v4 - summary: Modify Object Storage Bucket Access + summary: Object Storage Bucket Access Modify description: | Allows changing basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings. Only allows enabling/disabling CORS for all origins, and/or setting canned ACLs. @@ -11211,7 +11211,7 @@ paths: x-linode-cli-skip: true servers: - url: https://api.linode.com/v4 - summary: List Object Storage Bucket Contents + summary: Object Storage Bucket Contents List description: | Returns the contents of a bucket. The contents are paginated using a `marker`, which is the name of the last object on the previous page. Objects may @@ -11297,7 +11297,7 @@ paths: x-linode-cli-skip: true servers: - url: https://api.linode.com/v4 - summary: Create Object Storage Object URL + summary: Object Storage Object URL Create description: | Creates a pre-signed URL to access a single Object in a bucket. This can be used to share objects, and also to create/delete objects by using @@ -11383,7 +11383,7 @@ paths: x-linode-cli-action: clusters-list servers: - url: https://api.linode.com/v4 - summary: List Clusters + summary: Clusters List description: | Returns a paginated list of Object Storage Clusters that are available for use. Users can connect to the clusters with third party clients to create buckets @@ -11432,7 +11432,7 @@ paths: x-linode-cli-action: clusters-view servers: - url: https://api.linode.com/v4 - summary: View Cluster + summary: Cluster View description: | Returns a single Object Storage Cluster. tags: @@ -11463,7 +11463,7 @@ paths: - url: https://api.linode.com/v4 tags: - Object Storage - summary: List Object Storage Keys + summary: Object Storage Keys List description: | Returns a paginated list of Object Storage Keys for authenticating to the Object Storage S3 API. @@ -11504,7 +11504,7 @@ paths: x-linode-cli-action: keys-create servers: - url: https://api.linode.com/v4 - summary: Create an Object Storage Key + summary: Object Storage Key Create description: | Provisions a new Object Storage Key on your account. tags: @@ -11569,7 +11569,7 @@ paths: x-linode-cli-action: keys-view servers: - url: https://api.linode.com/v4 - summary: View Object Storage Key + summary: Object Storage Key View description: | Returns a single Object Storage Key provisioned for your account. security: @@ -11601,7 +11601,7 @@ paths: x-linode-cli-action: keys-update servers: - url: https://api.linode.com/v4 - summary: Update an Object Storage Key + summary: Object Storage Key Update description: | Updates an Object Storage Key on your account. security: @@ -11649,7 +11649,7 @@ paths: x-linode-cli-action: keys-delete servers: - url: https://api.linode.com/v4 - summary: Revoke Object Storage Key + summary: Object Storage Key Revoke description: | Revokes an Object Storage Key. This keypair will no longer be usable by third-party clients. security: @@ -11683,7 +11683,7 @@ paths: x-linode-cli-action: cancel servers: - url: https://api.linode.com/v4 - summary: Cancel Object Storage + summary: Object Storage Cancel description: | Cancel Object Storage on an Account. All buckets on the Account must be empty before Object Storage can be cancelled: @@ -11855,7 +11855,7 @@ paths: get: tags: - Profile - summary: View Profile + summary: Profile View description: > Returns information about the current User. This can be used to see who is acting in applications where more than one token is managed. For @@ -11888,7 +11888,7 @@ paths: put: tags: - Profile - summary: Update Profile + summary: Profile Update description: > Update information in your Profile. This endpoint requires the "account:read_write" OAuth Scope. @@ -11948,7 +11948,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Profile - summary: List Authorized Apps + summary: Authorized Apps List description: > This is a collection of OAuth apps that you've given access to your Account, and includes the level of access granted. @@ -11999,7 +11999,7 @@ paths: get: tags: - Profile - summary: View Authorized App + summary: Authorized App View description: > Returns information about a single app you've authorized to access your Account. @@ -12029,7 +12029,7 @@ paths: delete: tags: - Profile - summary: Revoke App Access + summary: App Access Revoke description: > Expires this app token. This token may no longer be used to access your Account. @@ -12062,7 +12062,7 @@ paths: get: tags: - Profile - summary: List Grants + summary: Grants List description: > This returns a GrantsResponse describing what the acting User has been granted access to. For unrestricted users, this will return a 204 and @@ -12106,7 +12106,7 @@ paths: post: tags: - Profile - summary: Disable Two Factor Authentication + summary: Two Factor Authentication Disable description: > Disables Two Factor Authentication for your User. Once successful, login attempts from untrusted computers will only require a password @@ -12141,7 +12141,7 @@ paths: post: tags: - Profile - summary: Create Two Factor Secret + summary: Two Factor Secret Create description: > Generates a Two Factor secret for your User. TFA will not be enabled until you have successfully confirmed the code you @@ -12191,7 +12191,7 @@ paths: post: tags: - Profile - summary: Confirm/Enable Two Factor Authentication + summary: Two Factor Authentication Confirm/Enable description: > Confirms that you can successfully generate Two Factor codes and enables TFA on your Account. Once this is complete, login attempts @@ -12252,7 +12252,7 @@ paths: get: tags: - Profile - summary: List Personal Access Tokens + summary: Personal Access Tokens List description: > Returns a paginated list of Personal Access Tokens currently active for your User. @@ -12293,7 +12293,7 @@ paths: post: tags: - Profile - summary: Create Personal Access Token + summary: Personal Access Token Create description: > Creates a Personal Access Token for your User. The raw token will be returned in the response, but will never be returned again afterward @@ -12370,7 +12370,7 @@ paths: get: tags: - Profile - summary: View Personal Access Token + summary: Personal Access Token View description: > Returns a single Personal Access Token. operationId: getPersonalAccessToken @@ -12399,7 +12399,7 @@ paths: put: tags: - Profile - summary: Update Personal Access Token + summary: Personal Access Token Update description: > Updates a Personal Access Token. operationId: updatePersonalAccessToken @@ -12440,7 +12440,7 @@ paths: delete: tags: - Profile - summary: Revoke Personal Access Token + summary: Personal Access Token Revoke description: > Revokes a Personal Access Token. The token will be invalidated immediately, and requests using that token will fail with a 401. It is @@ -12479,7 +12479,7 @@ paths: get: tags: - Profile - summary: List Logins + summary: Logins List description: > Returns a collection of successful account logins from this user during the last 90 days. @@ -12528,7 +12528,7 @@ paths: get: tags: - Profile - summary: View Login + summary: Login View description: > Returns a login object displaying information about a successful account login from this user. @@ -12562,7 +12562,7 @@ paths: get: tags: - Profile - summary: List Trusted Devices + summary: Trusted Devices List description: > Returns a paginated list of active TrustedDevices for your User. Browsers with an active Remember Me Session are logged into your account @@ -12616,7 +12616,7 @@ paths: get: tags: - Profile - summary: View Trusted Device + summary: Trusted Device View description: > Returns a single active TrustedDevice for your User. operationId: getTrustedDevice @@ -12646,7 +12646,7 @@ paths: delete: tags: - Profile - summary: Revoke Trusted Device + summary: Trusted Device Revoke description: > Revoke an active TrustedDevice for your User. Once a TrustedDevice is revoked, this device will have to log in again before accessing your Linode account. @@ -12686,7 +12686,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Profile - summary: List SSH Keys + summary: SSH Keys List description: > Returns a collection of SSH Keys you've added to your Profile. operationId: getSSHKeys @@ -12727,7 +12727,7 @@ paths: post: tags: - Profile - summary: Add SSH Key + summary: SSH Key Add description: > Adds an SSH Key to your Account profile. operationId: addSSHKey @@ -12778,7 +12778,7 @@ paths: get: tags: - Profile - summary: View SSH Key + summary: SSH Key View description: > Returns a single SSH Key object identified by `id` that you have access to view. @@ -12808,7 +12808,7 @@ paths: put: tags: - Profile - summary: Update SSH Key + summary: SSH Key Update description: > Updates an SSH Key that you have permission to `read_write`. operationId: updateSSHKey @@ -12850,7 +12850,7 @@ paths: delete: tags: - Profile - summary: Delete SSH Key + summary: SSH Key Delete description: > Deletes an SSH Key you have access to. @@ -12890,7 +12890,7 @@ paths: x-linode-grant: read_only tags: - Profile - summary: View User Preferences + summary: User Preferences View description: | View a list of user preferences tied to the OAuth client that generated the token making the request. The user preferences endpoints allow @@ -12926,7 +12926,7 @@ paths: put: tags: - Profile - summary: Update User Preferences + summary: User Preferences Update description: > Updates a user's preferences. These preferences are tied to the OAuth client that generated the token making the request. The user @@ -12979,7 +12979,7 @@ paths: get: tags: - Regions - summary: List Regions + summary: Regions List description: | Lists the Regions available for Linode services. Not all services are guaranteed to be available in all Regions. @@ -13025,7 +13025,7 @@ paths: get: tags: - Regions - summary: View Region + summary: Region View description: > Returns a single Region. operationId: getRegion @@ -13055,7 +13055,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Support - summary: List Support Tickets + summary: Support Tickets List description: > Returns a collection of Support Tickets on your Account. Support Tickets can be both tickets you open with Linode @@ -13102,7 +13102,7 @@ paths: x-linode-grant: read_write tags: - Support - summary: Open Support Ticket + summary: Support Ticket Open description: > Open a Support Ticket. @@ -13159,7 +13159,7 @@ paths: x-linode-grant: read_only tags: - Support - summary: View Support Ticket + summary: Support Ticket View description: > Returns a Support Ticket under your Account. operationId: getTicket @@ -13198,7 +13198,7 @@ paths: x-linode-grant: read_write tags: - Support - summary: Create Ticket Attachment + summary: Ticket Attachment Create description: > Adds a file attachment to an existing Support Ticket on your Account. File attachments are used to assist our @@ -13258,7 +13258,7 @@ paths: x-linode-grant: read_write tags: - Support - summary: Close Support Ticket + summary: Support Ticket Close description: > Closes a Support Ticket you have access to modify. operationId: closeTicket @@ -13301,7 +13301,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Support - summary: List Replies + summary: Replies List description: > Returns a collection of replies to a Support Ticket on your Account. @@ -13343,7 +13343,7 @@ paths: x-linode-grant: read_write tags: - Support - summary: Create Reply + summary: Reply Create description: > Adds a reply to an existing Support Ticket. operationId: createTicketReply @@ -13402,7 +13402,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Tags - summary: List Tags + summary: Tags List description: > Tags are User-defined labels attached to objects in your Account, such as Linodes. They are used for specifying and grouping attributes of @@ -13444,7 +13444,7 @@ paths: post: tags: - Tags - summary: Create New Tag + summary: New Tag Create description: > Creates a new Tag and optionally tags requested objects with it immediately. @@ -13556,7 +13556,7 @@ paths: type: string required: true get: - summary: List Tagged Objects + summary: Tagged Objects List description: > Returns a paginated list of all objects you've tagged with the requested Tag. This is a mixed collection of all object types. @@ -13615,7 +13615,7 @@ paths: curl -H "Authorization: Bearer $TOKEN" \ "https://api.linode.com/v4/tags/example tag" delete: - summary: Delete a Tag + summary: Tag Delete description: > Remove a Tag from all objects and delete it. @@ -13646,7 +13646,7 @@ paths: parameters: - $ref: '#/components/parameters/pageOffset' - $ref: '#/components/parameters/pageSize' - summary: List Volumes + summary: Volumes List description: > Returns a paginated list of Volumes you have permission to view. tags: @@ -13688,7 +13688,7 @@ paths: post: x-linode-charge: true x-linode-grant: add_volumes - summary: Create Volume + summary: Volume Create description: > Creates a Volume on your Account. In order for this to complete successfully, your User must have the `add_volumes` @@ -13809,7 +13809,7 @@ paths: - $ref: '#/components/parameters/pageSize' tags: - Volumes - summary: View Volume + summary: Volume View description: > Get information about a single Volume. operationId: getVolume @@ -13848,7 +13848,7 @@ paths: x-linode-grant: read_write tags: - Volumes - summary: Update Volume + summary: Volume Update description: > Updates a Volume that you have permission to `read_write`. operationId: updateVolume @@ -13899,7 +13899,7 @@ paths: x-linode-grant: read_write tags: - Volumes - summary: Delete Volume + summary: Volume Delete description: | Deletes a Volume you have permission to `read_write`. @@ -13942,7 +13942,7 @@ paths: type: integer x-linode-cli-command: volumes post: - summary: Attach Volume + summary: Volume Attach description: > Attaches a Volume on your Account to an existing Linode on your Account. In order for this request to @@ -14025,7 +14025,7 @@ paths: post: x-linode-charge: true x-linode-grant: add_volumes - summary: Clone Volume + summary: Volume Clone description: > Creates a Volume on your Account. In order for this request to complete successfully, your User must have the @@ -14084,7 +14084,7 @@ paths: type: integer x-linode-cli-command: volumes post: - summary: Detach Volume + summary: Volume Detach description: > Detaches a Volume on your Account from a Linode on your Account. In order for this request to @@ -14129,7 +14129,7 @@ paths: x-linode-cli-command: volumes post: x-linode-charge: true - summary: Resize Volume + summary: Volume Resize description: > Resize an existing Volume on your Account. In order for this request to complete successfully, your User must have the From f0dd0cd425b4a3e0f1b19e60b232d94cc51916ff Mon Sep 17 00:00:00 2001 From: hzoppetti Date: Mon, 28 Sep 2020 15:57:48 -0400 Subject: [PATCH 2/8] added new obj storage cert endpoints --- openapi.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 40a05e6fd..302171123 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -11737,7 +11737,7 @@ paths: x-linode-cli-action: ssl-view servers: - url: https://api.linode.com/v4 - summary: View Object Storage TLS/SSL Cert + summary: Object Storage TLS/SSL Cert View description: | Returns a boolean value indicating if this bucket has a corresponding TLS/SSL certificate that was uploaded by an Account user. @@ -11772,7 +11772,7 @@ paths: x-linode-cli-action: ssl-upload servers: - url: https://api.linode.com/v4 - summary: Upload Object Storage TLS/SSL Cert + summary: Object Storage TLS/SSL Cert Upload description: | Upload a TLS/SSL certificate and private key to be served when you visit your Object Storage bucket via HTTPS. Your TLS/SSL certificate and private key are stored encrypted at rest. @@ -11822,7 +11822,7 @@ paths: x-linode-cli-action: ssl-delete servers: - url: https://api.linode.com/v4 - summary: Delete Object Storage TLS/SSL Cert + summary: Object Storage TLS/SSL Cert Delete description: | Deletes this Object Storage bucket's user uploaded TLS/SSL certificate and private key. tags: From 7ba86b866bf0583ee5ac64dd4b8cec03be9768d3 Mon Sep 17 00:00:00 2001 From: hzoppetti Date: Tue, 29 Sep 2020 10:26:09 -0400 Subject: [PATCH 3/8] added deprecated field for Kernel schema object --- openapi.yaml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/openapi.yaml b/openapi.yaml index 88bc3474f..19ef8b339 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -16572,6 +16572,13 @@ components: description: If this Kernel is suitable for paravirtualized operations. example: false readOnly: true + deprecated: + x-linode-filterable: true + type: boolean + description: If this Kernel is marked as deprecated, this field has a value of true; + otherwise, this field is false. + example: false + readOnly: true Linode: type: object allOf: From 0389a0de6120fb416fb801b02bc783f68332dc66 Mon Sep 17 00:00:00 2001 From: hzoppetti Date: Tue, 29 Sep 2020 13:25:03 -0400 Subject: [PATCH 4/8] added message to event object --- openapi.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/openapi.yaml b/openapi.yaml index 88bc3474f..89b03ee7a 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -15509,6 +15509,14 @@ components: The username of the User who caused the Event. example: exampleUser x-linode-cli-display: 2 + message: + type: string + nullable: true + description: > + Provides additional information about the event. Additional + information may include, but is not limited to, a more detailed + representation of events which can help diagnose non-obvious failures. + example: None Firewall: type: object description: > From ea1d5232dbcdd9990798c706dc9fdd9a9e1a3603 Mon Sep 17 00:00:00 2001 From: hzoppetti Date: Thu, 1 Oct 2020 12:25:07 -0400 Subject: [PATCH 5/8] addded note to bucket_access field in object storage scheema and updated desc of create obj store key --- openapi.yaml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/openapi.yaml b/openapi.yaml index 88bc3474f..055588b24 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -11507,6 +11507,15 @@ paths: summary: Create an Object Storage Key description: | Provisions a new Object Storage Key on your account. + + * To create a Limited Access Key with specific permissions, send a `bucket_access` + array. + + * To create a Limited Access Key without access to any buckets, send an empty + `bucket_access` array. + + * To create an Access Key with unlimited access to all clusters and all buckets, + omit the `bucket_access` array. tags: - Object Storage security: @@ -18953,6 +18962,9 @@ components: **Note:** You can create an Object Storage Limited Access Key without access to any buckets. This is achieved by sending a request with an empty `bucket_access` array. + + + **Note:** If this field is ommited, a regular unlimited access key is issued. items: type: object properties: From c0d606a7487d6d4d3b426f63543441bdb76f43b7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Thu, 1 Oct 2020 18:27:00 +0200 Subject: [PATCH 6/8] Update go.mod --- go.mod | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/go.mod b/go.mod index ff864cf81..8cc0c04a0 100644 --- a/go.mod +++ b/go.mod @@ -1,3 +1,3 @@ -module github.com/linode/linode-api-docs +module github.com/linode/linode-api-docs/v4 go 1.15 From 887e257a0ba6af4edf475774d485ee76bcbcf273 Mon Sep 17 00:00:00 2001 From: hzoppetti Date: Fri, 2 Oct 2020 09:33:33 -0400 Subject: [PATCH 7/8] spelling fix --- openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi.yaml b/openapi.yaml index 055588b24..77ebb49e7 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -18964,7 +18964,7 @@ components: This is achieved by sending a request with an empty `bucket_access` array. - **Note:** If this field is ommited, a regular unlimited access key is issued. + **Note:** If this field is omitted, a regular unlimited access key is issued. items: type: object properties: From 5eeedbcca6142c64e94a509678b1d3ce5bd30f3c Mon Sep 17 00:00:00 2001 From: hzoppetti Date: Mon, 5 Oct 2020 13:36:06 -0400 Subject: [PATCH 8/8] Bump version to 4.77.0 --- openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi.yaml b/openapi.yaml index fd68d8588..f078bb23a 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - version: 4.76.1 + version: 4.77.0 title: Linode API description: |