General information

GET /api/v2/user/account

Returns information about the account, such as username, email address and disk quota.

Result: Example

GET /api/v2/user/api_version

Returns the running API version including the minor version.

Result: Example

Return Values

Studio returns several types of return values:

  • XML according to the call documentation above,

  • a success message: <success></success>,

  • one of many error results, which contain a code and a message. You will find an example at the bottom of the list.

    access_denied
    For whatever reason, you do not have permission to do whatever it is you’re trying to do.
    build_not_found
    We can’t find the build you’ve asked for.
    cannot_delete_published_build
    You can’t delete a published build, so unpublish it and try again.
    configuration_error
    Something has gone horribly wrong and we can’t build your appliance.
    download_error
    We couldn’t download the file you’ve asked us to download.
    image_already_exists
    You’ve already built a specific version of an appliance, so you’ll need to force an overwrite if you want to keep going.
    image_is_locked
    You can’t rebuild appliances that have been published to the Gallery.
    initial_build_pending
    You’ll need to wait until the first build of an appliance is done before building additional image types.
    internal_error
    Something went wrong inside Studio, and it’s probably not your fault. The error message will tell you more.
    invalid_appliance_id
    Whoops!
    invalid_architecture
    You can’t build ARM appliances yet, sorry.
    invalid_base_system
    That won’t, either.
    invalid_build_id
    You’ve requested a build of an appliance that doesn’t exist.
    invalid_file
    You can only upload RPMs or tarballs with RPMs in them.
    invalid_gpg_key_id
    We can’t find the GPG key that you’re looking for.
    invalid_image_type
    Sometimes you get to specify which type of image (ISO, VMX, etc.) you’d like. And sometimes an appliance hasn’t been built in that type.
    invalid_key
    The GPG key isn’t going to work out.
    invalid_name
    We need a name to import GPG keys.
    invalid_node
    An unknown node was found during the parsing of POSTed XML.
    invalid_overlay_file_id
    I think that’s clear enough.
    invalid_parent
    If you try to reply to a comment that doesn’t exist, we’ll tell you.
    invalid_path
    You’ve asked for a file that doesn’t exist.
    invalid_protocol
    You can only upload files-via-url that are HTTP(S) or FTP.
    invalid_rating
    … between 0 and 5.
    invalid_repository_id
    If we can’t find the repository, we can’t add it to your appliance.
    invalid_request
    Please don’t POST with both file and url params together, and don’t POST with neither.
    invalid_rpm_id
    Yep, nor that.
    invalid_running_build_id
    That too.
    invalid_target
    We need a proper target for the GPG key.
    invalid_template_set
    That won’t work.
    invalid_username
    Are you trying to share an appliance with a user who doesn’t have an account?
    invalid_value
    You’ve POSTed a value that we can’t do anything with.
    invalid_version
    You’ve requested a version of an appliance that doesn’t exist.
    invalid_xml
    You tried to POST XML that was not valid (missing a closing tag, perhaps?)
    key_already_exists
    It’s already there!
    missing_appliance_id
    You’ve forgotten to tell us which appliance you’d like to work with.
    missing_name
    We need a name in order to add a repository.
    missing_parameter
    Seems you’ve left something out of your call!
    missing_rating
    If you want to rate an appliance, you’ll need to provide a value…
    missing_url
    We need a URL in order to add a repository.
    missing_version
    Sometimes we need to know which version of an appliance you’re intending to GET or modify.
    no_build_slots
    We’re at full capacity, so you’ll need to come back later.
    raw_image_unavailable
    We can’t gain access to the file you’ve requested.
    read_only_mode_active
    You can’t modify appliances at the moment, please try again later.
    repository_already_exists
    Someone got there first.
    sle_agreement_missing
    You need to accept some legal stuff before you can build and distribute SLE appliances.
    unknown_error
    A generic “catch all” when we don’t have a more descriptive code to offer. The error message will tell you more.
    unknown_query
    When you’re searching for appliances in Gallery, you should use the queries we list.
    user_repository_not_found
    You’ve tried to add a user repository, but we can’t find one.
    version_not_published
    Not all versions of appliances have been published.
    version_published
    … and sometimes you try to publish an appliance that is already on Gallery.
    wrong_http_method
    You are POSTing when you should be GETting, or some other combination.

Result: Example