Skip to main content

OS Plans

GET/api/v1/images/

Query parameters

  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • categoryQuerystringoptional

    Filters OS plans by operating system category

    • must be a non-empty string
    • allowed values are recognized OS names (e.g., Ubuntu, Windows, RedHat)
    exampleUbuntu
  • osversionQuerystringoptional

    Operating system version filter for OS plans

    • must be a valid version string
    • format: major.minor (e.g., 24.04)
    example24.04
  • osQuerystringoptional

    Operating system name used to filter plans

    • must be a non-empty string
    • allowed values are supported OS names such as Ubuntu, Windows, etc.
    exampleUbuntu
  • apikeyQuerystringrequired

    API key used to authenticate the request

    • required
    • must be a valid API key
    example{{api_key}}
  • locationQuerystringrequired

    E2E Myaccount region identifier for the OS plan query

    • must be a valid E2E Myaccount location string
    • cannot be empty
    example{{location}}

Responses

200Successful response
object
codeinteger

HTTP status code of the OS Plans response

example200
  • integer between 100 and 599
  • must be a valid HTTP status code
dataarray
errorsobject
messagestring

Human-readable status message for the response

exampleSuccess
  • non-empty string
  • maximum length 255 characters