Skip to main content

OS Category

GET/api/v1/images/os-category/

Query parameters

  • project_idQuerystringoptional

    Identifier of the project to scope the request to. Optional; if omitted, the account's default project is used.

    • optional
    • if omitted, the request is applied to the default project
    example{{project_id}}
  • apikeyQuerystringoptional

    API key used to authenticate the request

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

    Location filter for OS Category queries

    • must be a non-empty string
    • should be a valid location identifier (e.g., ISO code)
    example{{location}}

Responses

200Successful response
object
codeinteger

HTTP status code of the response

example200
  • integer between 100 and 599
  • represents standard HTTP status
dataobject
errorsobject
messagestring

Human-readable status message of the response

exampleSuccess
  • must be a non-empty string
  • max length typically 100 characters