Skip to content

Commit f148891

Browse files
bbiggerrbbiggerr
authored
Merge pull request #657 from linode/release-4.129.0
Release 4.129.0
2 parents 46b5e98 + 53315e8 commit f148891

File tree

1 file changed

+329
-8
lines changed

1 file changed

+329
-8
lines changed

‎openapi.yaml

Lines changed: 329 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: 3.0.1
22
info:
3-
version: 4.128.0
3+
version: 4.129.0
44

55
title: Linode API
66
description: |
@@ -2631,7 +2631,7 @@ paths:
26312631
email address. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. See
26322632
our [Linode Managed guide](/docs/platform/linode-managed/)
26332633
to learn more.
2634-
operationId: enableAccountManged
2634+
operationId: enableAccountManaged
26352635
x-linode-cli-action: enable-managed
26362636
security:
26372637
- personalAccessToken: []
@@ -16730,12 +16730,12 @@ paths:
1673016730
tags:
1673116731
- Profile
1673216732
summary: Two Factor Secret Create
16733-
description: >
16734-
Generates a Two Factor secret for your User. TFA will
16735-
not be enabled until you have successfully confirmed the code you
16736-
were given with [tfa-enable-confirm](/docs/api/profile/#two-factor-secret-create) (see below).
16737-
Once enabled, logins from untrusted computers will be required to provide
16733+
description: |
16734+
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.
16735+
Once enabled, logins from untrusted computers are required to provide
1673816736
a TFA code before they are successful.
16737+
16738+
**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.
1673916739
operationId: tfaEnable
1674016740
x-linode-cli-action: tfa-enable
1674116741
security:
@@ -17256,6 +17256,107 @@ paths:
1725617256
- lang: CLI
1725717257
source: >
1725817258
linode-cli profile device-revoke 123
17259+
/profile/security-questions:
17260+
x-linode-cli-command: security-questions
17261+
get:
17262+
x-linode-grant: read_only
17263+
servers:
17264+
- url: https://api.linode.com/v4
17265+
tags:
17266+
- Profile
17267+
summary: Security Questions List
17268+
description: >
17269+
Returns a collection of security questions and their responses, if any, for your User Profile.
17270+
operationId: getSecurityQuestions
17271+
x-linode-cli-action: list
17272+
security:
17273+
- personalAccessToken: []
17274+
- oauth:
17275+
- account:read_only
17276+
responses:
17277+
'200':
17278+
description: Returns a list of security questions.
17279+
content:
17280+
application/json:
17281+
x-linode-cli-nested-list: security_questions
17282+
x-linode-cli-use-schema:
17283+
type: object
17284+
properties:
17285+
security_questions.id:
17286+
x-linode-cli-display: 1
17287+
security_questions.question:
17288+
x-linode-cli-display: 2
17289+
security_questions.response:
17290+
x-linode-cli-display: 3
17291+
schema:
17292+
$ref: '#/components/schemas/SecurityQuestionsGet'
17293+
default:
17294+
$ref: '#/components/responses/ErrorResponse'
17295+
x-code-samples:
17296+
- lang: Shell
17297+
source: >
17298+
curl -H "Content-Type: application/json" \
17299+
-H "Authorization: Bearer $TOKEN" \
17300+
https://api.linode.com/v4/profile/security-questions
17301+
- lang: CLI
17302+
source: >
17303+
linode-cli security-questions list
17304+
post:
17305+
tags:
17306+
- Profile
17307+
summary: Security Questions Answer
17308+
description: |
17309+
Adds security question responses for your User.
17310+
17311+
Requires exactly three unique questions.
17312+
17313+
Previous responses are overwritten if answered or reset to `null` if unanswered.
17314+
17315+
**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.
17316+
operationId: postSecurityQuestions
17317+
x-linode-cli-action: answer
17318+
x-linode-cli-skip: true
17319+
security:
17320+
- personalAccessToken: []
17321+
- oauth:
17322+
- account:read_write
17323+
requestBody:
17324+
description: Answer Security Questions
17325+
content:
17326+
application/json:
17327+
schema:
17328+
$ref: '#/components/schemas/SecurityQuestionsPost'
17329+
responses:
17330+
'200':
17331+
description: Security Questions answered successfully.
17332+
content:
17333+
application/json:
17334+
schema:
17335+
$ref: '#/components/schemas/SecurityQuestionsPost'
17336+
default:
17337+
$ref: '#/components/responses/ErrorResponse'
17338+
x-code-samples:
17339+
- lang: Shell
17340+
source: >
17341+
curl -H "Content-Type: application/json" \
17342+
-H "Authorization: Bearer $TOKEN" \
17343+
-X POST -d '{
17344+
"security_questions": [
17345+
{
17346+
"question_id": 1,
17347+
"response": "secret answer 1"
17348+
},
17349+
{
17350+
"question_id": 2,
17351+
"response": "secret answer 2"
17352+
},
17353+
{
17354+
"question_id": 11,
17355+
"response": "secret answer 3"
17356+
}
17357+
]
17358+
}' \
17359+
https://api.linode.com/v4/profile/security-questions
1725917360
/profile/sshkeys:
1726017361
x-linode-cli-command: sshkeys
1726117362
get:
@@ -17463,6 +17564,165 @@ paths:
1746317564
- lang: CLI
1746417565
source: >
1746517566
linode-cli sshkey delete 42
17567+
/profile/phone-number:
17568+
x-linode-cli-command: phone
17569+
delete:
17570+
x-linode-grant: read_write
17571+
tags:
17572+
- Profile
17573+
summary: Phone Number Delete
17574+
description: |
17575+
Delete the verified phone number for the User making this request.
17576+
17577+
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.
17578+
operationId: deleteProfilePhoneNumber
17579+
x-linode-cli-command: delete
17580+
security:
17581+
- personalAccessToken: []
17582+
- oauth:
17583+
- account:read_write
17584+
responses:
17585+
'200':
17586+
description: >
17587+
Phone number deletion request successful.
17588+
content:
17589+
application/json:
17590+
schema:
17591+
type: object
17592+
default:
17593+
$ref: '#/components/responses/ErrorResponse'
17594+
x-code-samples:
17595+
- lang: Shell
17596+
source: >
17597+
curl -H "Content-Type: application/json" \
17598+
-H "Authorization: Bearer $TOKEN_BBIGGER_DEV" \
17599+
-X DELETE \
17600+
https://api.dev.linode.com/v4/profile/phone-number
17601+
- lang: CLI
17602+
source: >
17603+
linode-cli phone delete
17604+
post:
17605+
x-linode-grant: read_write
17606+
tags:
17607+
- Profile
17608+
summary: Phone Number Verification Code Send
17609+
description: |
17610+
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.
17611+
17612+
* 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.
17613+
17614+
* Verification codes are valid for 10 minutes after they are sent.
17615+
17616+
* Subsequent requests made prior to code expiration result in sending the same code.
17617+
17618+
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.
17619+
operationId: postProfilePhoneNumber
17620+
x-linode-cli-command: sms-code-send
17621+
security:
17622+
- personalAccessToken: []
17623+
- oauth:
17624+
- account:read_write
17625+
requestBody:
17626+
description: Enter a phone number and country code for verification.
17627+
content:
17628+
application/json:
17629+
schema:
17630+
required:
17631+
- iso_code
17632+
- phone_number
17633+
type: object
17634+
properties:
17635+
iso_code:
17636+
type: string
17637+
description: The two-letter ISO 3166 country code associated with the phone number.
17638+
example: US
17639+
phone_number:
17640+
type: string
17641+
description: A valid phone number.
17642+
format: phone
17643+
example: 555-555-5555
17644+
responses:
17645+
'200':
17646+
description: >
17647+
Phone number verification code request successful.
17648+
content:
17649+
application/json:
17650+
schema:
17651+
type: object
17652+
default:
17653+
$ref: '#/components/responses/ErrorResponse'
17654+
x-code-samples:
17655+
- lang: Shell
17656+
source: >
17657+
curl -H "Content-Type: application/json" \
17658+
-H "Authorization: Bearer $TOKEN_BBIGGER_DEV" \
17659+
-X POST -d '{
17660+
"iso_code": "US",
17661+
"phone_number": "267-273-8229"
17662+
}' \
17663+
https://api.dev.linode.com/v4/profile/phone-number
17664+
- lang: CLI
17665+
source: >
17666+
linode-cli phone sms-code-send \
17667+
--iso-code US \
17668+
--phone-number 555-555-5555
17669+
/profile/phone-number/verify:
17670+
x-linode-cli-command: phone
17671+
post:
17672+
x-linode-grant: read_write
17673+
tags:
17674+
- Profile
17675+
summary: Phone Number Verify
17676+
description: |
17677+
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.
17678+
17679+
* Verification codes are valid for 10 minutes after they are sent.
17680+
17681+
* Only the same User that made the verification code request can use that code with this command.
17682+
17683+
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.
17684+
operationId: postProfilePhoneNumberVerify
17685+
x-linode-cli-command: verify
17686+
security:
17687+
- personalAccessToken: []
17688+
- oauth:
17689+
- account:read_write
17690+
requestBody:
17691+
description: Enter a phone verification code for confirmation.
17692+
content:
17693+
application/json:
17694+
schema:
17695+
required:
17696+
- otp_code
17697+
type: object
17698+
properties:
17699+
otp_code:
17700+
type: string
17701+
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.
17702+
example: "US"
17703+
responses:
17704+
'200':
17705+
description: >
17706+
Phone number verification successful.
17707+
content:
17708+
application/json:
17709+
schema:
17710+
type: object
17711+
default:
17712+
$ref: '#/components/responses/ErrorResponse'
17713+
x-code-samples:
17714+
- lang: Shell
17715+
source: >
17716+
curl -H "Content-Type: application/json" \
17717+
-H "Authorization: Bearer $TOKEN" \
17718+
-X POST -d '{
17719+
"otp_code": "123456"
17720+
}' \
17721+
https://api.linode.com/v4/profile/phone-number/verify
17722+
- lang: CLI
17723+
source: >
17724+
linode-cli phone verify \
17725+
--otp_code 123456
1746617726
/profile/preferences:
1746717727
x-linode-cli-command: profile
1746817728
get:
@@ -19484,7 +19744,7 @@ components:
1948419744
type: integer
1948519745
minimum: 1
1948619746
maximum: 7
19487-
description: The day to perform maintenance. 1=Monday, 2=Tuesday, etc.
19747+
description: The day to perform maintenance. 1=Sunday, 2=Monday, etc.
1948819748
example: 1
1948919749
week_of_month:
1949019750
type: integer
@@ -25058,6 +25318,15 @@ components:
2505825318
as necessary.
2505925319
example: [email protected]
2506025320
x-linode-cli-display: 2
25321+
verified_phone_number:
25322+
type: string
25323+
format: phone
25324+
readOnly: true
25325+
description: |
25326+
The phone number verified for this Profile with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.
25327+
25328+
`null` if this Profile has no verified phone number.
25329+
example: "+5555555555"
2506125330
timezone:
2506225331
type: string
2506325332
description: >
@@ -25992,6 +26261,58 @@ components:
2599226261
The last IP Address to successfully authenticate with this TrustedDevice.
2599326262
example: 12.34.56.78
2599426263
readOnly: true
26264+
SecurityQuestion:
26265+
type: object
26266+
description: Single security question and response object.
26267+
properties:
26268+
id:
26269+
type: integer
26270+
description: The ID representing the security question.
26271+
example: 1
26272+
question:
26273+
type: string
26274+
readOnly: true
26275+
description: The security question.
26276+
example: "In what city were you born?"
26277+
response:
26278+
type: string
26279+
minLength: 3
26280+
maxLength: 17
26281+
description: |
26282+
The security question response.
26283+
example: "Gotham City"
26284+
SecurityQuestionsGet:
26285+
type: object
26286+
description: Security questions and responses object for GET operation.
26287+
properties:
26288+
security_questions:
26289+
type: array
26290+
items:
26291+
type: object
26292+
description: Single security question and response object for GET operation.
26293+
properties:
26294+
id:
26295+
$ref: '#/components/schemas/SecurityQuestion/properties/id'
26296+
question:
26297+
$ref: '#/components/schemas/SecurityQuestion/properties/question'
26298+
response:
26299+
$ref: '#/components/schemas/SecurityQuestion/properties/response'
26300+
SecurityQuestionsPost:
26301+
type: object
26302+
description: Security questions and responses object for POST operation.
26303+
properties:
26304+
security_questions:
26305+
type: array
26306+
items:
26307+
type: object
26308+
description: Single security question and response object for POST operation.
26309+
properties:
26310+
question_id:
26311+
$ref: '#/components/schemas/SecurityQuestion/properties/id'
26312+
response:
26313+
$ref: '#/components/schemas/SecurityQuestion/properties/response'
26314+
security_question:
26315+
$ref: '#/components/schemas/SecurityQuestion/properties/question'
2599526316
ServiceTransfer:
2599626317
type: object
2599726318
description: >

0 commit comments

Comments
 (0)