Skip to content

Commit bec18dc

Browse files
committed
Merge branch 'master' of github.com:linode/linode-api-docs into development
2 parents 9223047 + 610a8c6 commit bec18dc

File tree

1 file changed

+86
-0
lines changed

1 file changed

+86
-0
lines changed

openapi.yaml

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3471,6 +3471,68 @@ paths:
34713471
--description "A longer description \
34723472
of the image" \
34733473
--disk_id 123
3474+
/images/upload:
3475+
x-linode-cli-command: images
3476+
post:
3477+
servers:
3478+
- url: https://api.linode.com/v4beta
3479+
tags:
3480+
- Images
3481+
summary: Upload Image
3482+
description: >
3483+
Initiates a Machine Image upload.
3484+
3485+
This endpoint creates a new private Image object and returns it, along
3486+
with the URL the image data should be uploaded to. Images must be uploaded
3487+
within 24 hours of creation or the upload will be cancelled. Image uploads
3488+
should be made as an HTTP PUT request to the returned URL, with a
3489+
`Content-type: application/octet-stream` header included in the request.
3490+
Uploaded image data should be in gzip format. A maximum file size of
3491+
5GB is supported for upload at this time.
3492+
3493+
*NOTE* This endpoint is currently in beta, and is only available to users
3494+
who are a part of the beta. You may see a 404 error returned from this
3495+
endpoint if you are not currently enrolled - open a support ticket to
3496+
sign up to join the beta when space becomes available.
3497+
x-linode-cli-action: upload
3498+
security:
3499+
- personalAccessToken: []
3500+
- oauth:
3501+
- images:read_write
3502+
requestBody:
3503+
description: The data
3504+
content:
3505+
application/json:
3506+
schema:
3507+
type: object
3508+
properties:
3509+
region:
3510+
type: string
3511+
description: The region to upload to.
3512+
example: eu-central
3513+
label:
3514+
type: string
3515+
description: Label for the new image.
3516+
example: my-image-label
3517+
description:
3518+
type: string
3519+
description: Description for the image.
3520+
example: This is an example image in the docs.
3521+
responses:
3522+
'200':
3523+
description: The new image and upload url.
3524+
content:
3525+
application/json:
3526+
schema:
3527+
type: object
3528+
properties:
3529+
upload_url:
3530+
type: string
3531+
description: The URL to upload the image to.
3532+
image:
3533+
$ref: '#/components/schemas/ImagePrivate'
3534+
default:
3535+
$ref: '#/components/responses/ErrorResponse'
34743536
/images/{imageId}:
34753537
x-linode-cli-command: images
34763538
parameters:
@@ -17277,6 +17339,20 @@ components:
1727717339
x-linode-cli-color:
1727817340
None: black
1727917341
default_: white
17342+
status:
17343+
x-linode-cli-display: 7
17344+
type: string
17345+
enum:
17346+
- creating
17347+
- pending_upload
17348+
- available
17349+
description: |
17350+
The current status of this Image. Only images in an "available" status
17351+
can be deployed. Images in a "creating" status are being created from
17352+
a Linode Disk, and will become "available" shortly. Images in a
17353+
"pending_upload" status are waiting for data to be uploaded for the
17354+
image, and will become "available" after the upload is complete and
17355+
processing occurs.
1728017356
ImagePublic:
1728117357
type: object
1728217358
description: Public Image object
@@ -17380,6 +17456,16 @@ components:
1738017456
x-linode-cli-color:
1738117457
None: black
1738217458
default_: white
17459+
status:
17460+
x-linode-cli-display: 7
17461+
type: string
17462+
enum:
17463+
- creating
17464+
- pending_upload
17465+
- available
17466+
description: |
17467+
The current status of this Image. Only images in an "available" status
17468+
can be deployed.
1738317469
LinodeConfigInterface:
1738417470
type: object
1738517471
description: >

0 commit comments

Comments
 (0)