Skip to content

Commit ddc4c3c

Browse files
Updated API spec with Account Availability endpoints (#895)
* Updated API spec with Account Availability endpoints * copy edits * change operationid / x-linode-cli-action * Update spec number --------- Co-authored-by: Andy Stevens <taylorstevens@gmail.com>
1 parent ed52a54 commit ddc4c3c

File tree

1 file changed

+104
-1
lines changed

1 file changed

+104
-1
lines changed

openapi.yaml

Lines changed: 104 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: 3.0.1
22
info:
3-
version: 4.168.0
3+
version: 4.169.0
44
title: Linode API
55
license:
66
name: Apache 2.0
@@ -538,6 +538,91 @@ paths:
538538
--state PA \
539539
--tax_id ATU99999999 \
540540
--zip 19102
541+
/account/availability:
542+
x-linode-cli-command: availability
543+
get:
544+
tags:
545+
- account
546+
summary: Account Availability
547+
description: |
548+
Returns service unavailability for all available regions.
549+
550+
Only authorized Users can access this endpoint.
551+
552+
*This endpoint is currently in **Beta**, and should not be used for production workloads.*
553+
operationId: getAvailability
554+
security:
555+
- personalAccessToken: []
556+
- oauth:
557+
- account:read_only
558+
x-linode-cli-action: getAvailability
559+
x-linode-grant: read_only
560+
responses:
561+
'200':
562+
description: |
563+
Returns a paginated list of regions and their unavailable resources.
564+
content:
565+
application/json:
566+
schema:
567+
allOf:
568+
- type: object
569+
properties:
570+
data:
571+
type: array
572+
items:
573+
$ref: '#/components/schemas/AccountAvailability'
574+
- $ref: '#/components/schemas/PaginationEnvelope'
575+
default:
576+
$ref: '#/components/responses/ErrorResponse'
577+
x-code-samples:
578+
- lang: Shell
579+
source: >
580+
curl https://api.linode.com/v4/account/availability \
581+
-H "Authorization: Bearer $TOKEN"
582+
- lang: CLI
583+
source: >
584+
linode-cli account availability getAvailability
585+
/account/availability/{id}:
586+
x-linode-cli-command: availability
587+
parameters:
588+
- name: id
589+
in: path
590+
description: The id of the data center.
591+
required: true
592+
schema:
593+
type: string
594+
get:
595+
tags:
596+
- account
597+
summary: Region Service Availability
598+
description: |
599+
Returns a single region's service availability.
600+
601+
Only authorized Users can access this.
602+
operationId: getAccountAvailability
603+
security:
604+
- personalAccessToken: []
605+
- oauth:
606+
- account:read_only
607+
x-linode-cli-action: getAccountAvailability
608+
x-linode-grant: read_only
609+
responses:
610+
'200':
611+
description: Returns an object with a region and the region's unavailable resources.
612+
content:
613+
application/json:
614+
schema:
615+
$ref: '#/components/schemas/AccountAvailability'
616+
default:
617+
$ref: '#/components/responses/ErrorResponse'
618+
x-code-samples:
619+
- lang: Shell
620+
source: >
621+
curl https://api.linode.com/v4/account/availability/us-east \
622+
-H "Authorization: Bearer $TOKEN"
623+
- lang: CLI
624+
source: >
625+
linode-cli account availability getAccountAvailability us-east
541626
/account/betas:
542627
x-linode-cli-command: betas
543628
get:
@@ -19478,6 +19563,24 @@ components:
1947819563
- May only consist of letters, numbers, spaces, and hyphens.
1947919564
- Must not contain more than 9 letter or number characters.
1948019565
example: 19102-1234
19566+
AccountAvailability:
19567+
type: object
19568+
description: Account Service Availability object
19569+
properties:
19570+
region:
19571+
type: string
19572+
readOnly: true
19573+
description: >
19574+
Displays the data center represented by a slug.
19575+
example: us-east
19576+
x-linode-cli-display: 1
19577+
unavailable:
19578+
type: list
19579+
readOnly: true
19580+
description: >
19581+
A list of strings of unavailable services.
19582+
example: ["Linodes", "Block Storage"]
19583+
x-linode-cli-display: 2
1948119584
AccountSettings:
1948219585
type: object
1948319586
description: Account Settings object

0 commit comments

Comments
 (0)