Skip to content

Release 4.129.0 #657

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Jun 24, 2022
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
337 changes: 329 additions & 8 deletions openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
openapi: 3.0.1
info:
version: 4.128.0
version: 4.129.0

title: Linode API
description: |
Expand Down Expand Up @@ -2631,7 +2631,7 @@ paths:
email address. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. See
our [Linode Managed guide](/docs/platform/linode-managed/)
to learn more.
operationId: enableAccountManged
operationId: enableAccountManaged
x-linode-cli-action: enable-managed
security:
- personalAccessToken: []
Expand Down Expand Up @@ -16730,12 +16730,12 @@ paths:
tags:
- Profile
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
were given with [tfa-enable-confirm](/docs/api/profile/#two-factor-secret-create) (see below).
Once enabled, logins from untrusted computers will be required to provide
description: |
Generates a Two Factor secret for your User. To enable TFA for your User, enter the secret obtained from this command with the **Two Factor Authentication Confirm/Enable** ([POST /profile/tfa-enable-confirm](/docs/api/profile/#two-factor-authentication-confirmenable)) command.
Once enabled, logins from untrusted computers are required to provide
a TFA code before they are successful.

**Note**: Before you can enable TFA, security questions must be answered for your User by accessing the **Security Questions Answer** ([POST /profile/security-questions](/docs/api/profile/#security-questions-answer)) command.
operationId: tfaEnable
x-linode-cli-action: tfa-enable
security:
Expand Down Expand Up @@ -17256,6 +17256,107 @@ paths:
- lang: CLI
source: >
linode-cli profile device-revoke 123
/profile/security-questions:
x-linode-cli-command: security-questions
get:
x-linode-grant: read_only
servers:
- url: https://api.linode.com/v4
tags:
- Profile
summary: Security Questions List
description: >
Returns a collection of security questions and their responses, if any, for your User Profile.
operationId: getSecurityQuestions
x-linode-cli-action: list
security:
- personalAccessToken: []
- oauth:
- account:read_only
responses:
'200':
description: Returns a list of security questions.
content:
application/json:
x-linode-cli-nested-list: security_questions
x-linode-cli-use-schema:
type: object
properties:
security_questions.id:
x-linode-cli-display: 1
security_questions.question:
x-linode-cli-display: 2
security_questions.response:
x-linode-cli-display: 3
schema:
$ref: '#/components/schemas/SecurityQuestionsGet'
default:
$ref: '#/components/responses/ErrorResponse'
x-code-samples:
- lang: Shell
source: >
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/profile/security-questions
- lang: CLI
source: >
linode-cli security-questions list
post:
tags:
- Profile
summary: Security Questions Answer
description: |
Adds security question responses for your User.

Requires exactly three unique questions.

Previous responses are overwritten if answered or reset to `null` if unanswered.

**Note**: Security questions must be answered for your User prior to accessing the **Two Factor Secret Create** ([POST /profile/tfa-enable](/docs/api/profile/#two-factor-secret-create)) command.
operationId: postSecurityQuestions
x-linode-cli-action: answer
x-linode-cli-skip: true
security:
- personalAccessToken: []
- oauth:
- account:read_write
requestBody:
description: Answer Security Questions
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityQuestionsPost'
responses:
'200':
description: Security Questions answered successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityQuestionsPost'
default:
$ref: '#/components/responses/ErrorResponse'
x-code-samples:
- lang: Shell
source: >
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X POST -d '{
"security_questions": [
{
"question_id": 1,
"response": "secret answer 1"
},
{
"question_id": 2,
"response": "secret answer 2"
},
{
"question_id": 11,
"response": "secret answer 3"
}
]
}' \
https://api.linode.com/v4/profile/security-questions
/profile/sshkeys:
x-linode-cli-command: sshkeys
get:
Expand Down Expand Up @@ -17463,6 +17564,165 @@ paths:
- lang: CLI
source: >
linode-cli sshkey delete 42
/profile/phone-number:
x-linode-cli-command: phone
delete:
x-linode-grant: read_write
tags:
- Profile
summary: Phone Number Delete
description: |
Delete the verified phone number for the User making this request.

Use this command to opt out of SMS messages for the requesting User after a phone number has been verified with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.
operationId: deleteProfilePhoneNumber
x-linode-cli-command: delete
security:
- personalAccessToken: []
- oauth:
- account:read_write
responses:
'200':
description: >
Phone number deletion request successful.
content:
application/json:
schema:
type: object
default:
$ref: '#/components/responses/ErrorResponse'
x-code-samples:
- lang: Shell
source: >
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN_BBIGGER_DEV" \
-X DELETE \
https://api.dev.linode.com/v4/profile/phone-number
- lang: CLI
source: >
linode-cli phone delete
post:
x-linode-grant: read_write
tags:
- Profile
summary: Phone Number Verification Code Send
description: |
Send a one-time verification code via SMS message to the submitted phone number. Providing your phone number helps ensure you can securely access your Account in case other ways to connect are lost. Your phone number is only used to verify your identity by sending an SMS message. Standard carrier messaging fees may apply.

* By accessing this command you are opting in to receive SMS messages. You can opt out of SMS messages by using the **Phone Number Delete** ([DELETE /profile/phone-number](/docs/api/profile/#phone-number-delete)) command after your phone number is verified.

* Verification codes are valid for 10 minutes after they are sent.

* Subsequent requests made prior to code expiration result in sending the same code.

Once a verification code is received, verify your phone number with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.
operationId: postProfilePhoneNumber
x-linode-cli-command: sms-code-send
security:
- personalAccessToken: []
- oauth:
- account:read_write
requestBody:
description: Enter a phone number and country code for verification.
content:
application/json:
schema:
required:
- iso_code
- phone_number
type: object
properties:
iso_code:
type: string
description: The two-letter ISO 3166 country code associated with the phone number.
example: US
phone_number:
type: string
description: A valid phone number.
format: phone
example: 555-555-5555
responses:
'200':
description: >
Phone number verification code request successful.
content:
application/json:
schema:
type: object
default:
$ref: '#/components/responses/ErrorResponse'
x-code-samples:
- lang: Shell
source: >
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN_BBIGGER_DEV" \
-X POST -d '{
"iso_code": "US",
"phone_number": "267-273-8229"
}' \
https://api.dev.linode.com/v4/profile/phone-number
- lang: CLI
source: >
linode-cli phone sms-code-send \
--iso-code US \
--phone-number 555-555-5555
/profile/phone-number/verify:
x-linode-cli-command: phone
post:
x-linode-grant: read_write
tags:
- Profile
summary: Phone Number Verify
description: |
Verify a phone number by confirming the one-time code received via SMS message after accessing the **Phone Verification Code Send** ([POST /profile/phone-number](/docs/api/profile/#phone-number-verification-code-send)) command.

* Verification codes are valid for 10 minutes after they are sent.

* Only the same User that made the verification code request can use that code with this command.

Once completed, the verified phone number is assigned to the User making the request. To change the verified phone number for a User, first use the **Phone Number Delete** ([DELETE /profile/phone-number](/docs/api/profile/#phone-number-delete)) command, then begin the verification process again with the **Phone Verification Code Send** ([POST /profile/phone-number](/docs/api/profile/#phone-number-verification-code-send)) command.
operationId: postProfilePhoneNumberVerify
x-linode-cli-command: verify
security:
- personalAccessToken: []
- oauth:
- account:read_write
requestBody:
description: Enter a phone verification code for confirmation.
content:
application/json:
schema:
required:
- otp_code
type: object
properties:
otp_code:
type: string
description: The one-time, six-digit code received via SMS message after accessing the **Phone Verification Code Send** ([POST /profile/phone-number](/docs/api/profile/#phone-number-verification-code-send)) command.
example: "US"
responses:
'200':
description: >
Phone number verification successful.
content:
application/json:
schema:
type: object
default:
$ref: '#/components/responses/ErrorResponse'
x-code-samples:
- lang: Shell
source: >
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X POST -d '{
"otp_code": "123456"
}' \
https://api.linode.com/v4/profile/phone-number/verify
- lang: CLI
source: >
linode-cli phone verify \
--otp_code 123456
/profile/preferences:
x-linode-cli-command: profile
get:
Expand Down Expand Up @@ -19484,7 +19744,7 @@ components:
type: integer
minimum: 1
maximum: 7
description: The day to perform maintenance. 1=Monday, 2=Tuesday, etc.
description: The day to perform maintenance. 1=Sunday, 2=Monday, etc.
example: 1
week_of_month:
type: integer
Expand Down Expand Up @@ -25058,6 +25318,15 @@ components:
as necessary.
example: [email protected]
x-linode-cli-display: 2
verified_phone_number:
type: string
format: phone
readOnly: true
description: |
The phone number verified for this Profile with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.

`null` if this Profile has no verified phone number.
example: "+5555555555"
timezone:
type: string
description: >
Expand Down Expand Up @@ -25992,6 +26261,58 @@ components:
The last IP Address to successfully authenticate with this TrustedDevice.
example: 12.34.56.78
readOnly: true
SecurityQuestion:
type: object
description: Single security question and response object.
properties:
id:
type: integer
description: The ID representing the security question.
example: 1
question:
type: string
readOnly: true
description: The security question.
example: "In what city were you born?"
response:
type: string
minLength: 3
maxLength: 17
description: |
The security question response.
example: "Gotham City"
SecurityQuestionsGet:
type: object
description: Security questions and responses object for GET operation.
properties:
security_questions:
type: array
items:
type: object
description: Single security question and response object for GET operation.
properties:
id:
$ref: '#/components/schemas/SecurityQuestion/properties/id'
question:
$ref: '#/components/schemas/SecurityQuestion/properties/question'
response:
$ref: '#/components/schemas/SecurityQuestion/properties/response'
SecurityQuestionsPost:
type: object
description: Security questions and responses object for POST operation.
properties:
security_questions:
type: array
items:
type: object
description: Single security question and response object for POST operation.
properties:
question_id:
$ref: '#/components/schemas/SecurityQuestion/properties/id'
response:
$ref: '#/components/schemas/SecurityQuestion/properties/response'
security_question:
$ref: '#/components/schemas/SecurityQuestion/properties/question'
ServiceTransfer:
type: object
description: >
Expand Down