@@ -958,6 +958,55 @@ paths:
958
958
- lang: CLI
959
959
source: >
960
960
linode-cli account login-view 1234
961
+ /account/maintenance:
962
+ x-linode-cli-command: maintenance
963
+ get:
964
+ x-linode-grant: read_only
965
+ servers:
966
+ - url: https://api.linode.com/v4beta
967
+ tags:
968
+ - Account
969
+ summary: List Maintenance
970
+ description: >
971
+ Returns a collection of Maintenance objects for any entity
972
+ a user has permissions to view.
973
+
974
+
975
+ Currently, Linodes are the only entities available for viewing.
976
+ operationId: getMaintenance
977
+ x-linode-cli-action: maintenance-list
978
+ security:
979
+ - personalAccessToken: []
980
+ - oauth:
981
+ - maintenance:read_only
982
+ responses:
983
+ '200':
984
+ description: Returns a paginated list of Maintenance objects.
985
+ content:
986
+ application/json:
987
+ schema:
988
+ type: object
989
+ properties:
990
+ data:
991
+ type: array
992
+ items:
993
+ $ref: '#/components/schemas/Maintenance'
994
+ page:
995
+ $ref: '#/components/schemas/PaginationEnvelope/properties/page'
996
+ pages:
997
+ $ref: '#/components/schemas/PaginationEnvelope/properties/pages'
998
+ results:
999
+ $ref: '#/components/schemas/PaginationEnvelope/properties/results'
1000
+ default:
1001
+ $ref: '#/components/responses/ErrorResponse'
1002
+ x-code-samples:
1003
+ - lang: Shell
1004
+ source: >
1005
+ curl -H "Authorization: Bearer $TOKEN" \
1006
+ https://api.linode.com/v4beta/account/maintenance
1007
+ - lang: CLI
1008
+ source: >
1009
+ linode-cli account maintenance-list
961
1010
/account/notifications:
962
1011
x-linode-cli-command: account
963
1012
get:
@@ -16393,6 +16442,68 @@ components:
16393
16442
endpoint to receive the details of each plan.
16394
16443
example: longview-10
16395
16444
x-linode-cli-display: 1
16445
+ Maintenance:
16446
+ type: object
16447
+ description: >
16448
+ Information about maintenance affecting an entity.
16449
+ properties:
16450
+ type:
16451
+ x-linode-filterable: true
16452
+ type: string
16453
+ enum:
16454
+ - reboot
16455
+ - cold_migration
16456
+ - live_migration
16457
+ description: >
16458
+ The type of maintenance.
16459
+ example: reboot
16460
+ status:
16461
+ x-linode-filterable: true
16462
+ type: string
16463
+ enum:
16464
+ - pending
16465
+ - ready
16466
+ - started
16467
+ - completed
16468
+ description: >
16469
+ The maintenance status.
16470
+ example: started
16471
+ reason:
16472
+ type: string
16473
+ description: >
16474
+ The reason maintenance is being performed.
16475
+ example: This maintenance will allow us to update the BIOS on the host’s motherboard.
16476
+ when:
16477
+ type: string
16478
+ description: >
16479
+ When the maintenance will begin.
16480
+ format: date-time
16481
+ example: 2020-07-09T00:01:01
16482
+ entity:
16483
+ type: object
16484
+ description: >
16485
+ The entity being affected by maintenance.
16486
+ properties:
16487
+ label:
16488
+ type: string
16489
+ description: >
16490
+ The label of the entity being affected by maintenance.
16491
+ example: demo-linode
16492
+ id:
16493
+ type: number
16494
+ description: >
16495
+ The id of the entity being affected by maintenance.
16496
+ example: 1234
16497
+ type:
16498
+ type: string
16499
+ description: >
16500
+ The type of entity.
16501
+ example: Linode
16502
+ url:
16503
+ type: string
16504
+ description: >
16505
+ The API endpoint prefix to use in combination with the entity id to find specific information about the entity.
16506
+ example: https://api.linode.com/v4/linode/instances/{linodeId}
16396
16507
ManagedContact:
16397
16508
type: object
16398
16509
description: >
0 commit comments