integrations.sh
← all integrations

opensuse.org – obs

OpenAPI apis-guru developer_tools

The Open Build Service API is a XML API.

To authenticate, use by passing the Authorization header in the form of Authorization: Basic <credentials>.

There is no API versioning as there is no need for it right now.

Only rudimentary rate limiting is implemented, so please be gentle when using the API concurrently, especially with potentially expensive operations. In case of abuse, we will limit/remove your access.

For command-line users, we recommend using with its api command to interact with the API. It's as simple as this example: osc api /about (about is one of the endpoints documented below)

Homepage
https://api.apis.guru/v2/specs/opensuse.org:obs/2.10.50.json
Provider
opensuse.org:obs / obs
OpenAPI version
3.0.0
Spec (JSON)
https://api.apis.guru/v2/specs/opensuse.org/obs/2.10.50/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/opensuse.org/obs/2.10.50/openapi.yaml

Tools (83)

Extracted live via the executor SDK.

  • attributeNamespaces.deleteAttributeNamespace

    Delete an attribute namespace and all attributes below.

    This operation is the same as the one defined with ._

  • attributeNamespaces.deleteAttributeNamespaceMeta

    Delete an attribute namespace and all attributes below.

    This operation is the same as the one defined with .

  • attributeNamespaces.getAttribute

    List all attribute namespaces.

  • attributeNamespaces.getAttributeNamespace

    List all attributes under a given attribute namespace.

  • attributeNamespaces.getAttributeNamespaceMeta

    Shows attribute namespace.

  • attributeNamespaces.postAttributeNamespaceMeta

    This endpoint can be used for both, creating an attribute namespace and updating it:

    • If the attribute namespace passed as parameter doesn't exist, it will create the attribute namespace.
    • If the attribute namespace passed as parameter already exists, it will update the namespace attribute.

    This operation is the same as the one defined with .

  • attributeNamespaces.putAttributeNamespaceMeta

    This endpoint can be used for both, creating an attribute namespace and updating it:

    • If the attribute namespace passed as parameter doesn't exist, it will create the attribute namespace.
    • If the attribute namespace passed as parameter already exists, it will update the namespace attribute.

    This operation is the same as the one defined with .

  • attributes.deleteAttributeNamespaceAttributeName

    Delete an attribute and all its values in projects or packages.

    This operation is the same as the one defined with


  • attributes.deleteAttributeNamespaceAttributeNameMeta

    Delete an attribute and all its values in projects or packages.

    This operation is the same as the one defined with

  • attributes.getAttributeNamespaceAttributeNameMeta

    Shows attribute.

  • attributes.postAttributeNamespaceAttributeNameMeta

    This endpoint can be used for both, creating an attribute and updating it:

    • If the attribute passed as parameter doesn't exist, it will create the attribute.
    • If the attribute passed as parameter already exists, it will update the attribute.

    This operation is the same as the one defined with . __

  • attributes.putAttributeNamespaceAttributeNameMeta

    This endpoint can be used for both, creating an attribute and updating it:

    • If the attribute passed as parameter doesn't exist, it will create the attribute.
    • If the attribute passed as parameter already exists, it will update the attribute.

    This operation is the same as the one defined with . __

  • build.getBuild

    Get a simple directory listing of all projects

  • build.getBuildProjectName

    Get a simple directory listing of all repositories for the specified project

  • build.getBuildProjectNameRepositoryName

    List of all architectures the specified project builds against a given repository.

  • build.getBuildProjectNameRepositoryNameArchitectureNameBuilddepinfo

    Show the build dependencies of packages that are part of the project, for a given repository and architecture.

  • build.getBuildProjectNameRepositoryNameArchitectureNamePackageName

    List binaries built by the sources of the specified package.

  • build.getBuildProjectNameRepositoryNameArchitectureNamePackageNameJobstatus

    Show the build status of a currently running build job. Shows an empty result if no build job is running.

  • build.getBuildProjectNameRepositoryNameArchitectureNamePackageNameReason

    Details about the reason of the lastly triggered build.

  • build.getBuildProjectNameRepositoryNameArchitectureNameRepository

    List all binaries (produced by all packages of the given project) for the specified repository and architecture.

  • build.getBuildProjectNameRepositoryNameBuildconfig

    Show the build configuration for the specified repository. Includes all base package requirements, mappings and macros.

  • build.getBuildProjectNameResult

    Get the build results for packages, architectures and repositories of the specified project.

  • build.getBuildProjectRepositoryArchitecturePackageFile

    Given a project, repository, architecture and package, retrieve the given file's content.

  • build.getBuildProjectRepositoryArchitecturePackageFileViewFileinfo

    Given a project, repository, architecture and package, retrieve the given artifact's details.

  • build.getBuildProjectRepositoryArchPackageBuildinfo

    This endpoint returns information about some specific artifact

  • build.getBuildProjectRepositoryArchPackageHistory

    This endpoint returns the build history for a specific artifact

  • build.getBuildProjectRepositoryArchPackageLog

    This endpoint returns the last log file for a specific build artifact

  • build.getBuildProjectRepositoryArchPackageStatus

    This endpoint returns the building status for a specific artifact

  • build.postBuildProjectName

    Apply different actions on builds/build processes of the specified project

  • build.putBuildProjectRepositoryArchitecturePackageFile

    Given a project, repository, architecture and package, update the given file's content.

    This is for Admins only.

  • configuration.getConfiguration

    Display the configuration of this Open Build Service instance.

  • configuration.putConfiguration

    Update the configuration of this Open Build Service instance.

    This is for admins only.

  • distributions.deleteDistributionsDistributionId

    Delete a distribution.

    This is only for admins.

  • distributions.getDistributions

    List all distributions that can be build against. This will not list distributions that are available via . Check /distributions/include_remotes for this.

  • distributions.getDistributionsDistributionId

    Show a distribution that can be build against.

  • distributions.getDistributionsIncludeRemotes

    List all distributions that can be build against, including the ones provided by the interconnect.

  • distributions.postDistributions

    Create a distribution.

    This is only for admins.

  • distributions.putDistributionsBulkReplace

    Bulk replace all distributions.

    This is only for admins.

  • distributions.putDistributionsDistributionId

    Update the data of a distribution.

  • generalInformation.getAbout

    Get generic information about the API.

  • generalInformation.getArchitectures

    Get a list of all known architectures known to OBS in general. This is not the list of architectures provided by this instance. Check the schedulers element from the /configuration route for this.

  • generalInformation.getArchitecturesArchitectureName

    Show information about one architecture.

  • groups.deleteGroupGroupTitle

    Delete a group.

  • groups.getGroup

    List available groups.

  • groups.getGroupGroupTitle

    Read group data.

  • groups.postGroupGroupTitle

    Modify group data.

  • groups.putGroupGroupTitle

    Write group data.

  • issueTrackers.deleteIssueTrackersIssueTrackerName

    Delete an issue tracker.

  • issueTrackers.getIssueTrackers

    Get the list of issue trackers.

  • issueTrackers.getIssueTrackersIssueTrackerName

    Show an issue tracker.

  • issueTrackers.getIssueTrackersIssueTrackerNameIssuesIssueName

    Show an issue of an issue tracker.

  • issueTrackers.postIssueTrackers

    Create an issue tracker.

  • issueTrackers.putIssueTrackersIssueTrackerName

    Update the issue tracker given as path parameter. If it is not found, create it.

  • person.deletePersonLoginTokenId

    Delete a token of the specified person.

  • person.getPerson

    List all people.

  • person.getPersonLogin

    Get details about a person

  • person.getPersonLoginGroup

    List the groups the person belongs to.

  • person.getPersonLoginToken

    List the authentication tokens of a person.

  • person.postPerson

    Allows executing command on the person endpoint.

    As of now, the only command allowed is 'register'.

  • person.postPersonLogin

    Perform changes on a registered person

  • person.postPersonLoginToken

    Create a new authentication token for a person.

    The token may be limited to a specific package. In this case the query parameters project and package should be provided.

    With an empty request body, a token of the default kind 'runservice' is created.

  • person.postPersonRegister

    Registers a new person

  • person.putPersonLogin

    Update person

  • publishedBinaries.getPublished

    Get a list of all the projects, all of them are considered published.

  • publishedBinaries.getPublishedProjectName

    Get a list of the repositories of the project that already have published binaries.

  • publishedBinaries.getPublishedProjectNameRepositoryName

    Get a list of architectures' directories and other files (.repo, .ymp, etc.) present at the level project/repository of the directory tree where the published binaries are stored.

  • publishedBinaries.getPublishedProjectNameRepositoryNameArchitectureName

    Get a list of binaries and other files present at the level project/repository/architecture of the directory tree as a result of successful building and publishing processes.

  • publishedBinaries.getPublishedProjectNameRepositoryNameArchitectureNameBinaryFilename

    Allow to download the binary file that was published and stored under the directory given by project/repository/architecture/. Can response with Media Types like application/x-rpm, text/xml, etc. NOTE: Use this only if you absolutely have to, as it doesn't use the redirector.

  • publishedBinaries.getPublishedProjectNameRepositoryNameArchitectureNameBinaryFilenameViewYmp

    Generate a ymp pattern, which contains the list of packages needed for intalling certain software without having to create dependencies between them. Read more about patterns .

  • publishedBinaries.getPublishedProjectNameRepositoryNameViewStatus

    Get information about the build process (build id, start time, etc.) for the pair project and repository.

  • request.deleteRequestId

    Delete a given request.

  • request.getRequest

    Get a simple directory listing of all requests

  • request.getRequestId

    Show details about a specified request.

  • request.getRequestViewCollection

    Get a collection of requests for a specified target. NOTE: You need to set at least one of the following parameters in order to use this endpoint:

    • user
    • project
    • package
    • states
    • types
    • ids
  • request.postRequest

    Create a request

  • request.postRequestId

    Apply certain actions on a specified request.

  • request.postRequestIdCmdDiff

    Get the diff for all packages affected by the request.

  • request.putRequestId

    Modify a given request.

    NOTE: Certain parts of a request can only be changed by admins.

  • workers.getWorkerArchitectureNameWorkerId

    Lists capabilites of a worker.

    This can be useful when checking for constraints.

    This operation is the same as GET /worker/capability/{architecture_name}:{worker_id}.

  • workers.getWorkerStatus

    Lists status of workers, running jobs, waiting jobs, status of the backend services and general statistics.

    Other ways to obtain the same information as with this endpoint are:

    • GET /worker/_status
    • GET /status/workerstatus
    • GET /build/_workerstatus
  • workers.postWorkerCmdCheckconstraints

    Given a project, package, repository and architecture, list workers which can build with that restrictions, and also match a constraints filter.

    This endpoint doesn't create or modify any data.

    More information about constraints can be found in the .

    This operation is the same as POST /worker/command/run?cmd=checkconstraints.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools