Skip to content

[New] GET account/maintenance #282

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 3 commits into from
Aug 24, 2020
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
111 changes: 111 additions & 0 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -957,6 +957,55 @@ paths:
- lang: CLI
source: >
linode-cli account login-view 1234
/account/maintenance:
x-linode-cli-command: maintenance
get:
x-linode-grant: read_only
servers:
- url: https://api.linode.com/v4beta
tags:
- Account
summary: List Maintenance
description: >
Returns a collection of Maintenance objects for any entity
a user has permissions to view.


Currently, Linodes are the only entities available for viewing.
operationId: getMaintenance
x-linode-cli-action: maintenance-list
security:
- personalAccessToken: []
- oauth:
- maintenance:read_only
responses:
'200':
description: Returns a paginated list of Maintenance objects.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Maintenance'
page:
$ref: '#/components/schemas/PaginationEnvelope/properties/page'
pages:
$ref: '#/components/schemas/PaginationEnvelope/properties/pages'
results:
$ref: '#/components/schemas/PaginationEnvelope/properties/results'
default:
$ref: '#/components/responses/ErrorResponse'
x-code-samples:
- lang: Shell
source: >
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4beta/account/maintenance
- lang: CLI
source: >
linode-cli account maintenance-list
/account/notifications:
x-linode-cli-command: account
get:
Expand Down Expand Up @@ -16274,6 +16323,68 @@ components:
The value must be a [Longview Subscription ID](/api/v4/longview-subscriptions) or `null`. Note that a value of `null` will cancel the Longview subscription.
example: longview-30
x-linode-cli-display: 1
Maintenance:
type: object
description: >
Information about maintenance affecting an entity.
properties:
type:
x-linode-filterable: true
type: string
enum:
- reboot
- cold_migration
- live_migration
description: >
The type of maintenance.
example: reboot
status:
x-linode-filterable: true
type: string
enum:
- pending
- ready
- started
- completed
description: >
The maintenance status.
example: started
reason:
type: string
description: >
The reason maintenance is being performed.
example: This maintenance will allow us to update the BIOS on the host’s motherboard.
when:
type: string
description: >
When the maintenance will begin.
format: date-time
example: 2020-07-09T00:01:01
entity:
type: object
description: >
The entity being affected by maintenance.
properties:
label:
type: string
description: >
The label of the entity being affected by maintenance.
example: demo-linode
id:
type: number
description: >
The id of the entity being affected by maintenance.
example: 1234
type:
type: string
description: >
The type of entity.
example: Linode
url:
type: string
description: >
The API endpoint prefix to use in combination with the entity id to find specific information about the entity.
example: https://api.linode.com/v4/linode/instances/{linodeId}
ManagedContact:
type: object
description: >
Expand Down