Disks

List persistent disks matching the provided filters. If no filters are provided, returns all disks you have permissions to view.

get/disks

Request

  • Base URL
    https://api.render.com/v1
  • Auth
    HTTP bearer

Query parameters

ownerIdstring[]

The ID of the workspaces to return resources for

diskIdSchema[] (unresolved $ref)

Filter by disk IDs

namestring[]

Filter by name

createdBeforestring date-time

Filter for resources created before a certain time (specified as an ISO 8601 timestamp)

createdAfterstring date-time

Filter for resources created after a certain time (specified as an ISO 8601 timestamp)

updatedBeforestring date-time

Filter for resources updated before a certain time (specified as an ISO 8601 timestamp)

updatedAfterstring date-time

Filter for resources updated after a certain time (specified as an ISO 8601 timestamp)

serviceIdstring[]

Filter for resources by service ID

cursorstring

The position in the result list to start from when fetching paginated results. For details, see Pagination.

limitinteger

Defaults to 20

The maximum number of items to return. For details, see Pagination.

Response

OK

diskSchema required(unresolved $ref)
cursorstring required

Changes

    • breaking

      the // response's property type changed from no type to string for status

    • warning

      for the query request parameter diskId, the type of property items/ changed from no type to string

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the // response's property pattern ^dsk-[0-9a-z]{20}$ was added for the status