@@ -3363,21 +3363,20 @@ paths:
33633363 tags:
33643364 - Images
33653365 summary: Images List
3366- description: >
3366+ description: |
33673367 Returns a paginated list of Images.
33683368
3369+ * **Public** Images have IDs that begin with "linode/". These distribution images are generally available to
3370+ all users. To view only public Images, call this endpoint without authentication.
33693371
3370- * Calling this endpoint without authentication returns all public Images.
3371-
3372- * Authentication is required to return a combined paginated list of all public and
3373- your private Images.
3372+ * **Private** Images have IDs that begin with "private/". These images are account-specific and only
3373+ accessible to users with `images:read_only` authorization. To view private Images you have access to in
3374+ addition to public images, call this endpoint with authentication.
33743375 x-linode-redoc-load-ids: true
33753376 operationId: getImages
33763377 x-linode-cli-action: list
33773378 security:
33783379 - personalAccessToken: []
3379- - oauth:
3380- - images:read_only
33813380 responses:
33823381 '200':
33833382 description: A paginated list of Images.
@@ -3400,8 +3399,13 @@ paths:
34003399 $ref: '#/components/responses/ErrorResponse'
34013400 x-code-samples:
34023401 - lang: Shell
3403- source: >
3402+ source: |
3403+ # Returns public Images only
34043404 curl https://api.linode.com/v4/images
3405+
3406+ # Returns private and public Images
3407+ curl -H "Authorization: Bearer $TOKEN" \
3408+ https://api.linode.com/v4/images
34053409 - lang: CLI
34063410 source: >
34073411 linode-cli images list
@@ -3410,17 +3414,22 @@ paths:
34103414 tags:
34113415 - Images
34123416 summary: Image Create
3413- description: >
3414- Creates a private gold-master Image from a Linode Disk. There is no
3415- additional charge to store Images for Linode users.
3416-
3417- Images are limited to three per Account.
3417+ description: |
3418+ Captures a private gold-master Image from a Linode Disk.
3419+
3420+ **Pricing change:** Images will transition to a paid service with a
3421+ cost of $0.10/GB per month for each manual Custom Image stored on an
3422+ account. This change will be communicated to customers in advance.
3423+ Recovery Images, which are generated automatically after a Linode is
3424+ deleted and available for a finite period of time, are provided at no
3425+ cost.
34183426 operationId: createImage
34193427 x-linode-cli-action: create
34203428 security:
34213429 - personalAccessToken: []
34223430 - oauth:
34233431 - images:read_write
3432+ - linodes:read_only
34243433 requestBody:
34253434 description: Information about the Image to create.
34263435 content:
@@ -3478,20 +3487,28 @@ paths:
34783487 - url: https://api.linode.com/v4beta
34793488 tags:
34803489 - Images
3481- summary: Machine Image Upload
3490+ summary: Image Upload
34823491 description: |
3483- Initiates a Machine Image upload.
3492+ Initiates an Image upload.
3493+
3494+ This endpoint creates a new private Image object and returns it along
3495+ with the URL to which image data can be uploaded.
34843496
3485- This endpoint creates a new private Image object and returns it, along
3486- with the URL the image data should be uploaded to .
3497+ - Image data must be uploaded within 24 hours of creation or the
3498+ upload will be cancelled and the image deleted .
34873499
3488- - Machine Images must be uploaded within 24 hours of creation or the upload will be cancelled.
3500+ - Image uploads should be made as an HTTP PUT request to the returned `upload_url`, with a
3501+ `Content-type: application/octet-stream` header included in the request. For example:
34893502
3490- - Machine Image uploads should be made as an HTTP PUT request to the returned URL, with a
3491- `Content-type: application/octet-stream` header included in the request.
3503+ curl -v \
3504+ -H "Content-Type: application/octet-stream" \
3505+ --upload-file example.img.gz \
3506+ $UPLOAD_URL \
3507+ --progress-bar \
3508+ --output /dev/null
34923509
3493- - Uploaded image data should be in gzip format. A maximum file size of
3494- 5GB is supported for upload at this time.
3510+ - Uploaded image data should be compressed in gzip (`.gz`) format. The uncompressed disk should be in raw
3511+ disk image (`.img`) format. A maximum compressed file size of 5GB is supported for upload at this time.
34953512
34963513 This endpoint is currently in **beta**. Please make sure to prepend all requests with
34973514 `/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking
@@ -3503,7 +3520,7 @@ paths:
35033520 - oauth:
35043521 - images:read_write
35053522 requestBody:
3506- description: The Machine Image details.
3523+ description: The uploaded Image details.
35073524 content:
35083525 application/json:
35093526 schema:
@@ -3514,27 +3531,28 @@ paths:
35143531 properties:
35153532 region:
35163533 type: string
3517- description: The region to upload to.
3534+ description: >
3535+ The region to upload to. Once uploaded, the Image can be used in any region.
35183536 example: eu-central
35193537 label:
35203538 type: string
3521- description: Label for the new Machine Image.
3539+ description: Label for the uploaded Image.
35223540 example: my-image-label
35233541 description:
35243542 type: string
3525- description: Description for the Machine Image.
3543+ description: Description for the uploaded Image.
35263544 example: This is an example image in the docs.
35273545 responses:
35283546 '200':
3529- description: The new Machine Image upload URL.
3547+ description: The new Image upload URL.
35303548 content:
35313549 application/json:
35323550 schema:
35333551 type: object
35343552 properties:
35353553 upload_url:
35363554 type: string
3537- description: The URL to upload the Machine Image to.
3555+ description: The URL to upload the Image to.
35383556 image:
35393557 $ref: '#/components/schemas/ImagePrivate'
35403558 default:
0 commit comments