hnhdigital-os/php-linode-api

View on GitHub
spec-old/Instance/Disks.yml

Summary

Maintainability
Test Coverage
endpoint: linode/instances/%s/disks
description: Manage the disks associated with this Linode.
url: https://developers.linode.com/v4/reference/endpoints/linode/instances/$id/disks
load-method: all

parameters:

    linode_id:
      type: int

get:

  all:
    description: Returns a Backups Response with information on this Linode's available backups.
    url: https://developers.linode.com/v4/reference/endpoints/linode/instances/$id/backups#GET
    endpoint: 
    search: true

post:

  create:
    description: Creates a new disk.
    url: https://developers.linode.com/v4/reference/endpoints/linode/instances/$id/backups#POST
    endpoint: 

    parameters:

      size:
        type: int
        description: Size in MB for this disk.

      label:
        type: string
        description: User-friendly string to name this disk.
    
    optional:

      image:
        type: string
        description: Optional image id to deploy the disk from. You may not provide image if distribution is provided. Official images start with "linode/", while your images start with "private/"

      root_pass:
        type: string
        description: Root password to deploy distribution with.

      authorized_keys:
        type: array
        description: An array of public SSH keys to be installed into the distribution's default user's `authorized_keys` file when creating a new disk from a Linode provided distribution.

      filesystem:
        type: string
        default: ext4
        description: A filesystem for this disk. Defaults to "ext4".

      read_only:
        type: boolean
        default: false
        description: If true, this disk is read-only.
      
      stackscript_id:
        type: int
        description: The stackscript ID to deploy with this disk. Must provide a distribution. Distribution must be one that the stackscript can be deployed to.

      stackscript_data:
        type: json
        description: UDF (user-defined fields) for this stackscript. Defaults to "{}". Must match UDFs required by stackscript.