Skip to content

[New] Regions Availability List; Region Availability view #833

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 2 commits into from
Aug 24, 2023
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
83 changes: 83 additions & 0 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17446,6 +17446,73 @@ paths:
- lang: CLI
source: >
linode-cli regions view us-east
/regions/{regionId}/availability:
x-linode-cli-command: regions
parameters:
- name: regionId
in: path
description: ID of the Region to look up.
required: true
schema:
type: string
get:
tags:
- Regions
summary: Region Availability View
description: >
Returns availability data for a single Region.
operationId: getRegionAvailability
x-linode-cli-action: view-avail
responses:
'200':
description: A single Region object.
content:
application/json:
schema:
$ref: '#/components/schemas/RegionAvailability'
default:
$ref: '#/components/responses/ErrorResponse'
x-code-samples:
- lang: Shell
source: >
curl https://api.linode.com/v4/regions/us-east/availability
- lang: CLI
source: >
linode-cli regions view-avail us-east
/regions/availability:
x-linode-cli-command: regions
get:
tags:
- Regions
summary: Regions Availability List
description: |
Returns availability data for all Regions.

Currently, this command returns availability of select premium and GPU plans for select regions.
operationId: getRegionsAvailability
x-linode-cli-action: list-avail
responses:
'200':
description: Returns a Region Availability object.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginationEnvelope'
- properties:
data:
type: array
items:
$ref: '#/components/schemas/RegionAvailability'
default:
$ref: '#/components/responses/ErrorResponse'
x-code-samples:
- lang: Shell
source: >
curl https://api.linode.com/v4/regions/availability
- lang: CLI
source: >
linode-cli regions list-avail
/support/tickets:
x-linode-cli-command: tickets
get:
Expand Down Expand Up @@ -25297,6 +25364,22 @@ components:
The IPv6 addresses for this region's DNS resolvers, separated by commas.
example: "2001:0db8::,2001:0db8::1"
readOnly: true
RegionAvailability:
type: object
description: Compute instance availability information by [Type](/docs/api/linode-types/) and [Region](/docs/api/regions/).
properties:
region:
type: string
example: us-east
description: The [Region](/docs/api/regions/) ID.
plan:
type: string
example: gpu-rtx6000-1.1
description: The compute instance [Type](/docs/api/linode-types/) ID.
available:
type: boolean
example: true
description: Whether the compute instance type is available in the region.
RescueDevices:
type: object
properties:
Expand Down