Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 52 additions & 26 deletions openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
openapi: 3.0.1
info:
version: 4.158.1
version: 4.159.0

title: Linode API
description: |
Expand Down Expand Up @@ -566,7 +566,7 @@ paths:
example: "I'm consolidating multiple accounts into one."
responses:
'200':
description: Account cancelled
description: Account canceled
content:
application/json:
schema:
Expand All @@ -591,7 +591,7 @@ paths:
reason:
type: string
description: >
A string explaining that the account could not be cancelled
A string explaining that the account could not be canceled
because there is an outstanding balance on the account
that must be paid first.
example: >
Expand Down Expand Up @@ -811,7 +811,7 @@ paths:
responses:
'200':
description: >
Entity Transfer cancelled.
Entity Transfer canceled.
content:
application/json:
schema:
Expand Down Expand Up @@ -1268,7 +1268,7 @@ paths:
- Account
summary: Maintenance List
description: |
Returns a collection of Maintenance objects for any entity a user has permissions to view. Cancelled Maintenance objects are not returned.
Returns a collection of Maintenance objects for any entity a user has permissions to view. Canceled Maintenance objects are not returned.

Currently, Linodes are the only entities available for viewing.
operationId: getMaintenance
Expand Down Expand Up @@ -2431,7 +2431,7 @@ paths:

While a transfer is pending, any unrestricted user *of any account* can access this command. After a
transfer has been accepted, it can only be viewed by unrestricted users of the accounts that created and
accepted the transfer. If cancelled or expired, only unrestricted users of the account that created the
accepted the transfer. If canceled or expired, only unrestricted users of the account that created the
transfer can view it.
operationId: getServiceTransfer
x-linode-cli-action: view
Expand Down Expand Up @@ -2464,12 +2464,9 @@ paths:
- account
summary: Service Transfer Cancel
description: |
Cancels the Service Transfer for the provided token. Once cancelled, a transfer cannot be accepted or otherwise
acted on in any way. If cancelled in error, the transfer must be
[created](/docs/api/account/#service-transfer-create) again.
Cancels the Service Transfer for the provided token. Once canceled, a transfer cannot be accepted or otherwise acted on in any way. If canceled in error, the transfer must be [created](/docs/api/account/#service-transfer-create) again.

When cancelled, an email notification for the cancellation is sent to the account that created
this transfer. Transfers can not be cancelled if they are expired or have been accepted.
When canceled, an email notification for the cancellation is sent to the account that created this transfer. Transfers can not be canceled if they are expired or have been accepted.

This command can only be accessed by the unrestricted users of the account that created this transfer.
operationId: deleteServiceTransfer
Expand All @@ -2481,7 +2478,7 @@ paths:
responses:
'200':
description: >
Service Transfer cancelled.
Service Transfer canceled.
content:
application/json:
schema:
Expand Down Expand Up @@ -3786,7 +3783,7 @@ paths:

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.
The Database must have an `active`, `degraded`, or `failed` status to perform this command.

**Note**: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.

Expand Down Expand Up @@ -4542,7 +4539,7 @@ paths:

Requires `read_write` access to the Database.

The Database must have an `active` status to perform this command.
The Database must have an `active`, `degraded`, or `failed` status to perform this command.

**Note**: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.

Expand Down Expand Up @@ -5721,7 +5718,7 @@ paths:
with the URL to which image data can be uploaded.

- Image data must be uploaded within 24 hours of creation or the
upload will be cancelled and the image deleted.
upload will be canceled and the image deleted.

- Image uploads should be made as an HTTP PUT request to the URL returned in the `upload_to`
response parameter, with a `Content-type: application/octet-stream` header included in the
Expand Down Expand Up @@ -6508,7 +6505,7 @@ paths:
- linodes:read_write
responses:
'200':
description: Backup service was cancelled for the specified Linode.
description: Backup service was canceled for the specified Linode.
content:
application/json:
schema:
Expand Down Expand Up @@ -18990,6 +18987,7 @@ components:
The name of the application you've authorized.
example: example-app
readOnly: true
x-linode-filterable: true
x-linode-cli-display: 2
thumbnail_url:
type: string
Expand Down Expand Up @@ -19417,7 +19415,7 @@ components:
description: |
The label for the Database snapshot backup.

* Must include only ASCII letters or numbers.
* Must include only ASCII letters, numbers, or underscores.
* Must be unique among other backup labels for this Database.
example: db-snapshot
target:
Expand Down Expand Up @@ -20359,7 +20357,7 @@ components:
x-linode-filterable: true
x-linode-cli-color:
accepted: yellow
cancelled: red
canceled: red
completed: green
failed: red
pending: yellow
Expand All @@ -20368,7 +20366,7 @@ components:
type: string
enum:
- accepted
- cancelled
- canceled
- completed
- failed
- pending
Expand All @@ -20381,7 +20379,7 @@ components:
Transfers can take up to 3 hours to complete.


`cancelled`: The transfer has been cancelled by the sender.
`canceled`: The transfer has been canceled by the sender.


`completed`: The transfer has completed successfully.
Expand All @@ -20394,7 +20392,7 @@ components:


`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or
cancelled.
canceled.
example: 'pending'
created:
type: string
Expand Down Expand Up @@ -24891,7 +24889,7 @@ components:
properties:
cancel_url:
type: string
description: The URL to have PayPal redirect to when Payment is cancelled.
description: The URL to have PayPal redirect to when Payment is canceled.
example: https://example.org
redirect_url:
type: string
Expand Down Expand Up @@ -25880,6 +25878,7 @@ components:
A boolean value indicating if the User has Two Factor Authentication (TFA)
enabled. See the Create Two Factor Secret ([POST /profile/tfa-enable](/docs/api/profile/#two-factor-secret-create))
endpoint to enable TFA.
example: true
verified_phone_number:
type: string
format: phone
Expand All @@ -25902,6 +25901,33 @@ components:

`null` if this User has not created a password yet.
example: "2018-01-01T01:01:01"
last_login:
type: object
readOnly: true
nullable: true
description: |
Information for the most recent login attempt for this User.

`null` if no login attempts have been made since creation of this User.

Access the [User Logins List All](/docs/api/account/#user-logins-list-all) command for additional login information.
properties:
login_datetime:
type: string
format: date-time
readOnly: true
description: |
The date and time of this User's most recent login attempt.
example: "2018-01-01T01:01:01"
status:
type: string
readOnly: true
enum:
- successful
- failed
description: |
The result of the most recent login attempt for this User.
example: successful
UserDefinedField:
type: object
required:
Expand Down Expand Up @@ -26065,7 +26091,7 @@ components:
x-linode-filterable: true
x-linode-cli-color:
accepted: yellow
cancelled: red
canceled: red
completed: green
failed: red
pending: yellow
Expand All @@ -26074,7 +26100,7 @@ components:
type: string
enum:
- accepted
- cancelled
- canceled
- completed
- failed
- pending
Expand All @@ -26085,7 +26111,7 @@ components:
`accepted`: The transfer has been accepted by another user and is currently in progress.
Transfers can take up to 3 hours to complete.

`cancelled`: The transfer has been cancelled by the sender.
`canceled`: The transfer has been canceled by the sender.

`completed`: The transfer has completed successfully.

Expand All @@ -26094,7 +26120,7 @@ components:
`pending`: The transfer is ready to be accepted.

`stale`: The transfer has exceeded its expiration date. It can no longer be accepted or
cancelled.
canceled.
example: 'pending'
created:
type: string
Expand Down