About this service

The Launchpad web service allows automated clients to access most of the functionality available on the Launchpad web site. For help getting started, see the help wiki.

This version of the web service removes unnecessary named operations. It was introduced in March 2010, and its end-of-life date is April 2015, the same as the server version of the Ubuntu release "Lucid Lynx".

Table of Contents

Top-level collections

Entry types

Top-level collections

branches

Interface representing the set of branches.

https://api.launchpad.net/1.0/branches

Standard method

GET
Response contains a branch collection.

Custom GET methods

getByUniqueName

Find a branch by its ~owner/product/name unique name.

Return None if no match was found.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getByUniqueName

The name of the operation being invoked.

unique_name

(required)

Branch unique name

Response contains an application/json representation of a branch.

getByUrl

Find a branch by URL.

Either from the external specified in Branch.url, from the URL on http://bazaar.launchpad.net/ or the lp: URL.

This is a frontend shim to IBranchLookup.getByUrl to allow it to be exported over the API. If you want to call this from within the Launchpad app, use the IBranchLookup version instead.

Return None if no match was found.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getByUrl

The name of the operation being invoked.

url

(required)

Branch URL

Response contains an application/json representation of a branch.

getByUrls

Finds branches by URL.

Either from the external specified in Branch.url, from the URL on http://bazaar.launchpad.net/, or from the lp: URL.

This is a frontend shim to IBranchLookup.getByUrls to allow it to be exported over the API. If you want to call this from within the Launchpad app, use the IBranchLookup version instead.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: getByUrls

The name of the operation being invoked.

urls

(required)

A list of URLs of branches

These can be URLs external to Launchpad, lp: URLs, or http://bazaar.launchpad.net/ URLs, or any mix of all these different kinds.

Response (application/json)

A dictionary mapping URLs to branches. If the URL has no associated branch, the URL will map to None.

(back to Table of Contents)

bug_trackers

A set of IBugTracker's.

Each BugTracker is a distinct instance of a bug tracking tool. For example, bugzilla.mozilla.org is distinct from bugzilla.gnome.org.

https://api.launchpad.net/1.0/bug_trackers

Standard method

GET
Response contains a bug_tracker collection.

Custom GET methods

getByName

Get a BugTracker by its name.

If no tracker with the given name exists, return default.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getByName

The name of the operation being invoked.

name

(required)

The bug tracker name

Response contains an application/json representation of a bug_tracker.

queryByBaseURL

Return one or None BugTracker's by baseurl

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: queryByBaseURL

The name of the operation being invoked.

base_url

(required)

The base URL of the bug tracker

Response contains an application/json representation of a bug_tracker.

Custom POST methods

ensureBugTracker

Make sure that there is a bugtracker for the given base url.

If not, create one using the given attributes.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: ensureBugTracker

The name of the operation being invoked.

base_url

(required)

Location

The top-level URL for the bug tracker, or an upstream email address. This must be accurate so that Launchpad can link to external bug reports.

bug_tracker_type

One of:

  • Bugzilla
  • Debbugs
  • Roundup
  • Trac
  • SourceForge or SourceForge derivative
  • Mantis
  • Request Tracker (RT)
  • Email Address
  • Savane
  • PHP Project Bugtracker
  • Google Code

Bug Tracker Type

contact_details

Contact details

The contact details for the external bug tracker (so that, for example, its administrators can be contacted about a security breach).

name

Name

A URL-friendly name for the bug tracker, such as "mozilla-bugs".

summary

Summary

A brief introduction or overview of this bug tracker instance.

title

Title

A descriptive label for this tracker to show in listings.

On success, the response status will be 201 and the Location header will contain the link to the newly created bug_tracker.

(back to Table of Contents)

bugs

Application root for malone.

https://api.launchpad.net/1.0/bugs

Standard method

GET
Response contains a bug collection.

Custom POST methods

createBug

Create a bug (with an appropriate bugtask) and return it.

Things to note when using this factory:

  • The reporter will be subscribed to the bug.
  • Only people that the project shares with will see the bug when the bug's information type is Proprietary, Private, or Private Security.
Parameters
ParameterValueDescription

ws.op

(required)

Fixed: createBug

The name of the operation being invoked.

description

(required)

Description

A detailed description of the problem,
including the steps required to reproduce it.

information_type

One of:

  • Public
  • Public Security
  • Private Security
  • Private
  • Proprietary
  • Embargoed

Information Type

The type of information contained in this bug report.

private

This bug report should be private

Private bug reports are visible only to their subscribers.

security_related

This bug is a security vulnerability.

tags

Tags

Space-separated keywords for classifying this bug report.

target

(required)

Link to a bug_target.

The project, distribution or source package that has this bug.

title

(required)

Summary

A one-line summary of the problem.

On success, the response status will be 201 and the Location header will contain the link to the newly created bug.

(back to Table of Contents)

builders

Collections of builders.

IBuilderSet provides access to all Builders in the system, and also acts as a Factory to allow the creation of new Builders. Methods on this interface should deal with the set of Builders: methods that affect a single Builder should be on IBuilder.

https://api.launchpad.net/1.0/builders

Standard method

GET
Response contains a builder collection.

Custom GET methods

getByName

Retrieve a builder by name

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getByName

The name of the operation being invoked.

name

(required)

Builder name

Response contains an application/json representation of a builder.

(back to Table of Contents)

countries

A container for countries.

https://api.launchpad.net/1.0/countries

Standard method

GET
Response contains a country collection.

Custom GET methods

getByCode

Return a country by its code.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getByCode

The name of the operation being invoked.

code

(required)

Code

Response contains an application/json representation of a country.

getByName

Return a country by its name.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getByName

The name of the operation being invoked.

name

(required)

Name

Response contains an application/json representation of a country.

(back to Table of Contents)

cves

The set of ICve objects.

https://api.launchpad.net/1.0/cves

Standard method

GET
Response contains a cve collection.
(back to Table of Contents)

distributions

Interface for DistrosSet

https://api.launchpad.net/1.0/distributions

Standard method

GET
Response contains a distribution collection.
(back to Table of Contents)

languages

The collection of languages.

The standard get method will return only the visible languages. If you want to access all languages known to Launchpad, use the getAllLanguages method.

https://api.launchpad.net/1.0/languages

Standard method

GET
Response contains a language collection.

Custom GET methods

getAllLanguages

Return a result set of all ILanguages from Launchpad.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getAllLanguages

The name of the operation being invoked.

Response contains an application/json representation of a language collection .

(back to Table of Contents)

packagesets

An interface for multiple package sets.

https://api.launchpad.net/1.0/packagesets

Standard method

GET
Response contains a packageset collection.

Custom GET methods

getByName

Return the single package set with the given name (if any).

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getByName

The name of the operation being invoked.

distroseries

Link to a distro_series.

Distroseries

The distribution series to which the packageset is related.

name

(required)

Package set name

Response contains an application/json representation of a packageset.

getBySeries

Return the package sets associated with the given distroseries.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getBySeries

The name of the operation being invoked.

distroseries

(required)

Link to a distro_series.

Distribution series

The distroseries to which this package set is related.

Response contains an application/json representation of a packageset collection .

setsIncludingSource

Get the package sets that include this source package.

Return all package sets that directly or indirectly include the given source package name.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: setsIncludingSource

The name of the operation being invoked.

direct_inclusion

distroseries

Link to a distro_series.

Distribution series

The distroseries to which this package set is related.

sourcepackagename

(required)

Source package name

Response contains an application/json representation of a packageset collection .

Custom POST methods

new

Create a new package set.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: new

The name of the operation being invoked.

description

(required)

Package set description

distroseries

Link to a distro_series.

Distroseries

The distribution series to which the packageset is related.

name

(required)

Valid package set name

owner

(required)

Link to a person.

Person

The person who owns this package set.

related_set

Link to a packageset.

Related package set

The new package set will share the package set group with this one.

On success, the response status will be 201 and the Location header will contain the link to the newly created packageset.

(back to Table of Contents)

people

The set of Persons.

https://api.launchpad.net/1.0/people

Standard method

GET
Response contains a person collection.

Custom GET methods

find

Return all non-merged Persons and Teams whose name, displayname or email address match <text>.

The results will be ordered using the default ordering specified in Person._defaultOrder.

While we don't have Full Text Indexes in the emailaddress table, we'll be trying to match the text only against the beginning of an email address.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: find

The name of the operation being invoked.

text

(required)

Search text

Response contains an application/json representation of a person collection .

findPerson

Return all non-merged Persons with at least one email address whose name, displayname or email address match <text>.

If text is an empty string, all persons with at least one email address will be returned.

The results will be ordered using the default ordering specified in Person._defaultOrder.

If exclude_inactive_accounts is True, any accounts whose account_status is any of INACTIVE_ACCOUNT_STATUSES will not be in the returned set.

If must_have_email is True, only people with one or more email addresses are returned.

While we don't have Full Text Indexes in the emailaddress table, we'll be trying to match the text only against the beginning of an email address.

If created_before or created_after are not None, they are used to restrict the search to the dates provided.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: findPerson

The name of the operation being invoked.

created_after

Created after

created_before

Created before

text

(required)

Search text

Response contains an application/json representation of a person collection .

findTeam

Return all Teams whose name, displayname or email address match <text>.

The results will be ordered using the default ordering specified in Person._defaultOrder.

While we don't have Full Text Indexes in the emailaddress table, we'll be trying to match the text only against the beginning of an email address.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: findTeam

The name of the operation being invoked.

text

(required)

Search text

Response contains an application/json representation of a person collection .

getByEmail

Return the person with the given email address.

Return None if there is no person with the given email address.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getByEmail

The name of the operation being invoked.

email

(required)

Response contains an application/json representation of a person.

Custom POST methods

newTeam

Create and return a new Team with given arguments.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: newTeam

The name of the operation being invoked.

default_membership_period

Subscription period

Number of days a new subscription lasts before expiring. You can customize the length of an individual subscription when approving it. Leave this empty or set to 0 for subscriptions to never expire.

default_renewal_period

Self renewal period

Number of days members can renew their own membership. The number can be from 1 to 3650 (10 years).

display_name

(required)

Display Name

Your name as you would like it displayed throughout Launchpad. Most people use their full name here.

membership_policy

One of:

  • Open Team
  • Delegated Team
  • Moderated Team
  • Restricted Team

Membership policy

name

(required)

Name

A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.

subscription_policy

One of:

  • Open Team
  • Delegated Team
  • Moderated Team
  • Restricted Team

Membership policy

Obsolete: use membership_policy

team_description

Team Description

Obsolete. Use description.

On success, the response status will be 201 and the Location header will contain the link to the newly created team.

(back to Table of Contents)

processors

Operations related to Processor instances.

https://api.launchpad.net/1.0/processors

Standard method

GET
Response contains a processor collection.
(back to Table of Contents)

project_groups

The collection of projects.

https://api.launchpad.net/1.0/project_groups

Standard method

GET
Response contains a project_group collection.

Custom GET methods

Search through the Registry database for projects that match the query terms. text is a piece of text in the title / summary / description fields of project (and possibly product). soyuz, bazaar, malone etc are hints as to whether the search should be limited to projects that are active in those Launchpad applications.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: search

The name of the operation being invoked.

text

Search text

Response contains an application/json representation of a project_group collection .

(back to Table of Contents)

projects

https://api.launchpad.net/1.0/projects

Standard method

GET
Response contains a project collection.

Custom GET methods

latest

Return the latest projects registered in Launchpad.

The supplied user determines which objects are visible.

If the quantity is not specified or is a value that is not 'None' then the set of projects returned is limited to that value (the default quantity is 5). If quantity is 'None' then all projects are returned. For the web service it is not possible to specify the quantity, so all projects are returned, latest first.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: latest

The name of the operation being invoked.

Response contains an application/json representation of a project collection .

Return an iterator over products that need to be reviewed.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: licensing_search

The name of the operation being invoked.

active

Is the project active

created_after

Created after date

created_before

Created before date

has_subscription

Has a commercial subscription

licenses

Licenses

project_reviewed

Is the project licence reviewed

search_text

Search text

subscription_expires_after

Subscription expires after

subscription_expires_before

Subscription expired before

subscription_modified_after

Subscription modified after

subscription_modified_before

Subscription modified before

Response contains an application/json representation of a project collection .

Search through the Registry database for products that match the query terms. text is a piece of text in the title / summary / description fields of product.

This call eager loads data appropriate for web API; caution may be needed for other callers.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: search

The name of the operation being invoked.

text

Search text

Response contains an application/json representation of a project collection .

Custom POST methods

new_project

Create and return a brand new Product.

See IProduct for a description of the parameters.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: new_project

The name of the operation being invoked.

bug_supervisor

Link to a person.

Bug Supervisor

The Launchpad id of the person or team (preferred) responsible for bug management.

description

Description

Details about the project's work, highlights, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.

display_name

(required)

Display Name

The name of the project as it would appear in a
paragraph.

download_url

Download URL

The full URL where downloads for this project
are located, if available. Please include the http://

driver

Link to a person.

Driver

This person or team will be able to set feature goals for and approve bug targeting or backporting for ANY major series in this project. You might want to leave this blank and just appoint a team for each specific series, rather than having one project team that does it all.

freshmeat_project

Freshmeat Project

The Freshmeat project name for
this project, if it is in freshmeat.

home_page_url

Homepage URL

The project home page. Please include
the http://

license_info

Description of additional licences

Description of licences that do not appear in the list above.

licenses

Licences

name

(required)

Name

At least one lowercase letter or number, followed by letters, numbers, dots, hyphens or pluses. Keep this name short; it is used in URLs as shown above.

programming_lang

Programming Languages

A comma delimited list of programming
languages used for this project.

project_group

Link to a project_group.

Part of

Project group. This is an overarching initiative that includes several related projects. For example, the Mozilla Project produces Firefox, Thunderbird and Gecko. This information is used to group those projects in a coherent way. If you make this project part of a group, the group preferences and decisions around bug tracking, translation and security policy will apply to this project.

project_reviewed

Project reviewed

Whether or not this project has been reviewed. If you looked at the project and how it uses Launchpad, you reviewed it.

registrant

Link to a person.

Registrant

This person registered the project in Launchpad.

screenshots_url

Screenshots URL

The full URL for screenshots of this project,
if available. Please include the http://

sourceforge_project

Sourceforge Project

The SourceForge project name for
this project, if it is in sourceforge.

summary

(required)

Summary

A short paragraph to introduce the project's work.

title

(required)

Title

The project title. Should be just a few words.

wiki_url

Wiki URL

The full URL of this project's wiki, if it has
one. Please include the http://

On success, the response status will be 201 and the Location header will contain the link to the newly created project.

(back to Table of Contents)

questions

A utility that contain all the questions published in Launchpad.

https://api.launchpad.net/1.0/questions

Standard method

GET
Response contains a question collection.
(back to Table of Contents)

temporary_blobs

A tool to create temporary blobs.

https://api.launchpad.net/1.0/temporary_blobs

Standard method

GET
Response contains a temporary_blob collection.

Custom GET methods

fetch

Retrieve a TemporaryBlobStorage by uuid.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: fetch

The name of the operation being invoked.

token

(required)

UUID

(back to Table of Contents)

translation_groups

A container for translation groups.

https://api.launchpad.net/1.0/translation_groups

Standard method

GET
Response contains a translation_group collection.
(back to Table of Contents)

translation_import_queue_entries

A set of files to be imported into Rosetta.

https://api.launchpad.net/1.0/translation_import_queue_entries

Standard method

GET
Response contains a translation_import_queue_entry collection.

Custom GET methods

getAllEntries

Return all entries this import queue has.

If any of target, status or file_extension are given, the returned entries are filtered based on those values.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getAllEntries

The name of the operation being invoked.

import_status

One of:

  • Approved
  • Imported
  • Deleted
  • Failed
  • Needs Review
  • Blocked
  • Needs Information

The status of the import.

Response contains an application/json representation of a translation_import_queue_entry collection .

getFirstEntryToImport

Return the first entry of the queue ready to be imported.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getFirstEntryToImport

The name of the operation being invoked.

target

Link to a object_with_translation_imports.

Response contains an application/json representation of a translation_import_queue_entry.

getRequestTargets

List Product`s and `DistroSeries with pending imports.

All returned items will implement IHasTranslationImports.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getRequestTargets

The name of the operation being invoked.

status

One of:

  • Approved
  • Imported
  • Deleted
  • Failed
  • Needs Review
  • Blocked
  • Needs Information

The status of the import.

Response contains an application/json representation of a object_with_translation_imports collection .

(back to Table of Contents)

Entry types

archive

Main Archive interface.

https://api.launchpad.net/1.0/<distribution>/+archive/<archive.name>

Default representation (application/json)

Key Value Description

authorized_size

(writeable)

Authorized size

Maximum size, in MiB, allowed for the archive.

dependencies_collection_link

(read-only)

Link to a archive_dependency collection.

Archive dependencies recorded for this archive.

description

(writeable)

Description

A short description of the archive. URLs are allowed and will be rendered as links.

displayname

(writeable)

Display name

A short title for the archive.

distribution_link

(writeable)

Link to a distribution.

The distribution that uses or is used by this archive.

external_dependencies

(writeable)

External dependencies

Newline-separated list of repositories to be used to retrieve any external build dependencies when building packages in the archive, in the format: deb http[s]://[user:pass@]<host>[/path] %(series)s[-pocket] [components] The series variable is replaced with the series name of the context build. NOTE: This is for migration of OEM PPAs only!

http_etag

(read-only)

The value of the HTTP ETag for this resource.

name

(writeable)

Name

At least one lowercase letter or number, followed by letters, numbers, dots, hyphens or pluses. Keep this name short; it is used in URLs.

owner_link

(writeable)

Link to a person.

Owner

The archive owner.

private

(writeable)

Private

Restrict access to the archive to its owner and subscribers. This can only be changed if the archive has never had any sources published.

relative_build_score

(writeable)

Relative build score

A delta to apply to all build scores for the archive. Builds with a higher score will build sooner.

require_virtualized

(writeable)

Require virtualized builders

Only build the archive's packages on virtual builders.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

signing_key_fingerprint

(writeable)

Archive signing key fingerprint

A OpenPGP signing key fingerprint (40 chars) for this PPA or None if there is no signing key available.

suppress_subscription_notifications

(writeable)

Suppress subscription notifications

Whether subscribers to private PPAs get emails about their subscriptions. Has no effect on a public PPA.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

checkUpload

Wrapper around checkUpload for the web service API.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: checkUpload

component

(required)

Component

distroseries

(required)

Link to a distro_series.

The distro series

person

(required)

Link to a person.

pocket

(required)

One of:

  • Release
  • Security
  • Updates
  • Proposed
  • Backports

Pocket

The pocket into which this entry is published

sourcepackagename

(required)

Source package name

strict_component

Strict component

getArchiveDependency

Return the IArchiveDependency object for the given dependency.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getArchiveDependency

dependency

(required)

Link to a archive.

Response contains an application/json representation of a archive_dependency.

getBuildCounters

Return a dictionary containing the build counters for an archive.

This is necessary currently because the IArchive.failed_builds etc. counters are not in use.

The returned dictionary contains the follwoing keys and values:

  • 'total': total number of builds (includes SUPERSEDED);
  • 'pending': number of builds in BUILDING or NEEDSBUILD state;
  • 'failed': number of builds in FAILEDTOBUILD, MANUALDEPWAIT, CHROOTWAIT and FAILEDTOUPLOAD state;
  • 'succeeded': number of SUCCESSFULLYBUILT builds.
  • 'superseded': number of SUPERSEDED builds.
Parameters
Parameter Value Description

ws.op

(required)

Fixed: getBuildCounters

include_needsbuild

Include builds with state NEEDSBUILD

Response (application/json)

a dictionary with the 4 keys specified above.

getBuildRecords

Return build records in the context it is implemented.

It excludes build records generated by Gina (imported from a external repository), where IBuild.datebuilt is null and IBuild.buildstate is BuildStatus.FULLYBUILT.

The result is simply not filtered if the optional filters are omitted by call sites.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getBuildRecords

build_state

One of:

  • Needs building
  • Successfully built
  • Failed to build
  • Dependency wait
  • Chroot problem
  • Build for superseded Source
  • Currently building
  • Failed to upload
  • Uploading build
  • Cancelling build
  • Cancelled build

Build status

The status of this build record

pocket

One of:

  • Release
  • Security
  • Updates
  • Proposed
  • Backports

Pocket

The pocket into which this entry is published

source_name

Source package name

Response contains an application/json representation of a build collection .

getBuildSummariesForSourceIds

Return a dictionary containing a summary of the build statuses.

Only information for sources belonging to the current archive will be returned. See IPublishingSet.getBuildStatusSummariesForSourceIdsAndArchive() for details.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: getBuildSummariesForSourceIds

source_ids

(required)

A list of source publishing history record ids.

Response (application/json)

A dict consisting of the overall status summaries for the given ids that belong in the archive.

getComponentsForQueueAdmin

Return IArchivePermission for the person's queue admin components.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getComponentsForQueueAdmin

person

(required)

Link to a person.

Response contains an application/json representation of a archive_permission collection .

getPackagesetsForSource

All package set based permissions for the given source.

This method is meant to aid the process of "debugging" package set based archive permission since It allows the listing of permissions for the given source package in this archive (irrespective of the principal).

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getPackagesetsForSource

direct_permissions

Ignore package set hierarchy

sourcepackagename

(required)

Source package name

Response contains an application/json representation of a archive_permission collection .

getPackagesetsForSourceUploader

The package set based permissions for a given source and uploader.

Return the IArchivePermission records that
  • apply to this archive

  • relate to
    • package sets that include the given source package name
    • the given person
Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getPackagesetsForSourceUploader

person

(required)

Link to a person.

sourcepackagename

(required)

Source package name

Response contains an application/json representation of a archive_permission collection .

getPackagesetsForUploader

The ArchivePermission records for the person's package sets.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getPackagesetsForUploader

person

(required)

Link to a person.

Response contains an application/json representation of a archive_permission collection .

getPermissionsForPerson

Return the IArchivePermission records applicable to the person.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getPermissionsForPerson

person

(required)

Link to a person.

Response contains an application/json representation of a archive_permission collection .

getPublishedBinaries

All IBinaryPackagePublishingHistory target to this archive.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getPublishedBinaries

binary_name

Binary Package Name

created_since_date

Created Since Date

Return entries whose date_created is greater than or equal to this date.

distro_arch_series

Link to a distro_arch_series.

Distro Arch Series

exact_match

Whether or not to filter binary names by exact matching.

ordered

Ordered

Return ordered results by default, but specifying False will return results more quickly.

pocket

One of:

  • Release
  • Security
  • Updates
  • Proposed
  • Backports

Pocket

The pocket into which this entry is published

status

One of:

  • Pending
  • Published
  • Superseded
  • Deleted
  • Obsolete

Package Publishing Status

The status of this publishing record

version

Version

Response contains an application/json representation of a binary_package_publishing_history collection .

getPublishedSources

All ISourcePackagePublishingHistory target to this archive.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getPublishedSources

component_name

Component name

created_since_date

Created Since Date

Return entries whose date_created is greater than or equal to this date.

distro_series

Link to a distro_series.

Distroseries name

exact_match

Exact Match

Whether or not to filter source names by exact matching.

pocket

One of:

  • Release
  • Security
  • Updates
  • Proposed
  • Backports

Pocket

The pocket into which this entry is published

source_name

Source package name

status

One of:

  • Pending
  • Published
  • Superseded
  • Deleted
  • Obsolete

Package Publishing Status

The status of this publishing record

version

Version

Response contains an application/json representation of a source_package_publishing_history collection .

getQueueAdminsForComponent

Return IArchivePermission records for authorised queue admins.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getQueueAdminsForComponent

component_name

(required)

Component Name

Response contains an application/json representation of a archive_permission collection .

getUploadersForComponent

Return IArchivePermission records for the component's uploaders.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getUploadersForComponent

component_name

Component Name

Response contains an application/json representation of a archive_permission collection .

getUploadersForPackage

Return IArchivePermission records for the package's uploaders.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getUploadersForPackage

source_package_name

(required)

Source Package Name

Response contains an application/json representation of a archive_permission collection .

getUploadersForPackageset

The ArchivePermission records for uploaders to the package set.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getUploadersForPackageset

direct_permissions

Ignore package set hierarchy

packageset

(required)

Link to a packageset.

Package set

Response contains an application/json representation of a archive_permission collection .

isSourceUploadAllowed

True if the person is allowed to upload the given source package.

Return True if there exists a permission that combines
  • this archive
  • a package set that includes the given source package name
  • the given person or a team he is a member of

If the source package name is included by any package set with an explicit permission then only such explicit permissions will be considered.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: isSourceUploadAllowed

distroseries

Link to a distro_series.

The distro series

person

(required)

Link to a person.

sourcepackagename

(required)

Source package name

Response (application/json)

True if the person is allowed to upload the source package.

Custom POST methods

deleteComponentUploader

Revoke permission for the person to upload to the component.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: deleteComponentUploader

component_name

(required)

Component Name

person

(required)

Link to a person.
deletePackageUploader

Revoke permission for the person to upload the package.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: deletePackageUploader

person

(required)

Link to a person.

source_package_name

(required)

Source Package Name

deletePackagesetUploader

Revoke upload permissions for a person.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: deletePackagesetUploader

explicit

Explicit

packageset

(required)

Link to a packageset.

Package set

person

(required)

Link to a person.
deleteQueueAdmin

Revoke permission for the person to administer distroseries queues.

The supplied person will lose permission to administer the distroseries queue for packages in the supplied component.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: deleteQueueAdmin

component_name

(required)

Component Name

person

(required)

Link to a person.
newComponentUploader

Add permission for a person to upload to a component.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: newComponentUploader

component_name

(required)

Component Name

person

(required)

Link to a person.

On success, the response status will be 201 and the Location header will contain the link to the newly created archive_permission.

newPackageUploader

Add permisson for a person to upload a package to this archive.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: newPackageUploader

person

(required)

Link to a person.

source_package_name

(required)

Source Package Name

On success, the response status will be 201 and the Location header will contain the link to the newly created archive_permission.

newPackagesetUploader

Add a package set based permission for a person.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: newPackagesetUploader

explicit

Explicit

packageset

(required)

Link to a packageset.

Package set

person

(required)

Link to a person.

On success, the response status will be 201 and the Location header will contain the link to the newly created archive_permission.

newQueueAdmin

Add permission for a person to administer a distroseries queue.

The supplied person will gain permission to administer the distroseries queue for packages in the supplied component.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: newQueueAdmin

component_name

(required)

Component Name

person

(required)

Link to a person.

On success, the response status will be 201 and the Location header will contain the link to the newly created archive_permission.

newSubscription

Create a new subscribtion to this archive.

Create an ArchiveSubscriber record which allows an IPerson to access a private repository.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: newSubscription

date_expires

Date of Expiration

The timestamp when the subscription will expire.

description

Description

Free text describing this subscription.

subscriber

(required)

Link to a person.

Subscriber

The person who is subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created archive_subscriber.

syncSource

Synchronise (copy) a single named source into this archive.

DEPRECATED: syncSource and syncSources are deprecated, and will be removed entirely in the future. Use the asynchronous copyPackage method instead, and poll getPublishedSources if you need to await completion.

Copy a specific version of a named source to the destination archive if necessary.

If the source distribution has a development series alias, then it may be used as the source distroseries name; but note that this will always be resolved to the true development series of that distribution, which may not match the alias in the published source archive.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: syncSource

from_archive

(required)

Link to a archive.

include_binaries

Include Binaries

Whether or not to copy binaries already built for this source

source_name

(required)

Source package name

to_pocket

(required)

Pocket name

to_series

Distroseries name

version

(required)

Version

syncSources

Synchronise (copy) named sources into this archive from another.

DEPRECATED: syncSource and syncSources are deprecated, and will be removed entirely in the future. Use the asynchronous copyPackage method instead, and poll getPublishedSources if you need to await completion.

It will copy the most recent PUBLISHED versions of the named sources to the destination archive if necessary.

This operation will only succeeds when all requested packages are synchronised between the archives. If any of the requested copies cannot be performed, the whole operation will fail. There will be no partial changes of the destination archive.

If the source or target distribution has a development series alias, then it may be used as the source or target distroseries name respectively; but note that this will always be resolved to the true development series of that distribution, which may not match the alias in the respective published archives.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: syncSources

from_archive

(required)

Link to a archive.

from_series

Distroseries name

The distro series to copy packages from.

include_binaries

Include Binaries

Whether or not to copy binaries already built for this source

source_names

(required)

Source package names

to_pocket

(required)

Pocket name

to_series

Distroseries name

The distro series to copy packages into.

(back to Table of Contents)

archive_dependency

ArchiveDependency interface.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

archive_link

(read-only)

Link to a archive.

Target archive

The archive affected by this dependecy.

component_name

(read-only)

Component name

date_created

(read-only)

Instant when the dependency was created.

dependency_link

(read-only)

Link to a archive.

The archive set as a dependency.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

pocket

(read-only)

One of:

  • Release
  • Security
  • Updates
  • Proposed
  • Backports

Pocket

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

title

(read-only)

Archive dependency title.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

archive_permission

The interface for ArchivePermission.

https://api.launchpad.net/1.0/<archive.distribution>/+archive/<archive.name>/+name/person.name.[component or source package].name

Default representation (application/json)

Key Value Description

archive_link

(writeable)

Link to a archive.

Archive

The archive that this permission is for.

component_name

(writeable)

Component Name

date_created

(writeable)

Date Created

The timestamp when the permission was created.

distro_series_name

(writeable)

The name of the distro series associated with the package set.

distroseries_link

(writeable)

Link to a distro_series.

Distro series

The distro series that this permission is for (only for pocket permissions).

explicit

(writeable)

Explicit

Set this flag for package sets with high-profile packages requiring specialist skills for proper handling.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

package_set_name

(writeable)

Package set name

permission

(writeable)

The permission type being granted.

person_link

(writeable)

Link to a person.

Person

The person or team being granted the permission.

pocket

(writeable)

One of:

  • Release
  • Security
  • Updates
  • Proposed
  • Backports

Pocket

The pocket that this permission is for.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

source_package_name

(writeable)

Source Package Name

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

archive_subscriber

An interface for archive subscribers.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

archive_link

(read-only)

Link to a archive.

Archive

The archive for this subscription.

date_created

(read-only)

Date Created

The timestamp when the subscription was created.

date_expires

(writeable)

Date of Expiration

The timestamp when the subscription will expire.

description

(writeable)

Description

Free text describing this subscription.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

registrant_link

(read-only)

Link to a person.

Registrant

The person who registered this subscription.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

status

(writeable)

One of:

  • Active
  • Expired
  • Cancelled

Status

The status of this subscription.

subscriber_link

(read-only)

Link to a person.

Subscriber

The person who is subscribed.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

binary_package_publishing_history

A binary package publishing record.

https://api.launchpad.net/1.0/<distribution.name>/+archive/<binary_package.name>/+binarypub/<id>

Default representation (application/json)

Key Value Description

architecture_specific

(read-only)

Architecture Specific

archive_link

(read-only)

Link to a archive.

Archive

The context archive for this publication.

binary_package_name

(read-only)

Binary Package Name

binary_package_version

(read-only)

Binary Package Version

component_name

(read-only)

Component Name

date_created

(writeable)

Date Created

The date on which this record was created

date_made_pending

(writeable)

Date Made Pending

The date on which this record was set as pending removal

date_published

(writeable)

Date Published

The date on which this record was published

date_removed

(writeable)

Date Removed

The date on which this record was removed from the published set

date_superseded

(writeable)

Date Superseded

The date on which this record was marked superseded

display_name

(writeable)

Display Name

Text representation of the current record.

distro_arch_series_link

(writeable)

Link to a distro_arch_series.

Distro Arch Series

The distroarchseries being published into

http_etag

(read-only)

The value of the HTTP ETag for this resource.

phased_update_percentage

(read-only)

The percentage of users for whom this package should be recommended, or None to publish the update for everyone

pocket

(read-only)

One of:

  • Release
  • Security
  • Updates
  • Proposed
  • Backports

Pocket

The pocket into which this entry is published

priority_name

(read-only)

Priority Name

removal_comment

(writeable)

Removal Comment

Reason why this publication is going to be removed.

removed_by_link

(writeable)

Link to a person.

Removed By

The Person responsible for the removal

resource_type_link

(read-only)

The link to the WADL description of this resource.

scheduled_deletion_date

(writeable)

Scheduled Deletion Date

The date on which this record is scheduled for deletion

section_name

(read-only)

Section Name

self_link

(read-only)

The canonical link to this resource.

status

(writeable)

One of:

  • Pending
  • Published
  • Superseded
  • Deleted
  • Obsolete

Status

The status of this publishing record

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getDailyDownloadTotals

Get the daily download counts for this binary.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: getDailyDownloadTotals

end_date

End date

start_date

Start date

getDownloadCount

Get the download count of this binary package in this archive.

This is currently only meaningful for PPAs.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: getDownloadCount

getDownloadCounts

Get detailed download counts for this binary.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getDownloadCounts

end_date

End date

start_date

Start date

Response contains an application/json representation of a binary_package_release_download_count collection .

Custom POST methods

requestDeletion

Delete this source and its binaries.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: requestDeletion

removal_comment

Removal comment

(back to Table of Contents)

binary_package_release_download_count

Daily download count of a binary package release in an archive.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

archive_link

(read-only)

Link to a archive.

Archive

binary_package_name

(read-only)

Binary package name

binary_package_version

(read-only)

Binary package version

count

(read-only)

Number of downloads

country_link

(read-only)

Link to a country.

Country

day

(read-only)

Day of the downloads

http_etag

(read-only)

The value of the HTTP ETag for this resource.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

branch

A Bazaar branch.

https://api.launchpad.net/1.0/~<author.name>/<project.name>/<name>

Default representation (application/json)

Key Value Description

branch_format

(read-only)

One of:

  • !Unrecognized!
  • Fake Bazaar Branch 4 marker
  • Bazaar-NG Branch Reference Format 1
  • Bazaar-NG branch format 5
  • Bazaar Branch Format 6 (bzr 0.15)
  • Bazaar Branch Format 7 (needs bzr 1.6)
  • Bazaar Branch Format 8 (needs bzr 1.15)
  • Bazaar-NG Loom branch format 1
  • Bazaar-NG Loom branch format 6
  • Bazaar-NG Loom branch format 7

Branch Format

branch_type

(read-only)

One of:

  • Hosted
  • Mirrored
  • Imported
  • Remote

Branch Type

bzr_identity

(read-only)

Bazaar Identity

The bzr branch path as accessed by Launchpad. If the branch is associated with a product as the primary development focus, then the result should be lp:product. If the branch is related to a series, then lp:product/series. Otherwise the result is lp:~user/product/branch-name.

code_import_link

(writeable)

Link to a code_import.

The associated CodeImport, if any.

control_format

(read-only)

One of:

  • !Unrecognized!
  • Bazaar-NG branch, format 0.0.4
  • Bazaar-NG branch, format 5
  • Bazaar-NG branch, format 6
  • Bazaar-NG meta directory, format 1
  • Bazaar meta directory, format 1 (with colocated branches)

Control Directory

date_created

(read-only)

Date Created

date_last_modified

(writeable)

Date Last Modified

dependent_branches_collection_link

(read-only)

Link to a branch_merge_proposal collection.

Dependent Branches

A collection of the merge proposals that are dependent on this branch.

description

(writeable)

Description

A short description of the changes in this branch.

display_name

(read-only)

Display name

The branch unique_name.

explicitly_private

(writeable)

Keep branch confidential

Make this branch visible only to its subscribers.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

information_type

(read-only)

One of:

  • Public
  • Public Security
  • Private Security
  • Private
  • Proprietary
  • Embargoed

Information Type

The type of information contained in this branch.

landing_candidates_collection_link

(read-only)

Link to a branch_merge_proposal collection.

Landing Candidates

A collection of the merge proposals where this branch is the target branch.

landing_targets_collection_link

(read-only)

Link to a branch_merge_proposal collection.

Landing Targets

A collection of the merge proposals where this branch is the source branch.

last_mirror_attempt

(read-only)

Last time a mirror of this branch was attempted.

last_mirrored

(read-only)

Last time this branch was successfully mirrored.

last_scanned

(read-only)

Last time this branch was successfully scanned.

last_scanned_id

(read-only)

Last scanned revision ID

The head revision ID of the branch when last successfully scanned.

lifecycle_status

(writeable)

One of:

  • Experimental
  • Development
  • Mature
  • Merged
  • Abandoned

Status

linked_bugs_collection_link

(read-only)

Link to a bug collection.

The bugs linked to this branch.

merge_queue_config

(writeable)

Name

A JSON string of configuration values to send to a branch merge robot.

merge_queue_link

(writeable)

Link to a branch_merge_queue.

Branch Merge Queue

The branch merge queue that manages merges for this branch.

mirror_status_message

(read-only)

The last message we got when mirroring this branch.

name

(writeable)

Name

Keep very short, unique, and descriptive, because it will be used in URLs. Examples: main, devel, release-1.0, gnome-vfs.

owner_link

(read-only)

Link to a person.

Owner

Either yourself or an exclusive team you are a member of. This controls who can modify the branch.

private

(read-only)

Branch is confidential

This branch is visible only to its subscribers.

project_link

(read-only)

Link to a project.

Project

The project this branch belongs to.

recipes_collection_link

(read-only)

Link to a source_package_recipe collection.

All recipes associated with the object.

registrant_link

(read-only)

Link to a person.

The user that registered the branch.

repository_format

(read-only)

One of:

  • !Unrecognized!
  • Fake Bazaar repository 4 marker
  • Fake Bazaar repository 5 marker
  • Fake Bazaar repository 6 marker
  • Bazaar-NG Repository format 7
  • Bazaar-NG Knit Repository Format 1
  • Bazaar Knit Repository Format 3 (bzr 0.15)
  • Bazaar Knit Repository Format 4 (bzr 1.0)
  • Bazaar pack repository format 1 (needs bzr 0.92)
  • Bazaar pack repository format 1 with subtree support (needs bzr 0.92)
  • Bazaar pack repository format 1 with rich root (needs bzr 1.0)
  • Bazaar RepositoryFormatKnitPack5 (bzr 1.6)
  • Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)
  • Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)
  • Bazaar RepositoryFormatKnitPack6 (bzr 1.9)
  • Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)
  • Bazaar development format 0 (needs bzr.dev from before 1.3)
  • Bazaar development format 0 with subtree support (needs bzr.dev from before 1.3)
  • Bazaar development format 1 (needs bzr.dev from before 1.6)
  • Bazaar development format 1 with subtree support (needs bzr.dev from before 1.6)
  • Bazaar development format 2 (needs bzr.dev from before 1.8)
  • Bazaar development format 2 with subtree support (needs bzr.dev from before 1.8)
  • Bazaar development format 8
  • Bazaar development format - group compression and chk inventory (needs bzr.dev from 1.14)
  • Bazaar development format - chk repository with bencode revision serialization (needs bzr.dev from 1.16)
  • Bazaar repository format 2a (needs bzr 1.16 or later)

Repository Format

resource_type_link

(read-only)

The link to the WADL description of this resource.

reviewer_link

(writeable)

Link to a person.

Review Team

The reviewer of a branch is the person or exclusive team that is responsible for reviewing proposals and merging into this branch.

revision_count

(read-only)

Revision count

The revision number of the tip of the branch.

self_link

(read-only)

The canonical link to this resource.

sourcepackage_link

(read-only)

Link to a source_package.

The ISourcePackage that this branch belongs to. None if not a package branch.

spec_links_collection_link

(read-only)

Link to a specification_branch collection.

Specification linked to this branch.

subscribers_collection_link

(read-only)

Link to a person collection.

Persons subscribed to this branch.

subscriptions_collection_link

(read-only)

Link to a branch_subscription collection.

BranchSubscriptions associated to this branch.

unique_name

(read-only)

Unique name

Unique name of the branch, including the owner and project names.

url

(writeable)

Branch URL

The external location where the Bazaar branch is hosted. It is None when the branch is hosted by Launchpad.

web_link

(read-only)

The canonical human-addressable web link to this resource.

whiteboard

(writeable)

Whiteboard

Notes on the current status of the branch.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

canBeDeleted

Can this branch be deleted in its current state.

A branch is considered deletable if it has no revisions and is not linked to any bugs, specs, productseries, or code imports.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: canBeDeleted

composePublicURL

Return a public URL for the branch using the given protocol.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: composePublicURL

scheme

(required)

URL scheme

getMergeProposals

Return matching BranchMergeProposals.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getMergeProposals

merged_revnos

status

A list of merge proposal statuses to filter by.

Response contains an application/json representation of a branch_merge_proposal collection .

getSubscription

Return the BranchSubscription for this person.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

The person to unsubscribe

Response contains an application/json representation of a branch_subscription.

isPersonTrustedReviewer

Return true if the reviewer is a trusted reviewer.

The reviewer is trusted if they are either own the branch, or are in the team that owns the branch, or they are in the review team for the branch.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: isPersonTrustedReviewer

reviewer

(required)

Link to a person.

A person for which the reviewer status is in question.

Custom POST methods

createMergeProposal

Create a new BranchMergeProposal with this branch as the source.

Both the target_branch and the prerequisite_branch, if it is there, must be branches with the same target as the source branch.

Personal branches (a.k.a. junk branches) cannot specify landing targets.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: createMergeProposal

commit_message

Commit message

Message to use when committing this merge.

initial_comment

Initial comment

Registrant's initial description of proposal.

needs_review

Needs review

If True the proposal needs review.Otherwise, it will be work in progress.

prerequisite_branch

Link to a branch.

review_types

reviewers

target_branch

(required)

Link to a branch.

On success, the response status will be 201 and the Location header will contain the link to the newly created branch_merge_proposal.

linkBug

Link a bug to this branch.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: linkBug

bug

(required)

Link to a bug.
linkSpecification

Link an ISpecification to a branch.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: linkSpecification

spec

(required)

Link to a specification.
requestMirror

Request that this branch be mirrored on the next run of the branch puller.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: requestMirror

setOwner

Set the owner of the branch to be new_owner.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: setOwner

new_owner

(required)

Link to a person.

The new owner of the branch.

setTarget

Set the target of the branch to be project or source_package.

Only one of project or source_package can be set, and if neither is set, the branch gets moved into the junk namespace of the branch owner.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: setTarget

project

Link to a project.

The project the branch belongs to.

source_package

Link to a source_package.

The source package the branch belongs to.

Errors
subscribe

Subscribe this person to the branch.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: subscribe

code_review_level

(required)

One of:

  • No email
  • Status changes only
  • Email about all changes

The level of code review notification emails.

max_diff_lines

(required)

One of:

  • Don't send diffs
  • 500 lines
  • 1000 lines
  • 5000 lines
  • Send entire diff

The max number of lines for diff email.

notification_level

(required)

One of:

  • No email
  • Branch attribute notifications only
  • Branch revision notifications only
  • Branch attribute and revision notifications

The level of notification to subscribe to.

person

(required)

Link to a person.

The person to subscribe.

Response contains an application/json representation of a branch_subscription.

unlinkBug

Unlink a bug to this branch.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: unlinkBug

bug

(required)

Link to a bug.
unlinkSpecification

Unlink an ISpecification to a branch.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: unlinkSpecification

spec

(required)

Link to a specification.
unsubscribe

Remove the person's subscription to this branch.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: unsubscribe

person

(required)

Link to a person.

The person to unsubscribe

(back to Table of Contents)

branch_merge_proposal

Branch merge proposals show intent of landing one branch on another.

https://api.launchpad.net/1.0/~<author.name>/<project.name>/<branch.name>/+merge/<id>

Default representation (application/json)

Key Value Description

address

(read-only)

The email address for this proposal.

Any emails sent to this address will resultin comments being added.

all_comments_collection_link

(read-only)

Link to a code_review_comment collection.

All messages discussing this merge proposal

commit_message

(writeable)

Commit Message

The commit message that should be used when merging the source branch.

date_created

(read-only)

Date Created

date_merged

(read-only)

Date Merged

The date that the source branch was merged into the target branch

date_queued

(read-only)

Date Queued

date_review_requested

(read-only)

Date Review Requested

date_reviewed

(read-only)

Date Reviewed

description

(writeable)

Description

A detailed description of the changes that are being addressed by the branch being proposed to be merged.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

merge_reporter_link

(read-only)

Link to a person.

Merge Reporter

The user that marked the branch as merged.

merged_revno

(read-only)

Merged Revision Number

The revision number on the target branch which contains the merge from the source branch.

prerequisite_branch_link

(read-only)

Link to a branch.

Prerequisite Branch

The branch that the source branch branched from. If this branch is the same as the target branch, then leave this field blank.

preview_diff_link

(read-only)

Link to a preview_diff.

The current diff of the source branch against the target branch.

preview_diffs_collection_link

(read-only)

Link to a preview_diff collection.

All preview diffs for this merge proposal.

private

(read-only)

Proposal is confidential

If True, this proposal is visible only to subscribers.

queue_position

(read-only)

Queue Position

The position in the queue.

queue_status

(read-only)

One of:

  • Work in progress
  • Needs review
  • Approved
  • Rejected
  • Merged
  • Code failed to merge
  • Queued
  • Superseded

Status

The current state of the proposal.

queued_revid

(read-only)

Queued Revision ID

The revision id that has been queued for landing.

queuer_link

(read-only)

Link to a person.

Queuer

The person that queued up the branch.

registrant_link

(read-only)

Link to a person.

Person

The person who registered the merge proposal.

resource_type_link

(read-only)

The link to the WADL description of this resource.

reviewed_revid

(writeable)

The revision id that has been approved by the reviewer.

reviewer_link

(read-only)

Link to a person.

Review person or team

The person that accepted (or rejected) the code for merging.

self_link

(read-only)

The canonical link to this resource.

source_branch_link

(read-only)

Link to a branch.

Source Branch

The branch that has code to land.

superseded_by_link

(read-only)

Link to a branch_merge_proposal.

Superseded By

The branch merge proposal that supersedes this one.

supersedes_link

(read-only)

Link to a branch_merge_proposal.

Supersedes

The branch merge proposal that this one supersedes.

target_branch_link

(read-only)

Link to a branch.

Target Branch

The branch that the source branch will be merged into.

votes_collection_link

(read-only)

Link to a code_review_vote_reference collection.

The votes cast or expected for this proposal

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getComment

Return the CodeReviewComment with the specified ID.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getComment

id

(required)

A CodeReviewComment ID.

Response contains an application/json representation of a code_review_comment.

Custom POST methods

createComment

Create an ICodeReviewComment associated with this merge proposal.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: createComment

content

inline_comments

parent

Link to a code_review_comment.

previewdiff_id

review_type

subject

(required)

vote

One of:

  • Approve
  • Needs Fixing
  • Needs Information
  • Abstain
  • Disapprove
  • Resubmit

On success, the response status will be 201 and the Location header will contain the link to the newly created code_review_comment.

nominateReviewer

Set the specified person as a reviewer.

If they are not already a reviewer, a vote is created. Otherwise, the details are updated.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: nominateReviewer

review_type

reviewer

(required)

Link to a person.

A reviewer.

Response contains an application/json representation of a code_review_vote_reference.

setStatus

Set the state of the merge proposal to the specified status.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: setStatus

revid

An optional parameter for specifying the revision of the branch for the status change.

status

(required)

One of:

  • Work in progress
  • Needs review
  • Approved
  • Rejected
  • Merged
  • Code failed to merge
  • Queued
  • Superseded

The new status of the merge proposal.

(back to Table of Contents)

branch_merge_queue

An interface for managing branch merges.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

branches_collection_link

(read-only)

Link to a branch collection.

Dependent Branches

A collection of branches that this queue manages.

configuration

(writeable)

Configuration

A JSON string of configuration values.

date_created

(read-only)

Date Created

description

(writeable)

Description

A short description of the purpose of this merge queue.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

name

(writeable)

Name

Keep very short, unique, and descriptive, because it will be used in URLs. Examples: main, devel, release-1.0, gnome-vfs.

owner_link

(read-only)

Link to a person.

Owner

The owner of the merge queue.

registrant_link

(read-only)

Link to a person.

The user that registered the branch.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

branch_subscription

The relationship between a person and a branch.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

branch_link

(read-only)

Link to a branch.

Branch ID

http_etag

(read-only)

The value of the HTTP ETag for this resource.

max_diff_lines

(writeable)

One of:

  • Don't send diffs
  • 500 lines
  • 1000 lines
  • 5000 lines
  • Send entire diff

Generated Diff Size Limit

Diffs greater than the specified number of lines will not be sent to the subscriber. The subscriber will still receive an email with the new revision details even if the diff is larger than the specified number of lines.

notification_level

(writeable)

One of:

  • No email
  • Branch attribute notifications only
  • Branch revision notifications only
  • Branch attribute and revision notifications

Notification Level

Attribute notifications are sent when branch details are changed such as lifecycle status and name. Revision notifications are generated when new branch revisions are found due to the branch being updated through either pushes to the hosted branches or the mirrored branches being updated.

person_link

(read-only)

Link to a person.

Person

Enter the launchpad id, or email address of the person you wish to subscribe to this branch. If you are unsure, use the "Choose..." option to find the person in Launchpad. You can only subscribe someone who is a registered user of the system.

resource_type_link

(read-only)

The link to the WADL description of this resource.

review_level

(writeable)

One of:

  • No email
  • Status changes only
  • Email about all changes

Code review Level

Control the kind of review activity that triggers notifications.

self_link

(read-only)

The canonical link to this resource.

subscribed_by_link

(read-only)

Link to a person.

Subscribed by

The person who created this subscription.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

canBeUnsubscribedByUser

Can the user unsubscribe the subscriber from the branch?

Parameters
Parameter Value Description

ws.op

(required)

Fixed: canBeUnsubscribedByUser

(back to Table of Contents)

bug

The core bug entry.

https://api.launchpad.net/1.0/bugs/<id>

Default representation (application/json)

Key Value Description

activity_collection_link

(read-only)

Link to a bug_activity collection.

Log of activity that has occurred on this bug.

attachments_collection_link

(read-only)

Link to a bug_attachment collection.

List of bug attachments.

bug_tasks_collection_link

(read-only)

Link to a bug_task collection.

BugTasks on this bug, sorted upstream, then by ubuntu, then by other distroseries.

bug_watches_collection_link

(read-only)

Link to a bug_watch collection.

All bug watches associated with this bug.

can_expire

(read-only)

Can the Incomplete bug expire? Expiration may happen when the bug permits expiration, and a bugtask cannot be confirmed.

cves_collection_link

(read-only)

Link to a cve collection.

CVE entries related to this bug.

date_created

(read-only)

Date Created

date_last_message

(read-only)

Date of last bug message

date_last_updated

(read-only)

Date Last Updated

date_made_private

(read-only)

Date Made Private

description

(writeable)

Description

A detailed description of the problem,
including the steps required to reproduce it.

duplicate_of_link

(writeable)

Link to a bug.

Duplicate Of

duplicates_collection_link

(read-only)

Link to a bug collection.

MultiJoin of bugs which are dupes of this one.

heat

(read-only)

The 'heat' of the bug

http_etag

(read-only)

The value of the HTTP ETag for this resource.

id

(read-only)

Bug ID

information_type

(read-only)

One of:

  • Public
  • Public Security
  • Private Security
  • Private
  • Proprietary
  • Embargoed

Information Type

The type of information contained in this bug report.

latest_patch_uploaded

(read-only)

Date when the most recent patch was uploaded.

linked_branches_collection_link

(read-only)

Link to a bug_branch collection.

Branches associated with this bug, usually branches on which this bug is being fixed.

message_count

(read-only)

The number of comments on this bug

messages_collection_link

(read-only)

Link to a message collection.

The messages related to this object, in reverse order of creation (so newest first).

name

(writeable)

Nickname

A short and unique name.
Add one only if you often need to retype the URL but have trouble remembering the bug number.

number_of_duplicates

(read-only)

The number of bugs marked as duplicates of this bug

other_users_affected_count_with_dupes

(read-only)

The number of users affected by this bug (including duplicates), excluding the current user

owner_link

(read-only)

Link to a person.

The owner's IPerson

private

(writeable)

This bug report should be private

Private bug reports are visible only to their subscribers.

resource_type_link

(read-only)

The link to the WADL description of this resource.

security_related

(writeable)

This bug is a security vulnerability.

self_link

(read-only)

The canonical link to this resource.

subscriptions_collection_link

(read-only)

Link to a bug_subscription collection.

Subscriptions

tags

(writeable)

Tags

Space-separated keywords for classifying this bug report.

title

(writeable)

Summary

A one-line summary of the problem.

users_affected_collection_link

(read-only)

Link to a person collection.

The number of users affected by this bug (not including duplicates)

users_affected_count

(read-only)

The number of users affected by this bug (not including duplicates)

users_affected_count_with_dupes

(read-only)

The number of users affected by this bug (including duplicates)

users_affected_with_dupes_collection_link

(read-only)

Link to a person collection.

Users affected (including duplicates)

users_unaffected_collection_link

(read-only)

Link to a person collection.

Users explicitly marked as unaffected (not including duplicates)

users_unaffected_count

(read-only)

The number of users unaffected by this bug

web_link

(read-only)

The canonical human-addressable web link to this resource.

who_made_private_link

(read-only)

Link to a person.

Who Made Private

The person who set this bug private.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

canBeNominatedFor

Can this bug nominated for this target?

Returns True or False.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: canBeNominatedFor

target

(required)

Link to a bug_target.

Target

getHWSubmissions

Return HWDB submissions linked to this bug.

Only those submissions are returned which the user can access. Public submissions are always included; private submisisons only if the user is the owner or an admin.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getHWSubmissions

Response contains an application/json representation of a h_w_submission collection .

getNominationFor

Return the IBugNomination for the target.

If no nomination is found, a NotFoundError is raised.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getNominationFor

target

(required)

Link to a bug_target.

Target

Response contains an application/json representation of a bug_nomination.

getNominations

Return a list of all IBugNominations for this bug.

The list is ordered by IBugNominations.target.bugtargetdisplayname.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getNominations

nominations

Nominations to search through.

target

Link to a bug_target.

Target

Response contains an application/json representation of a bug_nomination collection .

getVisibleLinkedBranches

Return the branches linked to this bug that are visible by user.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: getVisibleLinkedBranches

isExpirable

Is this bug eligible for expiration and was it last updated more than X days ago?

If days_old is None the default number of days without activity is used.

Returns True or False.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: isExpirable

days_old

Number of days of inactivity for which to check.

Custom POST methods

addAttachment

Attach a file to this bug.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addAttachment

comment

(required)

content_type

data

(required)

Link to a file resource.

description

filename

(required)

is_patch

On success, the response status will be 201 and the Location header will contain the link to the newly created bug_attachment.

addNomination

Nominate a bug for an IDistroSeries or IProductSeries.

This method creates and returns a BugNomination. (See lp.bugs.model.bugnomination.BugNomination.)

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addNomination

target

(required)

Link to a bug_target.

Target

On success, the response status will be 201 and the Location header will contain the link to the newly created bug_nomination.

addTask

Create a new bug task on this bug.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addTask

target

(required)

Link to a bug_target.

Target

The software in which this bug should be fixed.

On success, the response status will be 201 and the Location header will contain the link to the newly created bug_task.

addWatch

Create a new watch for this bug on the given remote bug and bug tracker, owned by the person given as the owner.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addWatch

bug_tracker

(required)

Link to a bug_tracker.

Bug System

You can register new bug trackers from the Launchpad Bugs home page.

remote_bug

(required)

Remote Bug

The bug number of this bug in the remote bug tracker.

On success, the response status will be 201 and the Location header will contain the link to the newly created bug_watch.

isUserAffected

Is :user: marked as affected by this bug?

Parameters
Parameter Value Description

ws.op

(required)

Fixed: isUserAffected

linkBranch

Associate a branch with this bug.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: linkBranch

branch

(required)

Link to a branch.
linkCVE

Ensure that this CVE is linked to this bug.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: linkCVE

cve

(required)

Link to a cve.

CVE

linkHWSubmission

Link a HWSubmission to this bug.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: linkHWSubmission

submission

(required)

Link to a h_w_submission.

A HWDB submission

markUserAffected

Mark :user: as affected by this bug.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: markUserAffected

affected

Does this bug affect you?

newMessage

Create a new message, and link it to this object.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: newMessage

content

(required)

Message

subject

Subject

On success, the response status will be 201 and the Location header will contain the link to the newly created message.

setCommentVisibility

Set the visible attribute on a bug comment. This is restricted to Launchpad admins, and will return a HTTP Error 401: Unauthorized error for non-admin callers.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: setCommentVisibility

comment_number

(required)

The number of the comment in the list of messages.

visible

(required)

Show this comment?

subscribe

Subscribe person to the bug.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: subscribe

level

One of:

  • Lifecycle
  • Details
  • Discussion

Level

person

(required)

Link to a person.

Person

Response (application/json)

an IBugSubscription.

unlinkBranch

Unlink a branch from this bug.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: unlinkBranch

branch

(required)

Link to a branch.
unlinkCVE

Ensure that any links between this bug and the given CVE are removed.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: unlinkCVE

cve

(required)

Link to a cve.

CVE

unlinkHWSubmission

Remove a link to a HWSubmission.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: unlinkHWSubmission

submission

(required)

Link to a h_w_submission.

A HWDB submission

unsubscribe

Remove this person's subscription to this bug.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: unsubscribe

person

Link to a person.

Person

unsubscribeFromDupes

Remove this person's subscription from all dupes of this bug.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: unsubscribeFromDupes

person

Link to a person.

Person

(back to Table of Contents)

bug_activity

A log of all things that have happened to a bug.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

bug_link

(read-only)

Link to a bug.

Bug

datechanged

(read-only)

Date Changed

The date on which this activity occurred.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

message

(read-only)

Message

Additional information about what changed.

newvalue

(read-only)

New Value

The value after the change.

oldvalue

(read-only)

Old Value

The value before the change.

person_link

(read-only)

Link to a person.

Person

The person's Launchpad ID or e-mail address.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

whatchanged

(read-only)

What Changed

The property of the bug that changed.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

bug_attachment

A file attachment to an IBug.

Launchpadlib example of accessing content of an attachment:

for attachment in bug.attachments:
    buffer = attachment.data.open()
    for line in buffer:
        print line
    buffer.close()

Launchpadlib example of accessing metadata about an attachment:

attachment = bug.attachments[0]
print "title:", attachment.title
print "ispatch:", attachment.type

For information about the file-like object returned by attachment.data.open() see lazr.restfulclient's documentation of the HostedFile object.

Details about the message associated with an attachment can be found on the "message" attribute:

message = attachment.message
print "subject:", message.subject.encode('utf-8')
print "owner:", message.owner.display_name.encode('utf-8')
print "created:", message.date_created

https://api.launchpad.net/1.0/bugs/<bug.id>/attachments/<id>

Default representation (application/json)

Key Value Description

bug_link

(writeable)

Link to a bug.

The bug the attachment belongs to.

data_link

(read-only)

Link to a file resource.

The attachment content.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

message_link

(writeable)

Link to a message.

The message that was created when we added this attachment.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

title

(writeable)

Title

A short and descriptive description of the attachment

type

(writeable)

One of:

  • Patch
  • Unspecified

Attachment Type

The type of the attachment, for example Patch or Unspecified.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

removeFromBug

Remove the attachment from the bug.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: removeFromBug

(back to Table of Contents)

bug_branch

A branch linked to a bug.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

branch_link

(writeable)

Link to a branch.

Branch

bug_link

(read-only)

Link to a bug.

Bug #

http_etag

(read-only)

The value of the HTTP ETag for this resource.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

An entity which can be linked to bugs.

Examples include an ISpecification.

depends on the underlying entry

Default representation (application/json)

Key Value Description

http_etag

(read-only)

The value of the HTTP ETag for this resource.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

(back to Table of Contents)

bug_nomination

A nomination for a bug to be fixed in a specific series.

A nomination can apply to an IDistroSeries or an IProductSeries.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

bug_link

(read-only)

Link to a bug.

date_created

(read-only)

Date Submitted

The date on which this nomination was submitted.

date_decided

(read-only)

Date Decided

The date on which this nomination was approved or declined.

decider_link

(read-only)

Link to a person.

Decided By

distroseries_link

(read-only)

Link to a distro_series.

Series

http_etag

(read-only)

The value of the HTTP ETag for this resource.

owner_link

(read-only)

Link to a person.

Submitter

productseries_link

(read-only)

Link to a project_series.

Series

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

status

(read-only)

One of:

  • Nominated
  • Approved
  • Declined

Status

target_link

(writeable)

Link to a bug_target.

The IProductSeries or IDistroSeries of this nomination.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

canApprove

Is this person allowed to approve the nomination?

Parameters
Parameter Value Description

ws.op

(required)

Fixed: canApprove

Custom POST methods

approve

Approve this bug for fixing in a series.

The status is set to APPROVED and the appropriate IBugTask(s) are created for the nomination target.

A nomination in any state can be approved. If the nomination is /already/ approved, this method is a noop.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: approve

decline

Decline this bug for fixing in a series.

The status is set to DECLINED.

If called on a nomination that is in APPROVED state, a BugNominationStatusError is raised. If the nomination was already DECLINED, this method is a noop.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: decline

(back to Table of Contents)

bug_subscription

The relationship between a person and a bug.

https://api.launchpad.net/1.0/bugs/<bug.id>/subscriptions/<subscriber.name>

Default representation (application/json)

Key Value Description

bug_link

(read-only)

Link to a bug.

Bug

date_created

(read-only)

Date subscribed

http_etag

(read-only)

The value of the HTTP ETag for this resource.

person_link

(read-only)

Link to a person.

Person

The person's Launchpad ID or e-mail address.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

subscribed_by_link

(read-only)

Link to a person.

Subscribed by

The person who created this subscription.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

canBeUnsubscribedByUser

Can the user unsubscribe the subscriber from the bug?

Parameters
Parameter Value Description

ws.op

(required)

Fixed: canBeUnsubscribedByUser

(back to Table of Contents)

bug_subscription_filter

A bug subscription filter.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

bug_notification_level

(writeable)

One of:

  • Lifecycle
  • Details
  • Discussion

Bug notification level

The volume and type of bug notifications this subscription will generate.

description

(writeable)

A short description of this filter

find_all_tags

(writeable)

Find all tags

If enabled, all tags must match, else at least one tag must match.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

importances

(writeable)

The importances interested in (empty for all)

information_types

(writeable)

The information types interested in (empty for all)

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

statuses

(writeable)

The statuses interested in (empty for all)

structural_subscription_link

(read-only)

Link to a structural_subscription.

Structural subscription

tags

(writeable)

The tags interested in

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

bug_target

An entity on which a bug can be reported.

Examples include an IDistribution, an IDistroSeries and an IProduct.

depends on the underlying entry

Default representation (application/json)

Key Value Description

bug_reported_acknowledgement

(writeable)

After reporting a bug, I can expect the following.

This message of acknowledgement will be displayed to anyone after reporting a bug.

bug_reporting_guidelines

(writeable)

Helpful guidelines for reporting a bug

These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: searchTasks

affected_user

Link to a person.

assignee

Link to a person.

bug_commenter

Link to a person.

bug_reporter

Link to a person.

bug_subscriber

Link to a person.

bug_supervisor

Link to a person.

component

Component

Distribution package archive grouping. E.g. main, universe, multiverse

created_before

Search for bugs that were created before the given date.

created_since

Search for bugs that have been created since the given date.

hardware_bus

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The bus of a hardware device related to a bug

hardware_driver_name

The driver controlling a hardware device related to a bug.

hardware_driver_package_name

The package of the driver which controls a hardware device related to a bug.

hardware_is_linked_to_bug

Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.

hardware_owner_is_affected_by_bug

Search for bugs where people affected by a bug own the given device or use the given hardware driver.

hardware_owner_is_bug_reporter

Search for bugs reported by people who own the given device or who use the given hardware driver.

hardware_owner_is_subscribed_to_bug

Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.

hardware_product_id

The product ID of a hardware device related to a bug.

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

hardware_vendor_id

The vendor ID of a hardware device related to a bug.

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

has_cve

Show only bugs associated with a CVE

has_no_package

Exclude bugs with packages specified

has_patch

Show only bugs with patches available.

importance

Importance

Show only bugs with the given importance or list of importances.

information_type

Information Type

Show only bugs with the given information type or list of information types.

linked_branches

One of:

  • Show all bugs
  • Show only Bugs with linked Branches
  • Show only Bugs without linked Branches

Search for bugs that are linked to branches or for bugs that are not linked to branches.

milestone

Milestone

Show only bug tasks targeted to this milestone.

modified_since

Search for bugs that have been modified since the given date.

nominated_for

Link to a distro_series.

omit_duplicates

Omit bugs marked as duplicate,

omit_targeted

Omit bugs targeted to a series

order_by

List of fields by which the results are ordered.

owner

Link to a person.

search_text

Bug ID or search text.

status

Status

Show only bugs with the given status value or list of values.

status_upstream

Status upstream

Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.

structural_subscriber

Link to a person.

tags

Tags

String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'

tags_combinator

One of:

  • Any
  • All

Tags combination

Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

(back to Table of Contents)

bug_task

A bug needing fixing in a particular product or package.

https://api.launchpad.net/1.0/<target.name>/+bug/<bug.id>

Default representation (application/json)

Key Value Description

assignee_link

(writeable)

Link to a person.

Assigned to

bug_link

(read-only)

Link to a bug.

Bug

bug_target_display_name

(read-only)

The short, descriptive name of the target

bug_target_name

(read-only)

The target as presented in mail notifications

bug_watch_link

(writeable)

Link to a bug_watch.

Remote Bug Details

Select the bug watch that represents this task in the relevant bug tracker. If none of the bug watches represents this particular bug task, leave it as (None). Linking the remote bug watch with the task in this way means that a change in the remote bug status will change the status of this bug task in Launchpad.

date_assigned

(read-only)

Date Assigned

The date on which this task was assigned to someone.

date_closed

(read-only)

Date Closed

The date on which this task was marked Fix Released, Invalid, Won't Fix, Expired or Opinion.

date_confirmed

(read-only)

Date Confirmed

The date on which this task was marked Confirmed.

date_created

(read-only)

Date Created

The date on which this task was created.

date_fix_committed

(read-only)

Date Fix Committed

The date on which this task was marked Fix Committed.

date_fix_released

(read-only)

Date Fix Released

The date on which this task was marked Fix Released.

date_in_progress

(read-only)

Date In Progress

The date on which this task was marked In Progress.

date_incomplete

(read-only)

Date Incomplete

The date on which this task was marked Incomplete.

date_left_closed

(read-only)

Date left closed

The date on which this task was last reopened.

date_left_new

(read-only)

Date left new

The date on which this task was marked with a status higher than New.

date_triaged

(read-only)

Date Triaged

The date on which this task was marked Triaged.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

importance

(writeable)

One of:

  • Unknown
  • Undecided
  • Critical
  • High
  • Medium
  • Low
  • Wishlist

Importance

is_complete

(read-only)

True or False depending on whether or not there is more work required on this bug task.

milestone_link

(writeable)

Link to a milestone.

Milestone

owner_link

(read-only)

Link to a person.

The owner

related_tasks_collection_link

(read-only)

Link to a bug_task collection.

IBugTasks related to this one, namely other IBugTasks on the same IBug.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

status

(writeable)

One of:

  • New
  • Incomplete
  • Opinion
  • Invalid
  • Won't Fix
  • Expired
  • Confirmed
  • Triaged
  • In Progress
  • Fix Committed
  • Fix Released
  • Unknown

Status

target_link

(writeable)

Link to a bug_target.

Target

The software in which this bug should be fixed.

title

(read-only)

The title of the bug related to this bugtask

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

findSimilarBugs

Return the list of possible duplicates for this BugTask.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: findSimilarBugs

Response contains an application/json representation of a bug collection .

(back to Table of Contents)

bug_tracker

A remote bug system.

Launchpadlib example: What bug tracker is used for a distro source package?

product = source_package.upstream_product
if product:
    tracker = product.bug_tracker
    if not tracker:
        project = product.project_group
        if project:
            tracker = project.bug_tracker
if tracker:
    print "%s at %s" %(tracker.bug_tracker_type, tracker.base_url)

https://api.launchpad.net/1.0/bugs/bugtrackers/<name>

Default representation (application/json)

Key Value Description

active

(writeable)

Updates for this bug tracker are enabled

base_url

(writeable)

Location

The top-level URL for the bug tracker, or an upstream email address. This must be accurate so that Launchpad can link to external bug reports.

base_url_aliases

(writeable)

Location aliases

A list of URLs or email addresses that all lead to the same bug tracker, or commonly seen typos, separated by whitespace.

bug_tracker_type

(writeable)

One of:

  • Bugzilla
  • Debbugs
  • Roundup
  • Trac
  • SourceForge or SourceForge derivative
  • Mantis
  • Request Tracker (RT)
  • Email Address
  • Savane
  • PHP Project Bugtracker
  • Google Code

Bug Tracker Type

contact_details

(writeable)

Contact details

The contact details for the external bug tracker (so that, for example, its administrators can be contacted about a security breach).

has_lp_plugin

(writeable)

This bug tracker has a Launchpad plugin installed.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

name

(writeable)

Name

A URL-friendly name for the bug tracker, such as "mozilla-bugs".

registrant_link

(writeable)

Link to a person.

Owner

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

summary

(writeable)

Summary

A brief introduction or overview of this bug tracker instance.

title

(writeable)

Title

A descriptive label for this tracker to show in listings.

watches_collection_link

(read-only)

Link to a bug_watch collection.

The remote watches on this bug tracker.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getAllRemoteComponentGroups

Return collection of all component groups for this bug tracker

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getAllRemoteComponentGroups

Response contains an application/json representation of a bug_tracker_component_group collection .

getRemoteComponentGroup

Retrieve a given component group registered with the bug tracker.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getRemoteComponentGroup

component_group_name

(required)

The name of the remote component group

Response contains an application/json representation of a bug_tracker_component_group.

Custom POST methods

addRemoteComponentGroup

Adds a new component group to the bug tracker

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addRemoteComponentGroup

component_group_name

(required)

The name of the remote component group

Response contains an application/json representation of a bug_tracker_component_group.

(back to Table of Contents)

bug_tracker_component

The software component in the remote bug tracker.

Most bug trackers organize bug reports by the software 'component' they affect. This class provides a mapping of this upstream component to the corresponding source package in the distro.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

component_group_link

(writeable)

Link to a bug_tracker_component_group.

Component Group

distro_source_package_link

(writeable)

Link to a distribution_source_package.

Distribution Source Package

The distribution source package object that should be linked to this component.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

is_visible

(writeable)

Is Visible?

Should the component be shown in the Launchpad web interface?

name

(writeable)

Name

The name of a software component as shown in Launchpad.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

bug_tracker_component_group

A collection of components in a remote bug tracker.

Some bug trackers organize sets of components into higher level groups, such as Bugzilla's 'product'.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

bug_tracker_link

(writeable)

Link to a bug_tracker.

BugTracker

components_collection_link

(read-only)

Link to a bug_tracker_component collection.

Components.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

name

(writeable)

Name

The name of the bug tracker product.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

addComponent

Adds a component to be tracked as part of this component group

Parameters
Parameter Value Description

ws.op

(required)

Fixed: addComponent

component_name

(required)

The name of the remote software component to be added

(back to Table of Contents)

bug_watch

A bug on a remote system.

https://api.launchpad.net/1.0/bugs/<bug.id>/watch/<id>

Default representation (application/json)

Key Value Description

bug_link

(read-only)

Link to a bug.

Bug

bug_tasks_collection_link

(read-only)

Link to a bug_task collection.

The tasks which this watch will affect. In Launchpad, a bug watch can be linked to one or more tasks, and if it is linked and we notice a status change in the watched bug then we will try to update the Launchpad bug task accordingly.

bug_tracker_link

(writeable)

Link to a bug_tracker.

Bug System

You can register new bug trackers from the Launchpad Bugs home page.

date_created

(read-only)

Date Created

date_last_changed

(writeable)

Last Changed

date_last_checked

(writeable)

Last Checked

date_next_checked

(writeable)

Next Check

http_etag

(read-only)

The value of the HTTP ETag for this resource.

last_error_type

(writeable)

One of:

  • Unknown
  • Bug Not Found
  • Connection Error
  • Invalid Bug ID
  • Timeout
  • Unparsable Bug
  • Unparsable Bug Tracker Version
  • Unsupported Bugtracker
  • Private Remote Bug
  • Synchronisation succeeded
  • Unable to import comments
  • Unable to push comments
  • Unable to set link remote bug to Launchpad

Last Error Type

owner_link

(read-only)

Link to a person.

Owner

remote_bug

(writeable)

Remote Bug

The bug number of this bug in the remote bug tracker.

remote_importance

(writeable)

Remote Importance

remote_status

(writeable)

Remote Status

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

title

(read-only)

Bug watch title

url

(read-only)

The URL at which to view the remote bug.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

build

A Build interface

https://api.launchpad.net/1.0/<distribution.name>/+source/<source_package.name>/+build/<id>

Default representation (application/json)

Key Value Description

arch_tag

(writeable)

Architecture tag

archive_link

(read-only)

Link to a archive.

Archive

The Archive context for this build.

build_log_url

(writeable)

Build Log URL

A URL for the build log. None if there is no log available.

builder_link

(read-only)

Link to a builder.

Builder

The builder assigned to this job.

buildstate

(writeable)

One of:

  • Needs building
  • Successfully built
  • Failed to build
  • Dependency wait
  • Chroot problem
  • Build for superseded Source
  • Currently building
  • Failed to upload
  • Uploading build
  • Cancelling build
  • Cancelled build

Status

The current status of the job.

can_be_cancelled

(read-only)

Can Be Cancelled

Whether or not this build record can be cancelled.

can_be_rescored

(read-only)

Can Be Rescored

Whether or not this build record can be rescored manually.

can_be_retried

(read-only)

Can Be Retried

Whether or not this build record can be retried.

changesfile_url

(writeable)

Changes File URL

The URL for the changes file for this build. Will be None if the build was imported by Gina.

current_source_publication_link

(read-only)

Link to a source_package_publishing_history.

Source publication

The current source publication for this build.

date_first_dispatched

(read-only)

Date finished

The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.

datebuilt

(read-only)

Date finished

The timestamp when the build farm job was finished.

datecreated

(read-only)

Date created

The timestamp when the build farm job was created.

dependencies

(writeable)

Dependencies

Debian-like dependency line that must be satisfied before attempting to build this request.

distribution_link

(writeable)

Link to a distribution.

Distribution

Shortcut for its distribution.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

pocket

(writeable)

One of:

  • Release
  • Security
  • Updates
  • Proposed
  • Backports

Pocket

The build targeted pocket.

resource_type_link

(read-only)

The link to the WADL description of this resource.

score

(read-only)

Score of the related job (if any)

self_link

(read-only)

The canonical link to this resource.

title

(writeable)

Title

upload_log_url

(writeable)

Upload Log URL

A URL for failed upload logs.Will be None if there was no failure.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

rescore

Change the build's score.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: rescore

score

(required)

Score

retry

Restore the build record to its initial state.

Build record loses its history, is moved to NEEDSBUILD and a new non-scored BuildQueue entry is created for it.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: retry

(back to Table of Contents)

builder

Build-slave information and state.

Builder instance represents a single builder slave machine within the Launchpad Auto Build System. It should specify a 'processor' on which the machine is based and is able to build packages for; a URL, by which the machine is accessed through an XML-RPC interface; name, title for entity identification and browsing purposes; an LP-like owner which has unrestricted access to the instance; the build slave machine status representation, including the field/properties: virtualized, builderok, status, failnotes and currentjob.

https://api.launchpad.net/1.0/builders/<builder.name>

Default representation (application/json)

Key Value Description

active

(writeable)

Publicly Visible

Whether or not to present the builder publicly.

builderok

(writeable)

Builder State OK

Whether or not the builder is ok

failnotes

(writeable)

Failure Notes

The reason for a builder not being ok

failure_count

(writeable)

Failure Count

Number of consecutive failures for this builder.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

manual

(writeable)

Manual Mode

The auto-build system does not dispatch jobs automatically for slaves in manual mode.

name

(writeable)

Name

Builder Slave Name used for reference proposes

owner_link

(writeable)

Link to a person.

Owner

Builder owner, a Launchpad member which will be responsible for this device.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

title

(writeable)

Title

The builder slave title. Should be just a few words.

url

(writeable)

URL

The URL to the build machine, used as a unique identifier. Includes protocol, host and port only, e.g.: http://farm.com:8221/

version

(writeable)

Version

The version of launchpad-buildd on the slave.

virtualized

(writeable)

Virtualized

Whether or not the builder is a virtual Xen instance.

vm_host

(writeable)

Virtual Machine Host

The machine hostname hosting the virtual buildd-slave, e.g.: foobar-host.ppa

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getBuildRecords

Return build records in the context it is implemented.

It excludes build records generated by Gina (imported from a external repository), where IBuild.datebuilt is null and IBuild.buildstate is BuildStatus.FULLYBUILT.

The result is simply not filtered if the optional filters are omitted by call sites.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getBuildRecords

build_state

One of:

  • Needs building
  • Successfully built
  • Failed to build
  • Dependency wait
  • Chroot problem
  • Build for superseded Source
  • Currently building
  • Failed to upload
  • Uploading build
  • Cancelling build
  • Cancelled build

Build status

The status of this build record

pocket

One of:

  • Release
  • Security
  • Updates
  • Proposed
  • Backports

Pocket

The pocket into which this entry is published

source_name

Source package name

Response contains an application/json representation of a build collection .

(back to Table of Contents)

code_import

A code import to a Bazaar Branch.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

branch_link

(read-only)

Link to a branch.

Branch

The Bazaar branch produced by the import system.

cvs_module

(read-only)

Module

The path to import within the repository. Usually, it is the name of the project.

cvs_root

(read-only)

Repository

The CVSROOT. Example: :pserver:anonymous@anoncvs.gnome.org:/cvs/gnome

date_last_successful

(read-only)

Last successful

http_etag

(read-only)

The value of the HTTP ETag for this resource.

rcs_type

(read-only)

One of:

  • Concurrent Versions System
  • Subversion via CSCVS
  • Subversion via bzr-svn
  • Git
  • Mercurial
  • Bazaar

Type of RCS

The version control system to import from. Can be CVS or Subversion.

resource_type_link

(read-only)

The link to the WADL description of this resource.

review_status

(read-only)

One of:

  • Pending Review
  • Invalid
  • Reviewed
  • Suspended
  • Failed

Review Status

Only reviewed imports are processed.

self_link

(read-only)

The canonical link to this resource.

url

(read-only)

URL

The URL of the VCS branch.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

requestImport

Request that an import be tried soon.

This method will schedule an import to happen soon for this branch.

The import must be in the Reviewed state, if not then a CodeImportNotInReviewedState error will be thrown. If using the API then a status code of 400 will result.

If the import is already running then a CodeImportAlreadyRunning error will be thrown. If using the API then a status code of 400 will result.

The two cases can be distinguished over the API by seeing if the exception names appear in the body of the response.

If used over the API and the request has already been made then this method will silently do nothing. If called internally then the error_if_already_requested parameter controls whether a CodeImportAlreadyRequested exception will be thrown in that situation.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: requestImport

Response (application/json)

None

(back to Table of Contents)

code_review_comment

A link between a merge proposal and a message.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

as_quoted_email

(read-only)

The message as quoted in email.

author_link

(read-only)

Link to a person.

Comment Author

branch_merge_proposal_link

(read-only)

Link to a branch_merge_proposal.

The branch merge proposal

date_created

(read-only)

Date Created

http_etag

(read-only)

The value of the HTTP ETag for this resource.

id

(read-only)

DB ID

The tracking number for this comment.

message_body

(read-only)

The body of the code review message.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

title

(writeable)

The title of the comment

vote

(writeable)

One of:

  • Approve
  • Needs Fixing
  • Needs Information
  • Abstain
  • Disapprove
  • Resubmit

Review

vote_tag

(writeable)

Vote tag

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

code_review_vote_reference

A reference to a vote on a IBranchMergeProposal.

There is at most one reference to a vote for each reviewer on a given branch merge proposal.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

branch_merge_proposal_link

(writeable)

Link to a branch_merge_proposal.

The merge proposal that is the subject of this vote

comment_link

(writeable)

Link to a code_review_comment.

The code review comment that contains the most recent vote.

date_created

(read-only)

Date Created

http_etag

(read-only)

The value of the HTTP ETag for this resource.

is_pending

(read-only)

Is the pending?

registrant_link

(writeable)

Link to a person.

The person who originally registered this vote

resource_type_link

(read-only)

The link to the WADL description of this resource.

review_type

(writeable)

Review type

Lowercase keywords describing the type of review.

reviewer_link

(writeable)

Link to a person.

Reviewer

A person who you want to review this.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

claimReview

Change a pending review into a review for claimant.

Pending team reviews can be claimed by members of that team. This allows reviews to be moved of the general team todo list, and onto a personal todo list.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: claimReview

reassignReview

Reassign a pending review to someone else.

Pending reviews can be reassigned to someone else.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: reassignReview

reviewer

(required)

Link to a person.

The person or team to assign to do the review.

(back to Table of Contents)

commercial_subscription

A Commercial Subscription for a Product.

If the product has a licence which does not qualify for free hosting, a subscription needs to be purchased.

https://api.launchpad.net/1.0/+commercialsubscription/<commercial_subscription.id>

Default representation (application/json)

Key Value Description

date_created

(read-only)

Date Created

The date the first subscription was applied.

date_expires

(writeable)

Expiration Date

The expiration date of the subscription.

date_last_modified

(writeable)

Date Modified

The date the subscription was modified.

date_starts

(writeable)

Beginning of Subscription

The date the subscription starts.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

is_active

(read-only)

Active

Whether this subscription is active.

product_link

(read-only)

Link to a project.

Product which has commercial subscription

Project for which this commercial subscription is applied.

purchaser_link

(read-only)

Link to a person.

Purchaser

Person who purchased the voucher.

registrant_link

(read-only)

Link to a person.

Registrant

Person who redeemed the voucher.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

country

The country description.

https://api.launchpad.net/1.0/+countries/<iso3166code2>

Default representation (application/json)

Key Value Description

description

(writeable)

Description

http_etag

(read-only)

The value of the HTTP ETag for this resource.

iso3166code2

(read-only)

iso3166code2

iso3166code3

(read-only)

iso3166code3

name

(writeable)

Country name

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

title

(writeable)

Country title

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

cve

A single CVE database entry.

https://api.launchpad.net/1.0/bugs/cve/<sequence>

Default representation (application/json)

Key Value Description

bugs_collection_link

(read-only)

Link to a bug collection.

Bugs related to this CVE entry.

date_created

(read-only)

Date Created

date_modified

(writeable)

Date Modified

description

(writeable)

Title

A description of the CVE issue. This will be updated regularly from the CVE database.

display_name

(writeable)

Display Name

A very brief name describing the ref and state.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

sequence

(writeable)

CVE Sequence Number

Should take the form XXXX-XXXX, all digits.

status

(writeable)

One of:

  • Candidate
  • Entry
  • Deprecated

Current CVE State

Whether or not the vulnerability has been reviewed and assigned a full CVE number, or is still considered a Candidate, or is deprecated.

title

(writeable)

Title

A title for the CVE

url

(writeable)

URL

Return a URL to the site that has the CVE data for this CVE reference.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

distribution

An operating system distribution.

Launchpadlib example: retrieving the current version of a package in a particular distroseries.

ubuntu = launchpad.distributions["ubuntu"]
archive = ubuntu.main_archive
series = ubuntu.current_series
print archive.getPublishedSources(exact_match=True,
    source_name="apport",
    distro_series=series)[0].source_package_version

https://api.launchpad.net/1.0/<name>

Default representation (application/json)

Key Value Description

active

(writeable)

Active

Whether or not this item is active.

active_milestones_collection_link

(read-only)

Link to a milestone collection.

The visible and active milestones associated with this object, ordered by date expected.

all_milestones_collection_link

(read-only)

Link to a milestone collection.

All milestones associated with this object, ordered by date expected.

archive_mirrors_collection_link

(read-only)

Link to a distribution_mirror collection.

All enabled and official ARCHIVE mirrors of this Distribution.

archives_collection_link

(read-only)

Link to a archive collection.

A sequence of the distribution's primary, partner and debug archives.

bug_reported_acknowledgement

(writeable)

After reporting a bug, I can expect the following.

This message of acknowledgement will be displayed to anyone after reporting a bug.

bug_reporting_guidelines

(writeable)

Helpful guidelines for reporting a bug

These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.

bug_supervisor_link

(writeable)

Link to a person.

Bug Supervisor

The Launchpad id of the person or team (preferred) responsible for bug management.

cdimage_mirrors_collection_link

(read-only)

Link to a distribution_mirror collection.

All enabled and official RELEASE mirrors of this Distribution.

current_series_link

(writeable)

Link to a distro_series.

Current series

The current development series of this distribution. Note that all maintainerships refer to the current series. When people ask about the state of packages in the distribution, we should interpret that query in the context of the currentseries.

date_created

(writeable)

Date created

The date this distribution was registered.

derivatives_collection_link

(read-only)

Link to a distro_series collection.

This Distribution's derivatives

description

(writeable)

Description

Details about the distributions's work, highlights, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.

development_series_alias

(writeable)

Alias for development series

If set, an alias for the current development series in this distribution.

display_name

(writeable)

Display Name

The displayable name of the distribution.

domain_name

(writeable)

Web site URL

The distro's web site URL.

driver_link

(writeable)

Link to a person.

Driver

The person or team responsible for decisions about features and bugs that will be targeted for any series in this distribution. Note that you can also specify a driver on each series whose permissions will be limited to that specific series.

homepage_content

(writeable)

Homepage Content

The content of this distribution's home page. Edit this and it will be displayed for all the world to see. It is NOT a wiki so you cannot undo changes.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

icon_link

(writeable)

Link to a file resource.

Icon

A small image of exactly 14x14 pixels and at most 5kb in size, that can be used to identify this distribution. The icon will be displayed everywhere we list the distribution and link to it.

logo_link

(writeable)

Link to a file resource.

Logo

An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to this distribution. It should be no bigger than 50kb in size.

main_archive_link

(read-only)

Link to a archive.

Distribution Main Archive.

members_link

(writeable)

Link to a person.

Members

The distro's members team.

mirror_admin_link

(writeable)

Link to a person.

Mirror Administrator

The person or team that has the rights to review and mark this distribution's mirrors as official.

mugshot_link

(writeable)

Link to a file resource.

Brand

A large image of exactly 192x192 pixels, that will be displayed on this distribution's home page in Launchpad. It should be no bigger than 100kb in size.

name

(writeable)

Name

The distro's name.

official_bug_tags

(writeable)

Official Bug Tags

The list of bug tags defined as official.

owner_link

(writeable)

Link to a person.

Owner

The restricted team, moderated team, or person who maintains the distribution information in Launchpad.

redirect_release_uploads

(writeable)

Redirect release pocket uploads

Redirect release pocket uploads to proposed pocket

registrant_link

(read-only)

Link to a person.

Registrant

The distro's registrant.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

series_collection_link

(read-only)

Link to a distro_series collection.

DistroSeries inside this Distribution

summary

(writeable)

Summary

A short paragraph to introduce the goals and highlights of the distribution.

title

(writeable)

Title

The distro's title.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getArchive

Return the distribution archive with the given name.

Only distribution archives are considered -- PPAs will not be found.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getArchive

name

(required)

Archive name

Response contains an application/json representation of a archive.

getBuildRecords

Return build records in the context it is implemented.

It excludes build records generated by Gina (imported from a external repository), where IBuild.datebuilt is null and IBuild.buildstate is BuildStatus.FULLYBUILT.

The result is simply not filtered if the optional filters are omitted by call sites.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getBuildRecords

build_state

One of:

  • Needs building
  • Successfully built
  • Failed to build
  • Dependency wait
  • Chroot problem
  • Build for superseded Source
  • Currently building
  • Failed to upload
  • Uploading build
  • Cancelling build
  • Cancelled build

Build status

The status of this build record

pocket

One of:

  • Release
  • Security
  • Updates
  • Proposed
  • Backports

Pocket

The pocket into which this entry is published

source_name

Source package name

Response contains an application/json representation of a build collection .

getCountryMirror

Return the country DNS mirror for a country and content type.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getCountryMirror

country

(required)

Link to a country.

Location

The country in which this mirror is based.

mirror_type

(required)

One of:

  • Archive
  • CD Image

Content

Choose "CD Image" if this mirror contains CD images of this distribution. Choose "Archive" if this is a mirror of packages for this distribution.

Response contains an application/json representation of a distribution_mirror.

getDevelopmentSeries

Return the DistroSeries which are marked as in development.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getDevelopmentSeries

Response contains an application/json representation of a distro_series collection .

getMilestone

Return a milestone with the given name for this object, or None.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getMilestone

name

(required)

Name

Response contains an application/json representation of a milestone.

getMirrorByName

Return the mirror with the given name for this distribution or None if it's not found.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getMirrorByName

name

(required)

Name

Response contains an application/json representation of a distribution_mirror.

getSeries

Return the series with the name or version given.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSeries

name_or_version

(required)

Name or version

Response contains an application/json representation of a distro_series.

getSourcePackage

Return a DistributionSourcePackage with the given name for this distribution, or None.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSourcePackage

name

(required)

Package name

Response contains an application/json representation of a distribution_source_package.

getSubscription

Return the subscription for person, if it exists.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

Response contains an application/json representation of a structural_subscription.

getSubscriptions

Return all the subscriptions with the specified levels.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubscriptions

Response contains an application/json representation of a structural_subscription collection .

getTranslationImportQueueEntries

Return entries in the translation import queue for this entity.

If one of both of 'import_status' or 'file_extension' are given, the returned entries are filtered based on those values.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getTranslationImportQueueEntries

file_extension

Filename extension

Show only entries with this filename suffix

import_status

One of:

  • Approved
  • Imported
  • Deleted
  • Failed
  • Needs Review
  • Blocked
  • Needs Information

Status

Show only entries with this status

Response contains an application/json representation of a translation_import_queue_entry collection .

searchSourcePackages

Search for source packages that correspond to the given text.

This method just decorates the result of searchSourcePackageCaches() to return DistributionSourcePackages.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: searchSourcePackages

source_match

(required)

Source package name substring match

Response contains an application/json representation of a distribution_source_package collection .

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: searchTasks

affected_user

Link to a person.

assignee

Link to a person.

bug_commenter

Link to a person.

bug_reporter

Link to a person.

bug_subscriber

Link to a person.

bug_supervisor

Link to a person.

component

Component

Distribution package archive grouping. E.g. main, universe, multiverse

created_before

Search for bugs that were created before the given date.

created_since

Search for bugs that have been created since the given date.

hardware_bus

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The bus of a hardware device related to a bug

hardware_driver_name

The driver controlling a hardware device related to a bug.

hardware_driver_package_name

The package of the driver which controls a hardware device related to a bug.

hardware_is_linked_to_bug

Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.

hardware_owner_is_affected_by_bug

Search for bugs where people affected by a bug own the given device or use the given hardware driver.

hardware_owner_is_bug_reporter

Search for bugs reported by people who own the given device or who use the given hardware driver.

hardware_owner_is_subscribed_to_bug

Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.

hardware_product_id

The product ID of a hardware device related to a bug.

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

hardware_vendor_id

The vendor ID of a hardware device related to a bug.

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

has_cve

Show only bugs associated with a CVE

has_no_package

Exclude bugs with packages specified

has_patch

Show only bugs with patches available.

importance

Importance

Show only bugs with the given importance or list of importances.

information_type

Information Type

Show only bugs with the given information type or list of information types.

linked_branches

One of:

  • Show all bugs
  • Show only Bugs with linked Branches
  • Show only Bugs without linked Branches

Search for bugs that are linked to branches or for bugs that are not linked to branches.

milestone

Milestone

Show only bug tasks targeted to this milestone.

modified_since

Search for bugs that have been modified since the given date.

nominated_for

Link to a distro_series.

omit_duplicates

Omit bugs marked as duplicate,

omit_targeted

Omit bugs targeted to a series

order_by

List of fields by which the results are ordered.

owner

Link to a person.

search_text

Bug ID or search text.

status

Status

Show only bugs with the given status value or list of values.

status_upstream

Status upstream

Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.

structural_subscriber

Link to a person.

tags

Tags

String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'

tags_combinator

One of:

  • Any
  • All

Tags combination

Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

userHasBugSubscriptions

Is user subscribed, directly or via a team, to bug mail?

Parameters
Parameter Value Description

ws.op

(required)

Fixed: userHasBugSubscriptions

Custom POST methods

addBugSubscription

Add a bug subscription for this structure.

This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addBugSubscription

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created structural_subscription.

addBugSubscriptionFilter

Add a bug subscription filter for this structure.

This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addBugSubscriptionFilter

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created bug_subscription_filter.

addOfficialBugTag

Add tag to the official bug tags of this target.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: addOfficialBugTag

tag

(required)

The official bug tag

removeBugSubscription

Remove a subscription to bugs from this structure.

This will delete all associated filters.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: removeBugSubscription

subscriber

Link to a person.

Person to unsubscribe. If omitted, the requesting user will be unsubscribed.

removeOfficialBugTag

Remove tag from the official bug tags of this target.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: removeOfficialBugTag

tag

(required)

The official bug tag

(back to Table of Contents)

distribution_mirror

A mirror of a given distribution.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

content

(writeable)

One of:

  • Archive
  • CD Image

Content

Choose "CD Image" if this mirror contains CD images of this distribution. Choose "Archive" if this is a mirror of packages for this distribution.

country_dns_mirror

(writeable)

Country DNS Mirror

Whether this is a country mirror in DNS.

country_link

(writeable)

Link to a country.

Location

The country in which this mirror is based.

date_created

(read-only)

Date Created

The date on which this mirror was registered.

date_reviewed

(read-only)

Date reviewed

The date on which this mirror was last reviewed by a mirror admin.

description

(writeable)

Description

displayname

(writeable)

Organisation

The name of the organization hosting this mirror.

distribution_link

(read-only)

Link to a distribution.

Distribution

The distribution that is mirrored

enabled

(read-only)

This mirror was probed successfully.

ftp_base_url

(writeable)

http_base_url

(writeable)

http_etag

(read-only)

The value of the HTTP ETag for this resource.

name

(writeable)

Name

A short and unique name for this mirror.

official_candidate

(writeable)

Apply to be an official mirror of this distribution

owner_link

(writeable)

Link to a person.

Owner

The person who is set as the current administrator of thismirror.

resource_type_link

(read-only)

The link to the WADL description of this resource.

reviewer_link

(read-only)

Link to a person.

Reviewer

The person who last reviewed this mirror.

rsync_base_url

(writeable)

Rsync URL

e.g.: rsync://archive.ubuntu.com/ubuntu/

self_link

(read-only)

The canonical link to this resource.

speed

(writeable)

One of:

  • 128 Kbps
  • 256 Kbps
  • 512 Kbps
  • 1 Mbps
  • 2 Mbps
  • 10 Mbps
  • 45 Mbps
  • 100 Mbps
  • 1 Gbps
  • 2 Gbps
  • 4 Gbps
  • 10 Gbps
  • 20 Gbps

Link Speed

status

(writeable)

One of:

  • Pending review
  • Unofficial
  • Official

Status

The current status of a mirror's registration.

web_link

(read-only)

The canonical human-addressable web link to this resource.

whiteboard

(writeable)

Whiteboard

Notes on the current status of the mirror (only visible to admins and the mirror's registrant).

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

canTransitionToCountryMirror

Verify if a mirror can be set as a country mirror or return False.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: canTransitionToCountryMirror

getOverallFreshness

Return this mirror's overall freshness.

For ARCHIVE mirrors, the overall freshness is the worst freshness of all of this mirror's content objects (MirrorDistroArchSeries, MirrorDistroSeriesSource or MirrorCDImageDistroSeriess).

For RELEASE mirrors, the overall freshness is either UPTODATE, if the mirror contains all ISO images that it should or UNKNOWN if it doesn't contain one or more ISO images.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: getOverallFreshness

isOfficial

Return True if this is an official mirror.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: isOfficial

(back to Table of Contents)

distribution_source_package

Represents a source package in a distribution.

Create IDistributionSourcePackages by invoking IDistribution.getSourcePackage().

https://api.launchpad.net/1.0/<distribution.name>/+source/<name>

Default representation (application/json)

Key Value Description

bug_reported_acknowledgement

(writeable)

After reporting a bug, I can expect the following.

This message of acknowledgement will be displayed to anyone after reporting a bug.

bug_reporting_guidelines

(writeable)

Helpful guidelines for reporting a bug

These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.

display_name

(read-only)

Display name for this package.

distribution_link

(writeable)

Link to a distribution.

The distribution.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

name

(read-only)

The source package name as text

official_bug_tags

(read-only)

Official Bug Tags

The list of bug tags defined as official.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

title

(read-only)

Title for this package.

upstream_product_link

(read-only)

Link to a project.

The upstream product to which this package is linked.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getBranches

Returns all branches with the given lifecycle status.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getBranches

modified_since

Limit the branches to those modified since this date.

status

A list of branch lifecycle statuses to filter by.

Response contains an application/json representation of a branch collection .

getMergeProposals

Returns all merge proposals of a given status.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getMergeProposals

status

A list of merge proposal statuses to filter by.

Response contains an application/json representation of a branch_merge_proposal collection .

getSubscription

Return the subscription for person, if it exists.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

Response contains an application/json representation of a structural_subscription.

getSubscriptions

Return all the subscriptions with the specified levels.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubscriptions

Response contains an application/json representation of a structural_subscription collection .

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: searchTasks

affected_user

Link to a person.

assignee

Link to a person.

bug_commenter

Link to a person.

bug_reporter

Link to a person.

bug_subscriber

Link to a person.

bug_supervisor

Link to a person.

component

Component

Distribution package archive grouping. E.g. main, universe, multiverse

created_before

Search for bugs that were created before the given date.

created_since

Search for bugs that have been created since the given date.

hardware_bus

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The bus of a hardware device related to a bug

hardware_driver_name

The driver controlling a hardware device related to a bug.

hardware_driver_package_name

The package of the driver which controls a hardware device related to a bug.

hardware_is_linked_to_bug

Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.

hardware_owner_is_affected_by_bug

Search for bugs where people affected by a bug own the given device or use the given hardware driver.

hardware_owner_is_bug_reporter

Search for bugs reported by people who own the given device or who use the given hardware driver.

hardware_owner_is_subscribed_to_bug

Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.

hardware_product_id

The product ID of a hardware device related to a bug.

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

hardware_vendor_id

The vendor ID of a hardware device related to a bug.

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

has_cve

Show only bugs associated with a CVE

has_no_package

Exclude bugs with packages specified

has_patch

Show only bugs with patches available.

importance

Importance

Show only bugs with the given importance or list of importances.

information_type

Information Type

Show only bugs with the given information type or list of information types.

linked_branches

One of:

  • Show all bugs
  • Show only Bugs with linked Branches
  • Show only Bugs without linked Branches

Search for bugs that are linked to branches or for bugs that are not linked to branches.

milestone

Milestone

Show only bug tasks targeted to this milestone.

modified_since

Search for bugs that have been modified since the given date.

nominated_for

Link to a distro_series.

omit_duplicates

Omit bugs marked as duplicate,

omit_targeted

Omit bugs targeted to a series

order_by

List of fields by which the results are ordered.

owner

Link to a person.

search_text

Bug ID or search text.

status

Status

Show only bugs with the given status value or list of values.

status_upstream

Status upstream

Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.

structural_subscriber

Link to a person.

tags

Tags

String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'

tags_combinator

One of:

  • Any
  • All

Tags combination

Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

userHasBugSubscriptions

Is user subscribed, directly or via a team, to bug mail?

Parameters
Parameter Value Description

ws.op

(required)

Fixed: userHasBugSubscriptions

Custom POST methods

addBugSubscription

Add a bug subscription for this structure.

This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addBugSubscription

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created structural_subscription.

addBugSubscriptionFilter

Add a bug subscription filter for this structure.

This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addBugSubscriptionFilter

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created bug_subscription_filter.

removeBugSubscription

Remove a subscription to bugs from this structure.

This will delete all associated filters.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: removeBugSubscription

subscriber

Link to a person.

Person to unsubscribe. If omitted, the requesting user will be unsubscribed.

(back to Table of Contents)

distro_arch_series

An architecture for a distroseries.

https://api.launchpad.net/1.0/<distribution.name>/<distroseries.name>/<architecture_tag>

Default representation (application/json)

Key Value Description

architecture_tag

(writeable)

Architecture Tag

The architecture tag, or short piece of text that identifies this architecture. All binary packages in the archive will use this tag in their filename. Please get it correct. It should really never be changed!

chroot_url

(read-only)

Build chroot URL

The URL to the current build chroot for this distroarchseries.

display_name

(writeable)

Display name

The display name of this distroarchseries.

distroseries_link

(writeable)

Link to a distro_series.

The context distroseries

http_etag

(read-only)

The value of the HTTP ETag for this resource.

is_nominated_arch_indep

(writeable)

Is Nominated Arch Independent

True if this distroarchseries is the NominatedArchIndep one.

main_archive_link

(writeable)

Link to a archive.

Main Archive

The main archive of the distroarchseries.

official

(writeable)

Official Support

Indicate whether or not this port has official support from the vendor of the distribution.

owner_link

(writeable)

Link to a person.

The person who registered this port.

package_count

(writeable)

Package Count

A cache of the number of packages published in the RELEASE pocket of this port.

processor_link

(read-only)

Link to a processor.

Processor

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

supports_virtualized

(writeable)

PPA support available

Indicate whether or not this port has support for building PPA packages.

title

(writeable)

Title

The title of this distroarchseries.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getBuildRecords

Return build records in the context it is implemented.

It excludes build records generated by Gina (imported from a external repository), where IBuild.datebuilt is null and IBuild.buildstate is BuildStatus.FULLYBUILT.

The result is simply not filtered if the optional filters are omitted by call sites.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getBuildRecords

build_state

One of:

  • Needs building
  • Successfully built
  • Failed to build
  • Dependency wait
  • Chroot problem
  • Build for superseded Source
  • Currently building
  • Failed to upload
  • Uploading build
  • Cancelling build
  • Cancelled build

Build status

The status of this build record

pocket

One of:

  • Release
  • Security
  • Updates
  • Proposed
  • Backports

Pocket

The pocket into which this entry is published

source_name

Source package name

Response contains an application/json representation of a build collection .

(back to Table of Contents)

distro_series

A series of an operating system distribution.

https://api.launchpad.net/1.0/<distribution.name>/<name>

Default representation (application/json)

Key Value Description

active

(writeable)

Active

Whether or not this series is stable and supported, or under current development. This excludes series which are experimental or obsolete.

active_milestones_collection_link

(read-only)

Link to a milestone collection.

The visible and active milestones associated with this object, ordered by date expected.

all_milestones_collection_link

(read-only)

Link to a milestone collection.

All milestones associated with this object, ordered by date expected.

architectures_collection_link

(read-only)

Link to a distro_arch_series collection.

Enabled architectures

All architectures in this series with the 'enabled' flag set.

bug_reported_acknowledgement

(writeable)

After reporting a bug, I can expect the following.

This message of acknowledgement will be displayed to anyone after reporting a bug.

bug_reporting_guidelines

(writeable)

Helpful guidelines for reporting a bug

These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.

changeslist

(writeable)

E-mail changes to

The mailing list or other e-mail address that Launchpad should notify about new uploads.

component_names

(read-only)

The series component names

date_created

(writeable)

The date this series was registered.

datereleased

(writeable)

Date released

description

(writeable)

Description

A detailed description of this series, with information on the architectures covered, the availability of security updates and any other relevant information.

displayname

(writeable)

Display name

The series displayname.

distribution_link

(writeable)

Link to a distribution.

Distribution

The distribution for which this is a series.

driver_link

(writeable)

Link to a person.

Driver

The person or team responsible for decisions about features and bugs that will be targeted to this series of the distribution.

drivers_collection_link

(read-only)

Link to a person collection.

A list of the people or teams who are drivers for this series. This list is made up of any drivers or owners from this series and the parent drivers.

fullseriesname

(writeable)

Series full name

The series full name, e.g. Ubuntu Warty

http_etag

(read-only)

The value of the HTTP ETag for this resource.

include_long_descriptions

(writeable)

Include long descriptions in Packages rather than in Translation-en

If True, write long descriptions to the per-architecture Packages files; if False, write them to a Translation-en file common across architectures instead. Using a common file reduces the bandwidth footprint of enabling multiarch on clients, which requires downloading Packages files for multiple architectures.

main_archive_link

(writeable)

Link to a archive.

Distribution Main Archive

name

(writeable)

Name

The name of this series.

nominatedarchindep_link

(writeable)

Link to a distro_arch_series.

DistroArchSeries designed to build architecture-independent packages whithin this distroseries context.

official_bug_tags

(read-only)

Official Bug Tags

The list of bug tags defined as official.

owner_link

(read-only)

Link to a person.

Owning team of the derived series

This attribute mirrors the owner of the distribution.

parent_series_link

(read-only)

Link to a distro_series.

Parent series

The series from which this one was branched.

registrant_link

(writeable)

Link to a person.

Registrant

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

status

(writeable)

One of:

  • Experimental
  • Active Development
  • Pre-release Freeze
  • Current Stable Release
  • Supported
  • Obsolete
  • Future

Status

suite_names

(read-only)

The series pocket names

summary

(writeable)

Summary

A single paragraph that explains the goals of of this series and the intended users. For example: "The 2.0 series of Apache represents the current stable series, and is recommended for all new deployments".

supported

(writeable)

Supported

Whether or not this series is currently supported.

title

(writeable)

Title

The title of this series. It should be distinctive and designed to look good at the top of a page.

version

(writeable)

Version

The version string for this series.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getBuildRecords

Return build records in the context it is implemented.

It excludes build records generated by Gina (imported from a external repository), where IBuild.datebuilt is null and IBuild.buildstate is BuildStatus.FULLYBUILT.

The result is simply not filtered if the optional filters are omitted by call sites.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getBuildRecords

build_state

One of:

  • Needs building
  • Successfully built
  • Failed to build
  • Dependency wait
  • Chroot problem
  • Build for superseded Source
  • Currently building
  • Failed to upload
  • Uploading build
  • Cancelling build
  • Cancelled build

Build status

The status of this build record

pocket

One of:

  • Release
  • Security
  • Updates
  • Proposed
  • Backports

Pocket

The pocket into which this entry is published

source_name

Source package name

Response contains an application/json representation of a build collection .

getDerivedSeries

Get all DistroSeries derived from this one.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getDerivedSeries

Response contains an application/json representation of a distro_series collection .

getDistroArchSeries

Return the distroarchseries for this distroseries with the given architecturetag.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getDistroArchSeries

archtag

(required)

The architecture tag

Response contains an application/json representation of a distro_arch_series.

getPackageUploads

Get package upload records for this distribution series.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getPackageUploads

archive

Link to a archive.

Archive

Return only items for this archive.

created_since_date

Created Since Timestamp

Return items that are more recent than this timestamp.

custom_type

One of:

  • raw-installer
  • raw-translations
  • raw-dist-upgrader
  • raw-ddtp-tarball
  • raw-translations-static
  • meta-data
  • uefi

Custom Type

Return only items with custom files of this type.

exact_match

Exact match

Whether to filter name and version by exact matching.

name

Package or file name

pocket

One of:

  • Release
  • Security
  • Updates
  • Proposed
  • Backports

Pocket

Return only items targeted to this pocket

status

One of:

  • New
  • Unapproved
  • Accepted
  • Done
  • Rejected

Package Upload Status

Return only items that have this status.

version

Package version

Response contains an application/json representation of a package_upload collection .

getParentSeries

Get all parent DistroSeries.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getParentSeries

Response contains an application/json representation of a distro_series collection .

getSourcePackage

Return a source package in this distro series by name.

The name given may be a string or an ISourcePackageName-providing object. The source package may not be published in the distro series.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSourcePackage

name

(required)

The name of the source package

Response contains an application/json representation of a source_package.

getSubscription

Return the subscription for person, if it exists.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

Response contains an application/json representation of a structural_subscription.

getSubscriptions

Return all the subscriptions with the specified levels.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubscriptions

Response contains an application/json representation of a structural_subscription collection .

getTranslationImportQueueEntries

Return entries in the translation import queue for this entity.

If one of both of 'import_status' or 'file_extension' are given, the returned entries are filtered based on those values.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getTranslationImportQueueEntries

file_extension

Filename extension

Show only entries with this filename suffix

import_status

One of:

  • Approved
  • Imported
  • Deleted
  • Failed
  • Needs Review
  • Blocked
  • Needs Information

Status

Show only entries with this status

Response contains an application/json representation of a translation_import_queue_entry collection .

getTranslationTemplates

Return an iterator over all its translation templates.

The returned templates are either obsolete or current.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getTranslationTemplates

Response contains an application/json representation of a translation_template collection .

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: searchTasks

affected_user

Link to a person.

assignee

Link to a person.

bug_commenter

Link to a person.

bug_reporter

Link to a person.

bug_subscriber

Link to a person.

bug_supervisor

Link to a person.

component

Component

Distribution package archive grouping. E.g. main, universe, multiverse

created_before

Search for bugs that were created before the given date.

created_since

Search for bugs that have been created since the given date.

hardware_bus

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The bus of a hardware device related to a bug

hardware_driver_name

The driver controlling a hardware device related to a bug.

hardware_driver_package_name

The package of the driver which controls a hardware device related to a bug.

hardware_is_linked_to_bug

Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.

hardware_owner_is_affected_by_bug

Search for bugs where people affected by a bug own the given device or use the given hardware driver.

hardware_owner_is_bug_reporter

Search for bugs reported by people who own the given device or who use the given hardware driver.

hardware_owner_is_subscribed_to_bug

Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.

hardware_product_id

The product ID of a hardware device related to a bug.

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

hardware_vendor_id

The vendor ID of a hardware device related to a bug.

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

has_cve

Show only bugs associated with a CVE

has_no_package

Exclude bugs with packages specified

has_patch

Show only bugs with patches available.

importance

Importance

Show only bugs with the given importance or list of importances.

information_type

Information Type

Show only bugs with the given information type or list of information types.

linked_branches

One of:

  • Show all bugs
  • Show only Bugs with linked Branches
  • Show only Bugs without linked Branches

Search for bugs that are linked to branches or for bugs that are not linked to branches.

milestone

Milestone

Show only bug tasks targeted to this milestone.

modified_since

Search for bugs that have been modified since the given date.

nominated_for

Link to a distro_series.

omit_duplicates

Omit bugs marked as duplicate,

omit_targeted

Omit bugs targeted to a series

order_by

List of fields by which the results are ordered.

owner

Link to a person.

search_text

Bug ID or search text.

status

Status

Show only bugs with the given status value or list of values.

status_upstream

Status upstream

Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.

structural_subscriber

Link to a person.

tags

Tags

String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'

tags_combinator

One of:

  • Any
  • All

Tags combination

Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

userHasBugSubscriptions

Is user subscribed, directly or via a team, to bug mail?

Parameters
Parameter Value Description

ws.op

(required)

Fixed: userHasBugSubscriptions

Custom POST methods

addBugSubscription

Add a bug subscription for this structure.

This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addBugSubscription

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created structural_subscription.

addBugSubscriptionFilter

Add a bug subscription filter for this structure.

This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addBugSubscriptionFilter

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created bug_subscription_filter.

initDerivedDistroSeries

Initialize this series from parents.

This method performs checks and then creates a job to populate the new distroseries.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: initDerivedDistroSeries

archindep_archtag

Architecture tag to build architecture-independent packages.

architectures

The list of architectures to copy to the derived distroseries.

overlay_components

The list of overlay components.

overlay_pockets

The list of overlay pockets.

overlays

The list of booleans indicating, for each parent, if the parent/child relationship should be an overlay.

packagesets

The list of packagesets to copy to the derived distroseries

parents

(required)

The list of parents to derive from.

rebuild

If binaries will be copied to the derived distroseries.

newMilestone

Create a new milestone for this DistroSeries.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: newMilestone

code_name

Code name

An alternative name for the milestone.

date_targeted

Date Targeted

Example: 2005-11-24

name

(required)

Name

Only letters, numbers, and simple punctuation are allowed.

summary

Summary

A summary of the features and status of this milestone.

On success, the response status will be 201 and the Location header will contain the link to the newly created milestone.

removeBugSubscription

Remove a subscription to bugs from this structure.

This will delete all associated filters.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: removeBugSubscription

subscriber

Link to a person.

Person to unsubscribe. If omitted, the requesting user will be unsubscribed.

(back to Table of Contents)

distro_series_difference

An interface for a package difference between two distroseries.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

base_version

(read-only)

Base version

The common base version of the package for differences with different versions in the parent and derived series.

derived_series_link

(read-only)

Link to a distro_series.

Derived series

The distribution series which identifies the derived series with the difference.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

package_diff_status

(read-only)

One of:

  • Pending
  • Completed
  • Failed

Package diff status

The status of the diff between the base version and the derived version.

package_diff_url

(read-only)

Package diff url

The url for the diff between the base version and the derived version.

parent_package_diff_status

(read-only)

One of:

  • Pending
  • Completed
  • Failed

Parent package diff status

The status of the diff between the base version and the parent version.

parent_package_diff_url

(read-only)

Parent package diff url

The url for the diff between the base version and the parent version.

parent_series_link

(read-only)

Link to a distro_series.

Parent series

The distribution series which identifies the parent series with the difference.

parent_source_version

(read-only)

Parent source version

The version of the most recent source publishing in the parent series.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

source_version

(read-only)

Source version

The version of the most recent source publishing in the derived series.

sourcepackagename

(read-only)

Source Package Name

status

(read-only)

One of:

  • Needs attention
  • Blacklisted current version
  • Blacklisted always
  • Resolved

Distro series difference status.

The current status of this difference.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

addComment

Add a comment on this difference.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: addComment

comment

(required)

Comment text

blacklist

Blacklist this version or all versions of this source package and adds a comment on this difference.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: blacklist

all

All

comment

Comment text

Response (application/json)

The created DistroSeriesDifferenceComment object.

requestPackageDiffs

Requests IPackageDiffs for the derived and parent version.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: requestPackageDiffs

unblacklist

Removes this difference from the blacklist and adds a comment on this difference.

The status will be updated based on the versions.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: unblacklist

comment

Comment text

Response (application/json)

The created DistroSeriesDifferenceComment object.

(back to Table of Contents)

distro_series_difference_comment

A comment for a distroseries difference record.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

body_text

(read-only)

Comment text

The comment text for the related distro series difference.

comment_author_link

(read-only)

Link to a person.

The author of the comment.

comment_date

(read-only)

Comment date.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

source_package_name

(read-only)

Source package name

Name of the source package that this comment is for.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

email_address

The object that stores the IPerson's emails.

https://api.launchpad.net/1.0/<person.name>/+email/<email>

Default representation (application/json)

Key Value Description

email

(read-only)

Email Address

http_etag

(read-only)

The value of the HTTP ETag for this resource.

person_link

(writeable)

Link to a person.

Person

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

gpg_key

OpenPGP support

https://api.launchpad.net/1.0/<person.name>/+gpg-keys/<keyid>

Default representation (application/json)

Key Value Description

fingerprint

(read-only)

User Fingerprint

http_etag

(read-only)

The value of the HTTP ETag for this resource.

keyid

(read-only)

OpenPGP key ID

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

h_w_device

Core information to identify a device.

https://api.launchpad.net/1.0/+hwdb/+device/<id>

Default representation (application/json)

Key Value Description

bus

(read-only)

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The bus of the device.

bus_product_id

(writeable)

The product identifier of the device

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

classes_collection_link

(read-only)

Link to a h_w_device_class collection.

The device classes this device belongs to.

drivers_collection_link

(read-only)

Link to a h_w_driver collection.

The IHWDriver records related to this device.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

id

(read-only)

Device ID

name

(writeable)

The human readable name of the device.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

variant

(writeable)

A string that distiguishes different devices with identical vendor/product IDs

vendor_id

(read-only)

The vendor iD.

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

vendor_name

(read-only)

The vendor name.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getSubmissions

List all submissions which mention this device.

Only submissions matching all given criteria are returned. Only one of :distribution: or :distroseries: may be supplied.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubmissions

architecture

A processor architecture

If specified, the result set is limited to submissions made for the given architecture.

distribution

Link to a distribution.

A Distribution

If specified, the result set is limited to sumbissions made for the given distribution.

distroseries

Link to a distro_series.

A Distribution Series

If specified, the result set is limited to sumbissions made for the given distribution series.

driver

Link to a h_w_driver.

A driver used for this device in a submission

If specified, the result set is limited to sumbissions made for the given distribution, distroseries or distroarchseries.

owner

Link to a person.

The owner of this submission

Response contains an application/json representation of a h_w_submission collection .

Custom POST methods

getOrCreateDeviceClass

Return an IHWDeviceClass record or create a new one.

main_class and sub_class are integers specifying the class of the device, or, in the case of USB devices, the class of an interface.

IHWDeviceClass records must be unique; if this method is called to create a new record with data of an already existing record, the existing record is returned.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getOrCreateDeviceClass

main_class

(required)

The main class of this device

sub_class

The sub class of this device

Response contains an application/json representation of a h_w_device_class.

removeDeviceClass

Add an IHWDeviceClass record.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: removeDeviceClass

main_class

(required)

The main class of this device

sub_class

The sub class of this device

(back to Table of Contents)

h_w_device_class

The capabilities of a device.

https://api.launchpad.net/1.0/+hwdb/+deviceclass/<id>

Default representation (application/json)

Key Value Description

http_etag

(read-only)

The value of the HTTP ETag for this resource.

main_class

(read-only)

The main class of this device

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

sub_class

(read-only)

The sub class of this device

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

h_w_driver

Information about a device driver.

https://api.launchpad.net/1.0/+hwdb/+driver/<id>

Default representation (application/json)

Key Value Description

http_etag

(read-only)

The value of the HTTP ETag for this resource.

id

(read-only)

Driver ID

license

(writeable)

One of:

  • Academic Free Licence
  • Apache Licence
  • Artistic Licence 1.0
  • Artistic Licence 2.0
  • Simplified BSD Licence
  • Common Public Licence
  • Creative Commons - Attribution
  • Creative Commons - Attribution Share Alike
  • Creative Commons - No Rights Reserved
  • Eclipse Public Licence
  • Educational Community Licence
  • GNU Affero GPL v3
  • GNU FDL no options
  • GNU GPL v2
  • GNU GPL v3
  • GNU LGPL v2.1
  • GNU LGPL v3
  • MIT / X / Expat Licence
  • Mozilla Public Licence
  • Open Font Licence v1.1
  • Open Software Licence v 3.0
  • Perl Licence
  • PHP Licence
  • Public Domain
  • Python Licence
  • Zope Public Licence
  • I don't know yet
  • Other/Proprietary
  • Other/Open Source

License of the Driver

name

(writeable)

Driver Name

The name of the driver written without spaces in lowercase letters and numbers.

package_name

(writeable)

Package Name

The name of the package written without spaces in lowercase letters and numbers.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getSubmissions

List all submissions which mention this driver.

Only submissions matching all given criteria are returned. Only one of :distribution: or :distroseries: may be supplied.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubmissions

architecture

A processor architecture

If specified, the result set is limited to sumbissions made for the given architecture.

distribution

Link to a distribution.

A Distribution

If specified, the result set is limited to sumbissions made for the given distribution.

distroseries

Link to a distro_series.

A Distribution Series

If specified, the result set is limited to sumbissions made for the given distribution series.

owner

Link to a person.

The owner of this submission

Response contains an application/json representation of a h_w_submission collection .

(back to Table of Contents)

h_w_driver_name

A driver name as appearing in IHWDriver.

https://api.launchpad.net/1.0/+hwdb/+drivername/<name>

Default representation (application/json)

Key Value Description

http_etag

(read-only)

The value of the HTTP ETag for this resource.

name

(read-only)

Driver Name

The name of a driver as it appears in IHWDriver.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

h_w_driver_package_name

A driver name as appearing in IHWDriver.

https://api.launchpad.net/1.0/+hwdb/+driverpackagename/<package_name>

Default representation (application/json)

Key Value Description

http_etag

(read-only)

The value of the HTTP ETag for this resource.

package_name

(read-only)

Package Name

The name of a package as it appears in IHWDriver.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

h_w_submission

Raw submission data for the hardware database.

See doc/hwdb.txt for details about the attributes.

https://api.launchpad.net/1.0/+hwdb/+submission/<submission-key>

Default representation (application/json)

Key Value Description

contactable

(read-only)

Contactable

date_created

(read-only)

Date Created

date_submitted

(read-only)

Date Submitted

devices_collection_link

(read-only)

Link to a h_w_submission_device collection.

The HWSubmissionDevice records for this submission.

format

(read-only)

One of:

  • Version 1

Format Version

http_etag

(read-only)

The value of the HTTP ETag for this resource.

owner_link

(read-only)

Link to a person.

The owner of this submission

private

(writeable)

Private Submission

raw_submission_link

(read-only)

Link to a file resource.

The raw submission data

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

status

(read-only)

One of:

  • Invalid submission
  • Submitted
  • Processed

Submission Status

submission_key

(read-only)

Unique Submission ID

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

h_w_submission_device

Link a submission to a IHWDeviceDriver row.

https://api.launchpad.net/1.0/+hwdb/+submissiondevice/<id>

Default representation (application/json)

Key Value Description

device_link

(writeable)

Link to a h_w_device.

The device

driver_link

(writeable)

Link to a h_w_driver.

The driver used for this device in this submission

hal_device_id

(writeable)

The ID of the HAL node of this device in the submitted data

http_etag

(read-only)

The value of the HTTP ETag for this resource.

id

(read-only)

HWSubmissionDevice ID

parent_link

(writeable)

Link to a h_w_submission_device.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

h_w_vendor_i_d

A list of vendor IDs for different busses associated with vendor names.

https://api.launchpad.net/1.0/+hwdb/+hwvendorid/<id>

Default representation (application/json)

Key Value Description

bus

(writeable)

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The bus that connects a device to a computer

http_etag

(read-only)

The value of the HTTP ETag for this resource.

id

(read-only)

The Database ID

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

vendor_id

(writeable)

Vendor ID

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

has_bugs

An entity which has a collection of bug tasks.

depends on the underlying entry

Default representation (application/json)

Key Value Description

http_etag

(read-only)

The value of the HTTP ETag for this resource.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: searchTasks

affected_user

Link to a person.

assignee

Link to a person.

bug_commenter

Link to a person.

bug_reporter

Link to a person.

bug_subscriber

Link to a person.

bug_supervisor

Link to a person.

component

Component

Distribution package archive grouping. E.g. main, universe, multiverse

created_before

Search for bugs that were created before the given date.

created_since

Search for bugs that have been created since the given date.

hardware_bus

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The bus of a hardware device related to a bug

hardware_driver_name

The driver controlling a hardware device related to a bug.

hardware_driver_package_name

The package of the driver which controls a hardware device related to a bug.

hardware_is_linked_to_bug

Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.

hardware_owner_is_affected_by_bug

Search for bugs where people affected by a bug own the given device or use the given hardware driver.

hardware_owner_is_bug_reporter

Search for bugs reported by people who own the given device or who use the given hardware driver.

hardware_owner_is_subscribed_to_bug

Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.

hardware_product_id

The product ID of a hardware device related to a bug.

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

hardware_vendor_id

The vendor ID of a hardware device related to a bug.

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

has_cve

Show only bugs associated with a CVE

has_no_package

Exclude bugs with packages specified

has_patch

Show only bugs with patches available.

importance

Importance

Show only bugs with the given importance or list of importances.

information_type

Information Type

Show only bugs with the given information type or list of information types.

linked_branches

One of:

  • Show all bugs
  • Show only Bugs with linked Branches
  • Show only Bugs without linked Branches

Search for bugs that are linked to branches or for bugs that are not linked to branches.

milestone

Milestone

Show only bug tasks targeted to this milestone.

modified_since

Search for bugs that have been modified since the given date.

nominated_for

Link to a distro_series.

omit_duplicates

Omit bugs marked as duplicate,

omit_targeted

Omit bugs targeted to a series

order_by

List of fields by which the results are ordered.

owner

Link to a person.

search_text

Bug ID or search text.

status

Status

Show only bugs with the given status value or list of values.

status_upstream

Status upstream

Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.

structural_subscriber

Link to a person.

tags

Tags

String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'

tags_combinator

One of:

  • Any
  • All

Tags combination

Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

(back to Table of Contents)

has_milestones

An interface for classes providing milestones.

depends on the underlying entry

Default representation (application/json)

Key Value Description

active_milestones_collection_link

(read-only)

Link to a milestone collection.

The visible and active milestones associated with this object, ordered by date expected.

all_milestones_collection_link

(read-only)

Link to a milestone collection.

All milestones associated with this object, ordered by date expected.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

hwdb

Hardware database application application root.

https://api.launchpad.net/1.0/+hwdb

Default representation (application/json)

Key Value Description

driver_names_collection_link

(read-only)

Link to a h_w_driver_name collection.

Driver Names

All known distinct driver names appearing in HWDriver

http_etag

(read-only)

The value of the HTTP ETag for this resource.

package_names_collection_link

(read-only)

Link to a h_w_driver_package_name collection.

Package Names

All known distinct package names appearing in HWDriver.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

deviceDriverOwnersAffectedByBugs

Return persons affected by given bugs and owning a given device.

bug_ids must be a non-empty sequence of bug IDs, or bug_tags must be a non-empty sequence of bug tags.

The parameters bus, vendor_id, product_id must not be None, or driver_name must not be None.

By default, only those persons are returned which have reported a bug matching the given bug conditions.

Owners of private submissions are returned only if user is the owner of the private submission or if user is an admin.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: deviceDriverOwnersAffectedByBugs

affected_by_bug

Search for users affected by a bug

If true, those device owners are looked up which are affected by one of the selected bugs.

bug_ids

A set of bug IDs

Search submitters, subscribers or affected users of bugs with these IDs.

bug_tags

A set of bug tags

Search submitters, subscribers or affected users of bugs having one of these tags.

bus

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The device bus

driver_name

A driver name

If specified, the search is limited to devices controlled by this driver.

package_name

A package name

If specified, the search is limited to devices controlled by a driver from this package.

product_id

The product ID

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

subscribed_to_bug

Search for users who subscribed to a bug

If true, those device owners are looked up which to one of the selected bugs.

vendor_id

The vendor ID

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

Response contains an application/json representation of a person collection .

devices

Return the set of devices.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: devices

bus

(required)

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The device bus

product_id

The product ID

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

vendor_id

(required)

The vendor ID

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

Response contains an application/json representation of a h_w_device collection .

drivers

Return the set of drivers.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: drivers

name

The name of the driver.

If name is omitted, all driver records are returned, optionally limited to those matching the parameter package_name.

package_name

The name of the package containing the driver.

If package_name is omitted, all driver records returned, optionally limited to those matching the parameter name. If package_name is (empty string), those records are returned where package_name is or None.

Response contains an application/json representation of a h_w_driver collection .

hwInfoByBugRelatedUsers

Return a list of owners and devices related to given bugs.

Actually returns a list of tuples where the tuple is of the form, (person name, bus name, vendor id, product id).`

Parameters
Parameter Value Description

ws.op

(required)

Fixed: hwInfoByBugRelatedUsers

affected_by_bug

Search for users affected by a bug

If true, those device owners are looked up which are affected by one of the selected bugs.

bug_ids

A set of bug IDs

Search for devices and their owners related to bugs with these IDs.

bug_tags

A set of bug tags

Search for devices and their owners related to bugs having one of these tags.

subscribed_to_bug

Search for users who subscribed to a bug

If true, those device owners are looked up which to one of the selected bugs.

numDevicesInSubmissions

Count how often a device or a driver appears in HWDB submissions.

You may specify at most one of the parameters distribution, distroseries or distroarchseries.

At least each of bus, vendor_id, product_id must not be None or driver_name must not be None.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: numDevicesInSubmissions

bus

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The device bus

distribution

Link to a distribution.

A Distribution

If specified, the result set is limited to submissions made for this distribution.

distroarchseries

Link to a distro_arch_series.

A Distribution Series

If specified, the result set is limited to submissions made for the given distroarchseries.

distroseries

Link to a distro_series.

A Distribution Series

If specified, the result set is limited to submissions made for the given distribution series.

driver_name

A driver name

If specified, the count is limited to devices controlled by this driver.

package_name

A package name

If specified, the count is limited to devices controlled by a driver from this package.

product_id

The product ID

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

vendor_id

The vendor ID

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

Response (application/json)

The number how often the given device appears in HWDB submissions.

numOwnersOfDevice

The number of people owning a device or using a driver.

Returns a dictionary {'owners': n1, 'all_submitters': n2} where owners is the number of people who made a HWDB submission containing the given device or driver, optionally limited to submissions made for the given distro target. all_submitters is the number of persons who made a HWDB submission, optionally limited to submission made on the given distro target installation.

You may specify at most one of the parameters distribution, distroseries or distroarchseries.

At least each of bus, vendor_id, product_id must not be None or driver_name must not be None.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: numOwnersOfDevice

bus

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The device bus

distribution

Link to a distribution.

A Distribution

If specified, the result set is limited to submissions made for this distribution.

distroarchseries

Link to a distro_arch_series.

A Distribution Series

If specified, the result set is limited to submissions made for the given distroarchseries.

distroseries

Link to a distro_series.

A Distribution Series

If specified, the result set is limited to submissions made for the given distribution series.

driver_name

A driver name

If specified, the count is limited to devices controlled by this driver.

package_name

A package name

If specified, the count is limited to devices controlled by a driver from this package.

product_id

The product ID

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

vendor_id

The vendor ID

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

numSubmissionsWithDevice

Count the number of submissions mentioning a device or a driver.

Returns a dictionary {'submissions_with_device: n1, 'all_submissions': n2}, where submissions_with_device is the number of submissions having the given device or driver and matching the distro target criterion and where all_submissions is the number of submissions matching the distro target criterion.

You may specify at most one of the parameters distribution, distroseries or distroarchseries.

At least each of bus, vendor_id, product_id must not be None or driver_name must not be None.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: numSubmissionsWithDevice

bus

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The device bus

distribution

Link to a distribution.

A Distribution

If specified, the result set is limited to submissions made for this distribution.

distroarchseries

Link to a distro_arch_series.

A Distribution Series

If specified, the result set is limited to submissions made for the given distroarchseries.

distroseries

Link to a distro_series.

A Distribution Series

If specified, the result set is limited to submissions made for the given distribution series.

driver_name

A driver name

If specified, the count is limited to devices controlled by this driver.

package_name

A package name

If specified, the count is limited to devices controlled by a driver from this package.

product_id

The product ID

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

vendor_id

The vendor ID

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

Return the submissions matiching the given parmeters.

Only one of :distribution: or :distroseries: may be supplied.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: search

architecture

A processor architecture

If specified, the result set is limited to sumbissions made for a specific architecture.

created_after

Created After

If specified, exclude results created before or on this date.

created_before

Created Before

If specified, exclude results created after this date.

device

Link to a h_w_device.

A Device

If specified, the result set is limited to submissions containing this device.

distribution

Link to a distribution.

A Distribution

If specified, the result set is limited to submissions made for this distribution.

distroseries

Link to a distro_series.

A Distribution Series

If specified, the result set is limited to submissions made for the given distribution series.

driver

Link to a h_w_driver.

A Driver

If specified, the result set is limited to submissions containing devices that use this driver.

owner

Link to a person.

Person

If specified, the result set is limited to sumbissions from this person.

submitted_after

Created After

If specified, Exclude results submitted before or on this date.

submitted_before

Created Before

If specified, exclude results submitted after this date.

Response contains an application/json representation of a h_w_submission collection .

vendorIDs

Return the known vendor IDs for the given bus.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: vendorIDs

bus

(required)

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

A Device Bus.

Response contains an application/json representation of a h_w_vendor_i_d collection .

(back to Table of Contents)

irc_id

A person's nickname on an IRC network.

https://api.launchpad.net/1.0/<person.name>/+ircnick/<id>

Default representation (application/json)

Key Value Description

http_etag

(read-only)

The value of the HTTP ETag for this resource.

network

(writeable)

IRC network

nickname

(writeable)

Nickname

person_link

(read-only)

Link to a person.

Owner

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

jabber_id

Jabber specific user ID

https://api.launchpad.net/1.0/<person.name>/+jabberid/<id>

Default representation (application/json)

Key Value Description

http_etag

(read-only)

The value of the HTTP ETag for this resource.

jabberid

(writeable)

New Jabber user ID

person_link

(read-only)

Link to a person.

Owner

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

language

A Language.

https://api.launchpad.net/1.0/+languages/<code>

Default representation (application/json)

Key Value Description

code

(writeable)

The ISO 639 code

english_name

(writeable)

The English name

http_etag

(read-only)

The value of the HTTP ETag for this resource.

plural_expression

(writeable)

Plural form expression

The expression that relates a number of items to the appropriate plural form.

plural_forms

(writeable)

Number of plural forms

The number of plural forms this language has.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

text_direction

(writeable)

One of:

  • Left to Right
  • Right to Left

Text direction

The direction of text in this language.

translators_count

(read-only)

Total number of translators for this language.

visible

(writeable)

Visible

Whether this language is visible by default.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

message

A message.

This is like an email (RFC822) message, though it could be created through the web as well.

https://api.launchpad.net/1.0/<target.name>/+bug/<bug.id>/comments/<index>

Default representation (application/json)

Key Value Description

bug_attachments_collection_link

(read-only)

Link to a bug_attachment collection.

A list of BugAttachments connected to this message.

content

(writeable)

All the text/plain chunks joined together as a unicode string.

date_created

(read-only)

Date Created

http_etag

(read-only)

The value of the HTTP ETag for this resource.

owner_link

(read-only)

Link to a person.

Person

parent_link

(read-only)

Link to a message.

Parent

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

subject

(read-only)

Subject

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getAPIParent

Return None because messages are not threaded over the API.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: getAPIParent

(back to Table of Contents)

milestone

Actual interface for milestones.

https://api.launchpad.net/1.0/<target.name>/+milestone/<name>

Default representation (application/json)

Key Value Description

code_name

(writeable)

Code name

An alternative name for the milestone.

date_targeted

(writeable)

Date Targeted

Example: 2005-11-24

http_etag

(read-only)

The value of the HTTP ETag for this resource.

is_active

(writeable)

Active

Whether or not this object should be shown in web forms for targeting.

name

(writeable)

Name

Only letters, numbers, and simple punctuation are allowed.

official_bug_tags

(read-only)

Official Bug Tags

The list of bug tags defined as official.

release_link

(read-only)

Link to a project_release.

The release for this milestone.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

series_target_link

(writeable)

Link to a has_milestones.

The productseries or distroseries of this milestone.

summary

(writeable)

Summary

A summary of the features and status of this milestone.

target_link

(writeable)

Link to a has_milestones.

The product, distribution, or project group for this milestone.

title

(read-only)

A context title for pages.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getSubscription

Return the subscription for person, if it exists.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

Response contains an application/json representation of a structural_subscription.

getSubscriptions

Return all the subscriptions with the specified levels.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubscriptions

Response contains an application/json representation of a structural_subscription collection .

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: searchTasks

affected_user

Link to a person.

assignee

Link to a person.

bug_commenter

Link to a person.

bug_reporter

Link to a person.

bug_subscriber

Link to a person.

bug_supervisor

Link to a person.

component

Component

Distribution package archive grouping. E.g. main, universe, multiverse

created_before

Search for bugs that were created before the given date.

created_since

Search for bugs that have been created since the given date.

hardware_bus

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The bus of a hardware device related to a bug

hardware_driver_name

The driver controlling a hardware device related to a bug.

hardware_driver_package_name

The package of the driver which controls a hardware device related to a bug.

hardware_is_linked_to_bug

Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.

hardware_owner_is_affected_by_bug

Search for bugs where people affected by a bug own the given device or use the given hardware driver.

hardware_owner_is_bug_reporter

Search for bugs reported by people who own the given device or who use the given hardware driver.

hardware_owner_is_subscribed_to_bug

Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.

hardware_product_id

The product ID of a hardware device related to a bug.

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

hardware_vendor_id

The vendor ID of a hardware device related to a bug.

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

has_cve

Show only bugs associated with a CVE

has_no_package

Exclude bugs with packages specified

has_patch

Show only bugs with patches available.

importance

Importance

Show only bugs with the given importance or list of importances.

information_type

Information Type

Show only bugs with the given information type or list of information types.

linked_branches

One of:

  • Show all bugs
  • Show only Bugs with linked Branches
  • Show only Bugs without linked Branches

Search for bugs that are linked to branches or for bugs that are not linked to branches.

milestone

Milestone

Show only bug tasks targeted to this milestone.

modified_since

Search for bugs that have been modified since the given date.

nominated_for

Link to a distro_series.

omit_duplicates

Omit bugs marked as duplicate,

omit_targeted

Omit bugs targeted to a series

order_by

List of fields by which the results are ordered.

owner

Link to a person.

search_text

Bug ID or search text.

status

Status

Show only bugs with the given status value or list of values.

status_upstream

Status upstream

Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.

structural_subscriber

Link to a person.

tags

Tags

String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'

tags_combinator

One of:

  • Any
  • All

Tags combination

Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

userHasBugSubscriptions

Is user subscribed, directly or via a team, to bug mail?

Parameters
Parameter Value Description

ws.op

(required)

Fixed: userHasBugSubscriptions

Custom POST methods

addBugSubscription

Add a bug subscription for this structure.

This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addBugSubscription

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created structural_subscription.

addBugSubscriptionFilter

Add a bug subscription filter for this structure.

This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addBugSubscriptionFilter

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created bug_subscription_filter.

createProductRelease

Create a new ProductRelease.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: createProductRelease

changelog

Changelog

A description of every change in the release.

date_released

(required)

Date released

The date this release was published. Before release, this should have an estimated release date.

release_notes

Release notes

A description of important new features (though the changelog below might repeat some of this information).

On success, the response status will be 201 and the Location header will contain the link to the newly created project_release.

removeBugSubscription

Remove a subscription to bugs from this structure.

This will delete all associated filters.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: removeBugSubscription

subscriber

Link to a person.

Person to unsubscribe. If omitted, the requesting user will be unsubscribed.

(back to Table of Contents)

object_with_translation_imports

An entity that has a translation import queue.

Examples include ProductSeries, SourcePackage, DistroSeries, and Person.

depends on the underlying entry

Default representation (application/json)

Key Value Description

http_etag

(read-only)

The value of the HTTP ETag for this resource.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getTranslationImportQueueEntries

Return entries in the translation import queue for this entity.

If one of both of 'import_status' or 'file_extension' are given, the returned entries are filtered based on those values.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getTranslationImportQueueEntries

file_extension

Filename extension

Show only entries with this filename suffix

import_status

One of:

  • Approved
  • Imported
  • Deleted
  • Failed
  • Needs Review
  • Blocked
  • Needs Information

Status

Show only entries with this status

Response contains an application/json representation of a translation_import_queue_entry collection .

(back to Table of Contents)

package_upload

A Queue item for the archive uploader.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

archive_link

(read-only)

Link to a archive.

Archive

The archive for this upload.

copy_source_archive_link

(read-only)

Link to a archive.

Copy source archive

The archive from which this package was copied, if any.

custom_file_urls

(read-only)

Custom file URLs

Librarian URLs for all the custom files attached to this upload.

date_created

(writeable)

Date created

The date this package upload was done.

display_arches

(read-only)

Architectures related to this item

display_name

(read-only)

Generic displayname for a queue item

display_version

(read-only)

This item's displayable source package version

distroseries_link

(writeable)

Link to a distro_series.

Series

The distroseries targeted by this upload.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

id

(read-only)

ID

pocket

(writeable)

One of:

  • Release
  • Security
  • Updates
  • Proposed
  • Backports

The pocket

The pocket targeted by this upload.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

status

(read-only)

One of:

  • New
  • Unapproved
  • Accepted
  • Done
  • Rejected

Queue status

The status of this upload.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

packageset

An interface for package sets.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

date_created

(read-only)

Date Created

The creation date/time for the package set at hand.

description

(writeable)

Description

The description for the package set at hand.

distroseries_link

(read-only)

Link to a distro_series.

Distribution series

The distroseries to which this package set is related.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

id

(read-only)

ID

name

(writeable)

Valid package set name

owner_link

(writeable)

Link to a person.

Person

The person who owns this package set.

relative_build_score

(writeable)

Build score

Build score bonus for packages in this package set.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getSourcesIncluded

Get all source names associated with this package set.

This method returns the source package names that are directly or indirectly associated with the package set at hand. Indirect associations may be defined through package set successors.

Please note: this method was mainly introduced in order to facilitate the listing of source package names via the LP web services API. It returns string names as opposed to ISourcePackageName instances.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: getSourcesIncluded

direct_inclusion

Response (application/json)

A (potentially empty) sequence of string source package names.

getSourcesNotSharedBy

Get source package names not included by another package set.

Which source package names included by this package are not included by the other_package_set?

Please note: this method was mainly introduced in order to facilitate the listing of source package names via the LP web services API. It returns string names as opposed to ISourcePackageName instances.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: getSourcesNotSharedBy

direct_inclusion

other_package_set

(required)

Link to a packageset.

The package set we are comparing to.

Response (application/json)

A (potentially empty) sequence of string source package names.

getSourcesSharedBy

Get source package names also included by another package set.

What source package names does this package set have in common with the other_package_set?

Please note: this method was mainly introduced in order to facilitate the listing of source package names via the LP web services API. It returns string names as opposed to ISourcePackageName instances.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: getSourcesSharedBy

direct_inclusion

other_package_set

(required)

Link to a packageset.

The package set we are comparing to.

Response (application/json)

A (potentially empty) sequence of string source package names.

relatedSets

Get all other package sets in this set's PackagesetGroup.

Returns all package sets that are related to this one, but not this one itself.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: relatedSets

Response contains an application/json representation of a packageset collection .

setsIncluded

Get all package sets that are included by this one.

Return all package sets that are directly or indirectly included by this one.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: setsIncluded

direct_inclusion

Response contains an application/json representation of a packageset collection .

setsIncludedBy

Get all package sets that include this one.

Return all package sets that directly or indirectly include this one.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: setsIncludedBy

direct_inclusion

Response contains an application/json representation of a packageset collection .

Custom POST methods

addSources

Add the named source packages to this package set.

Any passed source package names will become directly associated with the package set at hand.

This function is idempotent in the sense that source package names that are already directly associated with a package set will be ignored.

This method facilitates the addition of source package names to package sets via the LP web services API. It takes string names as opposed to ISourcePackageName instances. Non-existing source package names will be ignored.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: addSources

names

(required)

A list of source package names.

addSubsets

Add the named package sets as subsets to this package set.

Any passed source package names will become directly associated with the package set at hand.

This function is idempotent in the sense that package subsets that are already directly associated with a package set will be ignored.

This method facilitates the addition of package subsets via the LP web services API. It takes string names as opposed to IPackageset instances.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: addSubsets

names

(required)

A list of package set names.

removeSources

Remove the named source packages from this package set.

Only source package names directly included by this package set can be removed. Any others will be ignored.

This method facilitates the removal of source package names from package sets via the LP web services API. It takes string names as opposed to ISourcePackageName instances.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: removeSources

names

(required)

A list of source package names.

removeSubsets

Remove the named package subsets from this package set.

Only package subsets directly included by this package set can be removed. Any others will be ignored.

This method facilitates the removal of package subsets via the LP web services API. It takes string names as opposed to IPackageset instances.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: removeSubsets

names

(required)

A list of package set names.

(back to Table of Contents)

person

A Person.

https://api.launchpad.net/1.0/~<name>

Default representation (application/json)

Key Value Description

admins_collection_link

(read-only)

Link to a person collection.

List of this team's admins.

archive_link

(read-only)

Link to a archive.

Default PPA

The PPA named 'ppa' owned by this person.

confirmed_email_addresses_collection_link

(read-only)

Link to a email_address collection.

Confirmed e-mails of this person.

Confirmed e-mails are the ones in the VALIDATED state

date_created

(read-only)

Date Created

deactivated_members_collection_link

(read-only)

Link to a person collection.

All members whose membership is in the DEACTIVATED state

description

(writeable)

Description

Details about interests and goals. Use plain text, paragraphs are preserved and URLs are linked.

display_name

(writeable)

Display Name

Your name as you would like it displayed throughout Launchpad. Most people use their full name here.

expired_members_collection_link

(read-only)

Link to a person collection.

All members whose membership is in the EXPIRED state

gpg_keys_collection_link

(read-only)

Link to a gpg_key collection.

List of valid OpenPGP keys ordered by ID

hardware_submissions_collection_link

(read-only)

Link to a h_w_submission collection.

Hardware submissions

hide_email_addresses

(writeable)

Hide my email addresses from other Launchpad users

homepage_content

(writeable)

Homepage Content

Obsolete. Use description.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

invited_members_collection_link

(read-only)

Link to a person collection.

All members whose membership is in the INVITED state

irc_nicknames_collection_link

(read-only)

Link to a irc_id collection.

List of IRC nicknames of this Person.

is_probationary

(read-only)

Is this a probationary user?

is_team

(read-only)

Is this object a team?

is_ubuntu_coc_signer

(read-only)

Signed Ubuntu Code of Conduct

is_valid

(read-only)

This is an active user or a team.

jabber_ids_collection_link

(read-only)

Link to a jabber_id collection.

List of Jabber IDs of this Person.

karma

(read-only)

Karma

The cached total karma for this person.

languages_collection_link

(read-only)

Link to a language collection.

List of languages known by this person

latitude

(read-only)

The latitude of this object.

logo_link

(writeable)

Link to a file resource.

Logo

An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to you. Traditionally this is a logo, a small picture or a personal mascot. It should be no bigger than 50kb in size.

longitude

(read-only)

The longitude of this object.

mailing_list_auto_subscribe_policy

(writeable)

One of:

  • Never subscribe to mailing lists
  • Ask me when I join a team
  • Always subscribe me to mailing lists

Mailing List Auto-subscription Policy

This attribute determines whether a person is automatically subscribed to a team's mailing list when the person joins said team.

members_collection_link

(read-only)

Link to a person collection.

List of direct members with ADMIN or APPROVED status

members_details_collection_link

(read-only)

Link to a team_membership collection.

Active TeamMemberships for this object's members.

Active TeamMemberships are the ones with the ADMIN or APPROVED status. The results are ordered using Person.sortingColumns.

memberships_details_collection_link

(read-only)

Link to a team_membership collection.

All TeamMemberships for Teams this Team or Person is an active member of.

mugshot_link

(writeable)

Link to a file resource.

Mugshot

A large image of exactly 192x192 pixels, that will be displayed on your home page in Launchpad. Traditionally this is a great big picture of your grinning face. Make the most of it! It should be no bigger than 100kb in size.

name

(writeable)

Name

A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.

open_membership_invitations_collection_link

(read-only)

Link to a team_membership collection.

Open membership invitations.

All TeamMemberships which represent an invitation (to join a team) sent to this person.

participants_collection_link

(read-only)

Link to a person collection.

All participants of this team.

List of all direct and indirect people and teams who, one way or another, are a part of this team. If you want a method to check if a given person is a member of a team, you should probably look at IPerson.inTeam().

ppas_collection_link

(read-only)

Link to a archive collection.

PPAs for this person.

PPAs owned by the context person ordered by name.

preferred_email_address_link

(read-only)

Link to a email_address.

Preferred email address

The preferred email address for this person. The one we'll use to communicate with them.

private

(read-only)

This team is private

Private teams are visible only to their members.

proposed_members_collection_link

(read-only)

Link to a person collection.

All members whose membership is in the PROPOSED state

recipes_collection_link

(read-only)

Link to a source_package_recipe collection.

All recipes associated with the object.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

sshkeys_collection_link

(read-only)

Link to a ssh_key collection.

List of SSH keys

sub_teams_collection_link

(read-only)

Link to a team collection.

All subteams of this team.

A subteam is any team that is a member (either directly or indirectly) of this team. As an example, let's say we have this hierarchy of teams:

Rosetta Translators
Rosetta pt Translators
Rosetta pt_BR Translators

In this case, both 'Rosetta pt Translators' and 'Rosetta pt_BR Translators' are subteams of the 'Rosetta Translators' team, and all members of both subteams are considered members of "Rosetta Translators".

super_teams_collection_link

(read-only)

Link to a team collection.

All superteams of this team.

A superteam is any team that this team is a member of. For example, let's say we have this hierarchy of teams, and we are the "Rosetta pt_BR Translators":

Rosetta Translators
Rosetta pt Translators
Rosetta pt_BR Translators

In this case, we will return both 'Rosetta pt Translators' and 'Rosetta Translators', because we are member of both of them.

team_owner_link

(writeable)

Link to a person.

Team Owner

time_zone

(read-only)

The time zone of this object.

visibility

(writeable)

One of:

  • Public
  • Private

Visibility

Anyone can see a public team's data. Only team members can see private team data.

web_link

(read-only)

The canonical human-addressable web link to this resource.

wiki_names_collection_link

(read-only)

Link to a wiki_name collection.

All WikiNames of this Person, sorted alphabetically by URL.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getArchiveSubscriptionURLs

Return private archive URLs that this person can see.

For each of the private archives (PPAs) that this person can see, return a URL that includes the HTTP basic auth data. The URL returned is suitable for including in a sources.list file.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: getArchiveSubscriptionURLs

getBranches

Returns all branches with the given lifecycle status.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getBranches

modified_since

Limit the branches to those modified since this date.

status

A list of branch lifecycle statuses to filter by.

Response contains an application/json representation of a branch collection .

getBugSubscriberPackages

Return the packages for which this person is a bug subscriber.

Returns a list of IDistributionSourcePackage's, ordered alphabetically (A to Z) by name.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getBugSubscriberPackages

Response contains an application/json representation of a distribution_source_package collection .

getMembersByStatus

Return the people whose membership on this team match :status:.

If no orderby is provided, Person.sortingColumns is used.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getMembersByStatus

status

(required)

One of:

  • Proposed
  • Approved
  • Administrator
  • Deactivated
  • Expired
  • Declined
  • Invited
  • Invitation declined

The state of this membership

Response contains an application/json representation of a person collection .

getMergeProposals

Returns all merge proposals of a given status.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getMergeProposals

status

A list of merge proposal statuses to filter by.

Response contains an application/json representation of a branch_merge_proposal collection .

getPPAByName

Return a PPA with the given name if it exists.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getPPAByName

name

(required)

Response contains an application/json representation of a archive.

getRecipe

Return the person's recipe with the given name.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getRecipe

name

(required)

Response contains an application/json representation of a source_package_recipe.

getRequestedReviews

Returns merge proposals where a person was asked to review.

This does not include merge proposals that were requested from teams that the person is part of. If status is not passed then it will return proposals that are in the "Needs Review" state.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getRequestedReviews

status

A list of merge proposal statuses to filter by.

Response contains an application/json representation of a branch_merge_proposal collection .

getTranslationImportQueueEntries

Return entries in the translation import queue for this entity.

If one of both of 'import_status' or 'file_extension' are given, the returned entries are filtered based on those values.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getTranslationImportQueueEntries

file_extension

Filename extension

Show only entries with this filename suffix

import_status

One of:

  • Approved
  • Imported
  • Deleted
  • Failed
  • Needs Review
  • Blocked
  • Needs Information

Status

Show only entries with this status

Response contains an application/json representation of a translation_import_queue_entry collection .

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: searchTasks

affected_user

Link to a person.

assignee

Link to a person.

bug_commenter

Link to a person.

bug_reporter

Link to a person.

bug_subscriber

Link to a person.

bug_supervisor

Link to a person.

component

Component

Distribution package archive grouping. E.g. main, universe, multiverse

created_before

Search for bugs that were created before the given date.

created_since

Search for bugs that have been created since the given date.

hardware_bus

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The bus of a hardware device related to a bug

hardware_driver_name

The driver controlling a hardware device related to a bug.

hardware_driver_package_name

The package of the driver which controls a hardware device related to a bug.

hardware_is_linked_to_bug

Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.

hardware_owner_is_affected_by_bug

Search for bugs where people affected by a bug own the given device or use the given hardware driver.

hardware_owner_is_bug_reporter

Search for bugs reported by people who own the given device or who use the given hardware driver.

hardware_owner_is_subscribed_to_bug

Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.

hardware_product_id

The product ID of a hardware device related to a bug.

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

hardware_vendor_id

The vendor ID of a hardware device related to a bug.

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

has_cve

Show only bugs associated with a CVE

has_no_package

Exclude bugs with packages specified

has_patch

Show only bugs with patches available.

importance

Importance

Show only bugs with the given importance or list of importances.

information_type

Information Type

Show only bugs with the given information type or list of information types.

linked_branches

One of:

  • Show all bugs
  • Show only Bugs with linked Branches
  • Show only Bugs without linked Branches

Search for bugs that are linked to branches or for bugs that are not linked to branches.

milestone

Milestone

Show only bug tasks targeted to this milestone.

modified_since

Search for bugs that have been modified since the given date.

nominated_for

Link to a distro_series.

omit_duplicates

Omit bugs marked as duplicate,

omit_targeted

Omit bugs targeted to a series

order_by

List of fields by which the results are ordered.

owner

Link to a person.

search_text

Bug ID or search text.

status

Status

Show only bugs with the given status value or list of values.

status_upstream

Status upstream

Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.

structural_subscriber

Link to a person.

tags

Tags

String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'

tags_combinator

One of:

  • Any
  • All

Tags combination

Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

Custom POST methods

acceptInvitationToBeMemberOf

Accept an invitation to become a member of the given team.

There must be a TeamMembership for this person and the given team with the INVITED status. The status of this TeamMembership will be changed to APPROVED.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: acceptInvitationToBeMemberOf

comment

(required)

team

(required)

Link to a person.

Team

addMember

Add the given person as a member of this team.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: addMember

comment

person

(required)

Link to a person.

Member

status

One of:

  • Proposed
  • Approved
  • Administrator
  • Deactivated
  • Expired
  • Declined
  • Invited
  • Invitation declined

The state of this membership

Response (application/json)

A tuple containing a boolean indicating when the membership status changed and the current TeamMembershipStatus. This depends on the desired status passed as an argument, the membership policy and the user's privileges.

createPPA

Create a PPA.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: createPPA

description

displayname

name

private

suppress_subscription_notifications

On success, the response status will be 201 and the Location header will contain the link to the newly created archive.

createRecipe

Create a SourcePackageRecipe owned by this person.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: createRecipe

build_daily

daily_build_archive

Link to a archive.

description

(required)

distroseries

(required)

name

(required)

recipe_text

(required)

On success, the response status will be 201 and the Location header will contain the link to the newly created source_package_recipe.

declineInvitationToBeMemberOf

Decline an invitation to become a member of the given team.

There must be a TeamMembership for this person and the given team with the INVITED status. The status of this TeamMembership will be changed to INVITATION_DECLINED.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: declineInvitationToBeMemberOf

comment

(required)

team

(required)

Link to a person.

Team

getArchiveSubscriptionURL

Get a text line that is suitable to be used for a sources.list entry.

It will create a new IArchiveAuthToken if one doesn't already exist.

It raises Unauthorized if the context user does not have a valid subscription for the target archive or the caller is not context user itself.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: getArchiveSubscriptionURL

archive

(required)

Link to a archive.
join

Join the given team if its membership_policy is not RESTRICTED.

Join the given team according to the policies and defaults of that team:

  • If the team membership_policy is OPEN, the user is added as an APPROVED member with a NULL TeamMembership.reviewer.
  • If the team membership_policy is MODERATED, the user is added as a PROPOSED member and one of the team's administrators have to approve the membership.

If may_subscribe_to_list is True, then also attempt to subscribe to the team's mailing list, depending on the list status and the person's auto-subscribe settings.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: join

team

(required)

Link to a person.

Team

leave

Leave the given team.

This is a convenience method for retractTeamMembership() that allows a user to leave the given team, or to cancel a PENDING membership request.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: leave

team

(required)

Link to a person.

Team

retractTeamMembership

Retract this team's membership in the given team.

If there's a membership entry for this team on the given team and its status is either APPROVED, ADMIN, PENDING, or INVITED, the status is changed and the relevant entries in TeamParticipation.

APPROVED and ADMIN status are changed to DEACTIVATED. PENDING status is changed to DECLINED. INVITED status is changes to INVITATION_DECLINED.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: retractTeamMembership

comment

team

(required)

Link to a person.

Team

setLocation

Specify the location and time zone of a person.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: setLocation

latitude

(required)

The latitude of this object.

longitude

(required)

The longitude of this object.

time_zone

(required)

The time zone of this object.

(back to Table of Contents)

pillar

An object that might be a project, a project group, or a distribution.

This is a polymorphic object served by the pillar set. Check the individual object to see what type it is.

https://api.launchpad.net/1.0/<name>

Default representation (application/json)

Key Value Description

active

(writeable)

Active

Whether or not this item is active.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

pillars

An object for searching across projects, project groups, and distros.

Projects, project groups, and distributions are collectively known as "pillars". This object lets you do a combined search across all types of pillars. It also gives you access to pillars that have been flagged by administrators as "featured" pillars.

https://api.launchpad.net/1.0/pillars

Default representation (application/json)

Key Value Description

featured_pillars_collection_link

(read-only)

Link to a pillar collection.

Projects, project groups, and distributions that are featured on the site.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

Return Projects/Project groups/Distros matching :text:.

If :limit: is None, the default batch size will be used.

The results are ordered descending by rank.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: search

limit

Maximum number of items to return. This is a hard limit: any pagination you request will happen within this limit.

text

(required)

Search text

Response contains an application/json representation of a pillar collection .

(back to Table of Contents)

preview_diff

A diff generated to show actual diff between two branches.

This diff will be used primarily for branch merge proposals where we are trying to determine the effective changes of landing the source branch on the target branch.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

added_lines_count

(read-only)

The number of lines added in this diff.

branch_merge_proposal_link

(read-only)

Link to a branch_merge_proposal.

The branch merge proposal that diff relates to.

conflicts

(read-only)

The conflicts text describing any path or text conflicts.

date_created

(read-only)

Date Created

When this diff was created.

diff_lines_count

(read-only)

The number of lines in this diff.

diff_text_link

(read-only)

Link to a file resource.

Content of this diff

diffstat

(read-only)

Statistics about this diff

http_etag

(read-only)

The value of the HTTP ETag for this resource.

id

(read-only)

DB ID

The tracking number for this diff.

prerequisite_revision_id

(read-only)

The tip revision id of the prerequisite branch used to generate the diff.

removed_lines_count

(read-only)

The number of lines removed in this diff.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

source_revision_id

(read-only)

The tip revision id of the source branch used to generate the diff.

stale

(read-only)

If the preview diff is stale, it is out of date when compared to the tip revisions of the source, target, and possibly prerequisite branches.

target_revision_id

(read-only)

The tip revision id of the target branch used to generate the diff.

title

(read-only)

Title

PreviewDiff title.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

processor

The SQLObject Processor Interface

https://api.launchpad.net/1.0/+processors/<processor.name>

Default representation (application/json)

Key Value Description

http_etag

(read-only)

The value of the HTTP ETag for this resource.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

project

A Product.

The Launchpad Registry describes the open source world as ProjectGroups and Products. Each ProjectGroup may be responsible for several Products. For example, the Mozilla Project has Firefox, Thunderbird and The Mozilla App Suite as Products, among others.

https://api.launchpad.net/1.0/<name>

Default representation (application/json)

Key Value Description

active

(writeable)

Active

Whether or not this item is active.

active_milestones_collection_link

(read-only)

Link to a milestone collection.

The visible and active milestones associated with this object, ordered by date expected.

all_milestones_collection_link

(read-only)

Link to a milestone collection.

All milestones associated with this object, ordered by date expected.

brand_link

(writeable)

Link to a file resource.

Brand

A large image of exactly 192x192 pixels, that will be displayed on this project's home page in Launchpad. It should be no bigger than 100kb in size.

bug_reported_acknowledgement

(writeable)

After reporting a bug, I can expect the following.

This message of acknowledgement will be displayed to anyone after reporting a bug.

bug_reporting_guidelines

(writeable)

Helpful guidelines for reporting a bug

These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.

bug_supervisor_link

(writeable)

Link to a person.

Bug Supervisor

The Launchpad id of the person or team (preferred) responsible for bug management.

bug_tracker_link

(writeable)

Link to a bug_tracker.

Bugs are tracked

commercial_subscription_is_due

(read-only)

Commercial subscription is due

Whether the project's licensing requires a new commercial subscription to use launchpad.

commercial_subscription_link

(writeable)

Link to a commercial_subscription.

Commercial subscriptions

An object which contains the timeframe and the voucher code of a subscription.

date_created

(read-only)

Date Created

The date this project was created in Launchpad.

date_next_suggest_packaging

(writeable)

Next suggest packaging date

Obsolete. The date to resume Ubuntu package suggestions.

description

(writeable)

Description

Details about the project's work, highlights, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.

development_focus_link

(writeable)

Link to a project_series.

Development focus

The series that represents the master or trunk branch. The Bazaar URL lp:<project> points to the development focus series branch.

display_name

(writeable)

Display Name

The name of the project as it would appear in a
paragraph.

download_url

(writeable)

Download URL

The full URL where downloads for this project
are located, if available. Please include the http://

driver_link

(writeable)

Link to a person.

Driver

This person or team will be able to set feature goals for and approve bug targeting or backporting for ANY major series in this project. You might want to leave this blank and just appoint a team for each specific series, rather than having one project team that does it all.

freshmeat_project

(writeable)

Freshmeat Project

The Freshmeat project name for
this project, if it is in freshmeat.

homepage_url

(writeable)

Homepage URL

The project home page. Please include
the http://

http_etag

(read-only)

The value of the HTTP ETag for this resource.

icon_link

(writeable)

Link to a file resource.

Icon

A small image of exactly 14x14 pixels and at most 5kb in size, that can be used to identify this project. The icon will be displayed next to the project name everywhere in Launchpad that we refer to the project and link to it.

information_type

(writeable)

One of:

  • Public
  • Public Security
  • Private Security
  • Private
  • Proprietary
  • Embargoed

Information Type

The type of data contained in this item.

is_permitted

(read-only)

Is Permitted

Whether the project's licensing qualifies for free hosting or the project has an up-to-date subscription.

license_approved

(writeable)

Licence approved

The project is legitimate and its licence appears valid. Not applicable to 'Other/Proprietary'.

license_info

(writeable)

Description of additional licences

Description of licences that do not appear in the list above.

licenses

(writeable)

Licences

logo_link

(writeable)

Link to a file resource.

Logo

An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to this project. It should be no bigger than 50kb in size.

name

(writeable)

Name

At least one lowercase letter or number, followed by letters, numbers, dots, hyphens or pluses. Keep this name short; it is used in URLs as shown above.

official_bug_tags

(writeable)

Official Bug Tags

The list of bug tags defined as official.

owner_link

(writeable)

Link to a person.

Maintainer

The restricted team, moderated team, or person who maintains the project information in Launchpad.

private

(read-only)

Product is confidential

This product is visible only to those with access grants.

private_bugs

(read-only)

Private bugs (obsolete; always False)

Replaced by bug_sharing_policy.

programming_language

(writeable)

Programming Languages

A comma delimited list of programming
languages used for this project.

project_group_link

(writeable)

Link to a project_group.

Part of

Project group. This is an overarching initiative that includes several related projects. For example, the Mozilla Project produces Firefox, Thunderbird and Gecko. This information is used to group those projects in a coherent way. If you make this project part of a group, the group preferences and decisions around bug tracking, translation and security policy will apply to this project.

project_reviewed

(writeable)

Project reviewed

Whether or not this project has been reviewed. If you looked at the project and how it uses Launchpad, you reviewed it.

qualifies_for_free_hosting

(read-only)

Qualifies for free hosting

Whether the project's licensing qualifies it for free use of launchpad.

recipes_collection_link

(read-only)

Link to a source_package_recipe collection.

All recipes associated with the object.

registrant_link

(read-only)

Link to a person.

Registrant

This person registered the project in Launchpad.

releases_collection_link

(read-only)

Link to a project_release collection.

An iterator over the ProductReleases for this product.

remote_product

(writeable)

Remote bug tracker project id

Some bug trackers host multiple projects at the same URL and require an identifier for the specific project.

resource_type_link

(read-only)

The link to the WADL description of this resource.

reviewer_whiteboard

(writeable)

Notes for the project reviewer

Notes on the project's licence, editable only by reviewers (Admins and Commercial Admins).

screenshots_url

(writeable)

Screenshots URL

The full URL for screenshots of this project,
if available. Please include the http://

security_contact

(read-only)

Security contact

Security contact (obsolete; always None)

self_link

(read-only)

The canonical link to this resource.

series_collection_link

(read-only)

Link to a project_series collection.

sourceforge_project

(writeable)

Sourceforge Project

The SourceForge project name for
this project, if it is in sourceforge.

summary

(writeable)

Summary

A short paragraph to introduce the project's work.

title

(writeable)

Title

The project title. Should be just a few words.

translation_focus_link

(writeable)

Link to a project_series.

Translation focus

Project series that translators should focus on.

web_link

(read-only)

The canonical human-addressable web link to this resource.

wiki_url

(writeable)

Wiki URL

The full URL of this project's wiki, if it has
one. Please include the http://

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getBranches

Returns all branches with the given lifecycle status.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getBranches

modified_since

Limit the branches to those modified since this date.

status

A list of branch lifecycle statuses to filter by.

Response contains an application/json representation of a branch collection .

getMergeProposals

Returns all merge proposals of a given status.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getMergeProposals

status

A list of merge proposal statuses to filter by.

Response contains an application/json representation of a branch_merge_proposal collection .

getMilestone

Return a milestone with the given name for this object, or None.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getMilestone

name

(required)

Name

Response contains an application/json representation of a milestone.

getRelease

Return the release for this product that has the version given.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getRelease

version

(required)

Version

Response contains an application/json representation of a project_release.

getSeries

Return the series for this product for the given name, or None.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSeries

name

(required)

Name

Response contains an application/json representation of a project_series.

getSubscription

Return the subscription for person, if it exists.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

Response contains an application/json representation of a structural_subscription.

getSubscriptions

Return all the subscriptions with the specified levels.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubscriptions

Response contains an application/json representation of a structural_subscription collection .

getTranslationImportQueueEntries

Return entries in the translation import queue for this entity.

If one of both of 'import_status' or 'file_extension' are given, the returned entries are filtered based on those values.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getTranslationImportQueueEntries

file_extension

Filename extension

Show only entries with this filename suffix

import_status

One of:

  • Approved
  • Imported
  • Deleted
  • Failed
  • Needs Review
  • Blocked
  • Needs Information

Status

Show only entries with this status

Response contains an application/json representation of a translation_import_queue_entry collection .

get_timeline

Return basic timeline data useful for creating a diagram.

The number of milestones returned per series is limited.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: get_timeline

include_inactive

Include inactive

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: searchTasks

affected_user

Link to a person.

assignee

Link to a person.

bug_commenter

Link to a person.

bug_reporter

Link to a person.

bug_subscriber

Link to a person.

bug_supervisor

Link to a person.

component

Component

Distribution package archive grouping. E.g. main, universe, multiverse

created_before

Search for bugs that were created before the given date.

created_since

Search for bugs that have been created since the given date.

hardware_bus

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The bus of a hardware device related to a bug

hardware_driver_name

The driver controlling a hardware device related to a bug.

hardware_driver_package_name

The package of the driver which controls a hardware device related to a bug.

hardware_is_linked_to_bug

Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.

hardware_owner_is_affected_by_bug

Search for bugs where people affected by a bug own the given device or use the given hardware driver.

hardware_owner_is_bug_reporter

Search for bugs reported by people who own the given device or who use the given hardware driver.

hardware_owner_is_subscribed_to_bug

Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.

hardware_product_id

The product ID of a hardware device related to a bug.

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

hardware_vendor_id

The vendor ID of a hardware device related to a bug.

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

has_cve

Show only bugs associated with a CVE

has_no_package

Exclude bugs with packages specified

has_patch

Show only bugs with patches available.

importance

Importance

Show only bugs with the given importance or list of importances.

information_type

Information Type

Show only bugs with the given information type or list of information types.

linked_branches

One of:

  • Show all bugs
  • Show only Bugs with linked Branches
  • Show only Bugs without linked Branches

Search for bugs that are linked to branches or for bugs that are not linked to branches.

milestone

Milestone

Show only bug tasks targeted to this milestone.

modified_since

Search for bugs that have been modified since the given date.

nominated_for

Link to a distro_series.

omit_duplicates

Omit bugs marked as duplicate,

omit_targeted

Omit bugs targeted to a series

order_by

List of fields by which the results are ordered.

owner

Link to a person.

search_text

Bug ID or search text.

status

Status

Show only bugs with the given status value or list of values.

status_upstream

Status upstream

Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.

structural_subscriber

Link to a person.

tags

Tags

String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'

tags_combinator

One of:

  • Any
  • All

Tags combination

Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

userHasBugSubscriptions

Is user subscribed, directly or via a team, to bug mail?

Parameters
Parameter Value Description

ws.op

(required)

Fixed: userHasBugSubscriptions

Custom POST methods

addBugSubscription

Add a bug subscription for this structure.

This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addBugSubscription

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created structural_subscription.

addBugSubscriptionFilter

Add a bug subscription filter for this structure.

This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addBugSubscriptionFilter

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created bug_subscription_filter.

addOfficialBugTag

Add tag to the official bug tags of this target.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: addOfficialBugTag

tag

(required)

The official bug tag

newCodeImport

Create a new code import.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: newCodeImport

branch_name

Name of branch to create

cvs_module

CVS module to import

cvs_root

CVS root URL

owner

Link to a person.

Owner of the resulting branch

rcs_type

One of:

  • Concurrent Versions System
  • Subversion via CSCVS
  • Subversion via bzr-svn
  • Git
  • Mercurial
  • Bazaar

url

Foreign VCS URL

On success, the response status will be 201 and the Location header will contain the link to the newly created code_import.

newSeries

Creates a new IProductSeries for this IProduct.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: newSeries

branch

Link to a branch.

Branch

The Bazaar branch for this series. Leave blank if this series is not maintained in Bazaar.

name

(required)

Name

The name of the series is a short, unique name that identifies it, being used in URLs. It must be all lowercase, with no special characters. For example, '2.0' or 'trunk'.

release_url_pattern

Release URL pattern

A URL pattern that matches releases that are part of this series. Launchpad automatically scans this site to import new releases. Example: http://ftp.gnu.org/gnu/emacs/emacs-21.*.tar.gz

summary

(required)

Summary

A single paragraph that explains the goals of of this series and the intended users. For example: "The 2.0 series of Apache represents the current stable series, and is recommended for all new deployments".

On success, the response status will be 201 and the Location header will contain the link to the newly created project_series.

removeBugSubscription

Remove a subscription to bugs from this structure.

This will delete all associated filters.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: removeBugSubscription

subscriber

Link to a person.

Person to unsubscribe. If omitted, the requesting user will be unsubscribed.

removeOfficialBugTag

Remove tag from the official bug tags of this target.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: removeOfficialBugTag

tag

(required)

The official bug tag

(back to Table of Contents)

project_group

A ProjectGroup.

https://api.launchpad.net/1.0/<name>

Default representation (application/json)

Key Value Description

active

(writeable)

Active

Whether or not this item is active.

active_milestones_collection_link

(read-only)

Link to a project_group_milestone collection.

The visible and active milestones associated with this object, ordered by date expected.

all_milestones_collection_link

(read-only)

Link to a project_group_milestone collection.

All milestones associated with this object, ordered by date expected.

bug_reported_acknowledgement

(writeable)

After reporting a bug, I can expect the following.

This message of acknowledgement will be displayed to anyone after reporting a bug.

bug_reporting_guidelines

(writeable)

If I’m reporting a bug, I should include, if possible

These guidelines will be shown to anyone reporting a bug.

bug_tracker_link

(writeable)

Link to a bug_tracker.

Bug Tracker

The bug tracker the projects in this project group use.

date_created

(read-only)

Date Created

The date this project group was created in Launchpad.

description

(writeable)

Description

Details about the project group's work, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.

display_name

(writeable)

Display Name

Appropriately capitalised, and typically ending in "Project". Examples: the Apache Project, the Mozilla Project, the Gimp Project.

driver_link

(writeable)

Link to a person.

Driver

This is a project group-wide appointment. Think carefully here! This person or team will be able to set feature goals and approve bug targeting and backporting for ANY series in ANY project in this group. You can also appoint drivers at the level of a specific project or series. So you may just want to leave this space blank, and instead let the individual projects and series have drivers.

freshmeat_project

(writeable)

Freshmeat Project Name

The Freshmeat project name for this project group, if it is in Freshmeat.

homepage_content

(writeable)

Homepage Content

The content of this project group's home page. Edit this and it will be displayed for all the world to see. It is NOT a wiki so you cannot undo changes.

homepage_url

(writeable)

Homepage URL

The project group home page. Please include the http://

http_etag

(read-only)

The value of the HTTP ETag for this resource.

icon_link

(writeable)

Link to a file resource.

Icon

A small image of exactly 14x14 pixels and at most 5kb in size, that can be used to identify this project group. The icon will be displayed in Launchpad everywhere that we link to this project group. For example in listings or tables of active project groups.

logo_link

(writeable)

Link to a file resource.

Logo

An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to this project group. It should be no bigger than 50kb in size.

mugshot_link

(writeable)

Link to a file resource.

Brand

A large image of exactly 192x192 pixels, that will be displayed on this project group's home page in Launchpad. It should be no bigger than 100kb in size.

name

(writeable)

Name

A unique name, used in URLs, identifying the project group. All lowercase, no special characters. Examples: apache, mozilla, gimp.

official_bug_tags

(read-only)

Official Bug Tags

The list of bug tags defined as official.

owner_link

(writeable)

Link to a person.

Maintainer

The restricted team, moderated team, or person who maintains the project group information in Launchpad.

projects_collection_link

(read-only)

Link to a project collection.

List of active projects for this project group.

registrant_link

(read-only)

Link to a person.

Registrant

Project group registrant. Must be a valid Launchpad Person.

resource_type_link

(read-only)

The link to the WADL description of this resource.

reviewed

(writeable)

Reviewed

Whether or not this project group has been reviewed.

self_link

(read-only)

The canonical link to this resource.

sourceforge_project

(writeable)

SourceForge Project Name

The SourceForge project name for this project group, if it is in SourceForge.

summary

(writeable)

Project Group Summary

A short paragraph to introduce the project group's work.

title

(writeable)

Title

The full name of the project group, which can contain spaces, special characters, etc.

web_link

(read-only)

The canonical human-addressable web link to this resource.

wiki_url

(writeable)

Wiki URL

The URL of this project group's wiki, if it has one. Please include the http://

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getBranches

Returns all branches with the given lifecycle status.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getBranches

modified_since

Limit the branches to those modified since this date.

status

A list of branch lifecycle statuses to filter by.

Response contains an application/json representation of a branch collection .

getMergeProposals

Returns all merge proposals of a given status.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getMergeProposals

status

A list of merge proposal statuses to filter by.

Response contains an application/json representation of a branch_merge_proposal collection .

getMilestone

Return a milestone with the given name for this object, or None.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getMilestone

name

(required)

Name

Response contains an application/json representation of a milestone.

getSubscription

Return the subscription for person, if it exists.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

Response contains an application/json representation of a structural_subscription.

getSubscriptions

Return all the subscriptions with the specified levels.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubscriptions

Response contains an application/json representation of a structural_subscription collection .

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: searchTasks

affected_user

Link to a person.

assignee

Link to a person.

bug_commenter

Link to a person.

bug_reporter

Link to a person.

bug_subscriber

Link to a person.

bug_supervisor

Link to a person.

component

Component

Distribution package archive grouping. E.g. main, universe, multiverse

created_before

Search for bugs that were created before the given date.

created_since

Search for bugs that have been created since the given date.

hardware_bus

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The bus of a hardware device related to a bug

hardware_driver_name

The driver controlling a hardware device related to a bug.

hardware_driver_package_name

The package of the driver which controls a hardware device related to a bug.

hardware_is_linked_to_bug

Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.

hardware_owner_is_affected_by_bug

Search for bugs where people affected by a bug own the given device or use the given hardware driver.

hardware_owner_is_bug_reporter

Search for bugs reported by people who own the given device or who use the given hardware driver.

hardware_owner_is_subscribed_to_bug

Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.

hardware_product_id

The product ID of a hardware device related to a bug.

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

hardware_vendor_id

The vendor ID of a hardware device related to a bug.

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

has_cve

Show only bugs associated with a CVE

has_no_package

Exclude bugs with packages specified

has_patch

Show only bugs with patches available.

importance

Importance

Show only bugs with the given importance or list of importances.

information_type

Information Type

Show only bugs with the given information type or list of information types.

linked_branches

One of:

  • Show all bugs
  • Show only Bugs with linked Branches
  • Show only Bugs without linked Branches

Search for bugs that are linked to branches or for bugs that are not linked to branches.

milestone

Milestone

Show only bug tasks targeted to this milestone.

modified_since

Search for bugs that have been modified since the given date.

nominated_for

Link to a distro_series.

omit_duplicates

Omit bugs marked as duplicate,

omit_targeted

Omit bugs targeted to a series

order_by

List of fields by which the results are ordered.

owner

Link to a person.

search_text

Bug ID or search text.

status

Status

Show only bugs with the given status value or list of values.

status_upstream

Status upstream

Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.

structural_subscriber

Link to a person.

tags

Tags

String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'

tags_combinator

One of:

  • Any
  • All

Tags combination

Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

userHasBugSubscriptions

Is user subscribed, directly or via a team, to bug mail?

Parameters
Parameter Value Description

ws.op

(required)

Fixed: userHasBugSubscriptions

Custom POST methods

addBugSubscription

Add a bug subscription for this structure.

This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addBugSubscription

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created structural_subscription.

addBugSubscriptionFilter

Add a bug subscription filter for this structure.

This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addBugSubscriptionFilter

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created bug_subscription_filter.

removeBugSubscription

Remove a subscription to bugs from this structure.

This will delete all associated filters.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: removeBugSubscription

subscriber

Link to a person.

Person to unsubscribe. If omitted, the requesting user will be unsubscribed.

(back to Table of Contents)

project_group_milestone

A marker interface for milestones related to a project

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

code_name

(writeable)

Code name

An alternative name for the milestone.

date_targeted

(writeable)

Date Targeted

Example: 2005-11-24

http_etag

(read-only)

The value of the HTTP ETag for this resource.

is_active

(writeable)

Active

Whether or not this object should be shown in web forms for targeting.

name

(writeable)

Name

Only letters, numbers, and simple punctuation are allowed.

official_bug_tags

(read-only)

Official Bug Tags

The list of bug tags defined as official.

release_link

(read-only)

Link to a project_release.

The release for this milestone.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

series_target_link

(writeable)

Link to a has_milestones.

The productseries or distroseries of this milestone.

summary

(writeable)

Summary

A summary of the features and status of this milestone.

target_link

(writeable)

Link to a has_milestones.

The product, distribution, or project group for this milestone.

title

(read-only)

A context title for pages.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getSubscription

Return the subscription for person, if it exists.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

Response contains an application/json representation of a structural_subscription.

getSubscriptions

Return all the subscriptions with the specified levels.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubscriptions

Response contains an application/json representation of a structural_subscription collection .

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: searchTasks

affected_user

Link to a person.

assignee

Link to a person.

bug_commenter

Link to a person.

bug_reporter

Link to a person.

bug_subscriber

Link to a person.

bug_supervisor

Link to a person.

component

Component

Distribution package archive grouping. E.g. main, universe, multiverse

created_before

Search for bugs that were created before the given date.

created_since

Search for bugs that have been created since the given date.

hardware_bus

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The bus of a hardware device related to a bug

hardware_driver_name

The driver controlling a hardware device related to a bug.

hardware_driver_package_name

The package of the driver which controls a hardware device related to a bug.

hardware_is_linked_to_bug

Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.

hardware_owner_is_affected_by_bug

Search for bugs where people affected by a bug own the given device or use the given hardware driver.

hardware_owner_is_bug_reporter

Search for bugs reported by people who own the given device or who use the given hardware driver.

hardware_owner_is_subscribed_to_bug

Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.

hardware_product_id

The product ID of a hardware device related to a bug.

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

hardware_vendor_id

The vendor ID of a hardware device related to a bug.

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

has_cve

Show only bugs associated with a CVE

has_no_package

Exclude bugs with packages specified

has_patch

Show only bugs with patches available.

importance

Importance

Show only bugs with the given importance or list of importances.

information_type

Information Type

Show only bugs with the given information type or list of information types.

linked_branches

One of:

  • Show all bugs
  • Show only Bugs with linked Branches
  • Show only Bugs without linked Branches

Search for bugs that are linked to branches or for bugs that are not linked to branches.

milestone

Milestone

Show only bug tasks targeted to this milestone.

modified_since

Search for bugs that have been modified since the given date.

nominated_for

Link to a distro_series.

omit_duplicates

Omit bugs marked as duplicate,

omit_targeted

Omit bugs targeted to a series

order_by

List of fields by which the results are ordered.

owner

Link to a person.

search_text

Bug ID or search text.

status

Status

Show only bugs with the given status value or list of values.

status_upstream

Status upstream

Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.

structural_subscriber

Link to a person.

tags

Tags

String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'

tags_combinator

One of:

  • Any
  • All

Tags combination

Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

userHasBugSubscriptions

Is user subscribed, directly or via a team, to bug mail?

Parameters
Parameter Value Description

ws.op

(required)

Fixed: userHasBugSubscriptions

Custom POST methods

addBugSubscription

Add a bug subscription for this structure.

This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addBugSubscription

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created structural_subscription.

addBugSubscriptionFilter

Add a bug subscription filter for this structure.

This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addBugSubscriptionFilter

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created bug_subscription_filter.

createProductRelease

Create a new ProductRelease.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: createProductRelease

changelog

Changelog

A description of every change in the release.

date_released

(required)

Date released

The date this release was published. Before release, this should have an estimated release date.

release_notes

Release notes

A description of important new features (though the changelog below might repeat some of this information).

On success, the response status will be 201 and the Location header will contain the link to the newly created project_release.

removeBugSubscription

Remove a subscription to bugs from this structure.

This will delete all associated filters.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: removeBugSubscription

subscriber

Link to a person.

Person to unsubscribe. If omitted, the requesting user will be unsubscribed.

(back to Table of Contents)

project_release

A specific release (i.e. version) of a product.

For example: Mozilla 1.7.2 or Apache 2.0.48.

https://api.launchpad.net/1.0/<project.name>/<project_series.name>/<release.version>

Default representation (application/json)

Key Value Description

changelog

(writeable)

Changelog

A description of every change in the release.

date_created

(read-only)

Date Created

The date this project release was created in Launchpad.

date_released

(writeable)

Date released

The date this release was published. Before release, this should have an estimated release date.

display_name

(read-only)

Constructed display name for a project release.

files_collection_link

(read-only)

Link to a project_release_file collection.

Project release files

A list of files for this release.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

milestone_link

(writeable)

Link to a milestone.

Milestone for this release

A release requires a corresponding milestone that is not attached to another release.

owner_link

(writeable)

Link to a person.

The registrant of this release.

The person or who registered this release.

project_link

(read-only)

Link to a project.

The project that made this release.

release_notes

(writeable)

Release notes

A description of important new features (though the changelog below might repeat some of this information).

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

title

(read-only)

Constructed title for a project release.

version

(read-only)

Version

The specific version number assigned to this release. Letters and numbers are acceptable, for releases like "1.2rc3".

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

add_file

Add file to the library and link to this IProductRelease.

The signature file will also be added if available.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: add_file

content_type

(required)

description

Description

A detailed description of the file contents

file_content

(required)

Link to a file resource.

file_type

One of:

  • Code Release Tarball
  • README File
  • Release Notes
  • ChangeLog File
  • Installer file

Upstream file type

filename

(required)

signature_content

Link to a file resource.

signature_filename

On success, the response status will be 201 and the Location header will contain the link to the newly created project_release_file.

delete

Delete this release.

This method must not be used if this release has any release files associated with it.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: delete

(back to Table of Contents)

project_release_file

A file associated with a ProductRelease.

https://api.launchpad.net/1.0/<project.name>/<project_series.name>/<release.version>/+file/<hosted_file.filename>

Default representation (application/json)

Key Value Description

date_uploaded

(read-only)

Upload date

The date this file was uploaded

description

(writeable)

Description

A detailed description of the file contents

file_link

(read-only)

Link to a file resource.

File

The file contents.

file_type

(writeable)

One of:

  • Code Release Tarball
  • README File
  • Release Notes
  • ChangeLog File
  • Installer file

Upstream file type

http_etag

(read-only)

The value of the HTTP ETag for this resource.

project_release_link

(writeable)

Link to a project_release.

Project release

The parent product release.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

signature_link

(read-only)

Link to a file resource.

File signature

The file signature.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

delete

Delete the product release file.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: delete

(back to Table of Contents)

project_series

A series of releases. For example '2.0' or '1.3' or 'dev'.

https://api.launchpad.net/1.0/<project.name>/<name>

Default representation (application/json)

Key Value Description

active

(writeable)

Active

Whether or not this series is stable and supported, or under current development. This excludes series which are experimental or obsolete.

active_milestones_collection_link

(read-only)

Link to a milestone collection.

The visible milestones associated with this project series, ordered by date expected.

all_milestones_collection_link

(read-only)

Link to a milestone collection.

All milestones associated with this project series, ordered by date expected.

branch_link

(writeable)

Link to a branch.

Branch

The Bazaar branch for this series. Leave blank if this series is not maintained in Bazaar.

bug_reported_acknowledgement

(writeable)

After reporting a bug, I can expect the following.

This message of acknowledgement will be displayed to anyone after reporting a bug.

bug_reporting_guidelines

(writeable)

Helpful guidelines for reporting a bug

These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.

date_created

(read-only)

Date Registered

display_name

(writeable)

Display Name

Display name. In this case we have removed the underlying database field, and this attribute just returns the name.

driver_link

(writeable)

Link to a person.

Release manager

The person or team responsible for decisions about features and bugs that will be targeted to this series. If you don't nominate someone here, then the owner of this series will automatically have those permissions, as will the project and project group drivers.

drivers_collection_link

(read-only)

Link to a person collection.

A list of the people or teams who are drivers for this series. This list is made up of any drivers or owners from this series and the parent drivers.

http_etag

(read-only)

The value of the HTTP ETag for this resource.

name

(writeable)

Name

The name of the series is a short, unique name that identifies it, being used in URLs. It must be all lowercase, with no special characters. For example, '2.0' or 'trunk'.

official_bug_tags

(read-only)

Official Bug Tags

The list of bug tags defined as official.

owner_link

(writeable)

Link to a person.

Owner

Project owner, either a valid Person or Team

project_link

(writeable)

Link to a project.

Project

release_finder_url_pattern

(writeable)

Release URL pattern

A URL pattern that matches releases that are part of this series. Launchpad automatically scans this site to import new releases. Example: http://ftp.gnu.org/gnu/emacs/emacs-21.*.tar.gz

releases_collection_link

(read-only)

Link to a project_release collection.

An iterator over the releases in this Series, sorted with latest release first.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

status

(writeable)

One of:

  • Experimental
  • Active Development
  • Pre-release Freeze
  • Current Stable Release
  • Supported
  • Obsolete
  • Future

Status

summary

(writeable)

Summary

A single paragraph that explains the goals of of this series and the intended users. For example: "The 2.0 series of Apache represents the current stable series, and is recommended for all new deployments".

title

(writeable)

Title

The product series title. Should be just a few words.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getSubscription

Return the subscription for person, if it exists.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

Response contains an application/json representation of a structural_subscription.

getSubscriptions

Return all the subscriptions with the specified levels.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getSubscriptions

Response contains an application/json representation of a structural_subscription collection .

getTranslationImportQueueEntries

Return entries in the translation import queue for this entity.

If one of both of 'import_status' or 'file_extension' are given, the returned entries are filtered based on those values.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getTranslationImportQueueEntries

file_extension

Filename extension

Show only entries with this filename suffix

import_status

One of:

  • Approved
  • Imported
  • Deleted
  • Failed
  • Needs Review
  • Blocked
  • Needs Information

Status

Show only entries with this status

Response contains an application/json representation of a translation_import_queue_entry collection .

getTranslationTemplates

Return an iterator over all its translation templates.

The returned templates are either obsolete or current.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getTranslationTemplates

Response contains an application/json representation of a translation_template collection .

get_timeline

Return basic timeline data useful for creating a diagram.

The number of milestones returned is limited.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: get_timeline

include_inactive

Include inactive

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: searchTasks

affected_user

Link to a person.

assignee

Link to a person.

bug_commenter

Link to a person.

bug_reporter

Link to a person.

bug_subscriber

Link to a person.

bug_supervisor

Link to a person.

component

Component

Distribution package archive grouping. E.g. main, universe, multiverse

created_before

Search for bugs that were created before the given date.

created_since

Search for bugs that have been created since the given date.

hardware_bus

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The bus of a hardware device related to a bug

hardware_driver_name

The driver controlling a hardware device related to a bug.

hardware_driver_package_name

The package of the driver which controls a hardware device related to a bug.

hardware_is_linked_to_bug

Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.

hardware_owner_is_affected_by_bug

Search for bugs where people affected by a bug own the given device or use the given hardware driver.

hardware_owner_is_bug_reporter

Search for bugs reported by people who own the given device or who use the given hardware driver.

hardware_owner_is_subscribed_to_bug

Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.

hardware_product_id

The product ID of a hardware device related to a bug.

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

hardware_vendor_id

The vendor ID of a hardware device related to a bug.

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

has_cve

Show only bugs associated with a CVE

has_no_package

Exclude bugs with packages specified

has_patch

Show only bugs with patches available.

importance

Importance

Show only bugs with the given importance or list of importances.

information_type

Information Type

Show only bugs with the given information type or list of information types.

linked_branches

One of:

  • Show all bugs
  • Show only Bugs with linked Branches
  • Show only Bugs without linked Branches

Search for bugs that are linked to branches or for bugs that are not linked to branches.

milestone

Milestone

Show only bug tasks targeted to this milestone.

modified_since

Search for bugs that have been modified since the given date.

nominated_for

Link to a distro_series.

omit_duplicates

Omit bugs marked as duplicate,

omit_targeted

Omit bugs targeted to a series

order_by

List of fields by which the results are ordered.

owner

Link to a person.

search_text

Bug ID or search text.

status

Status

Show only bugs with the given status value or list of values.

status_upstream

Status upstream

Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.

structural_subscriber

Link to a person.

tags

Tags

String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'

tags_combinator

One of:

  • Any
  • All

Tags combination

Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

userHasBugSubscriptions

Is user subscribed, directly or via a team, to bug mail?

Parameters
Parameter Value Description

ws.op

(required)

Fixed: userHasBugSubscriptions

Custom POST methods

addBugSubscription

Add a bug subscription for this structure.

This method is used to create a new IStructuralSubscription for the target. This initially has a single filter which will allow all notifications will be sent.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addBugSubscription

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created structural_subscription.

addBugSubscriptionFilter

Add a bug subscription filter for this structure.

This method is used to create a new IBugSubscriptionFilter for the target. It will initially allow all notifications to be sent.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: addBugSubscriptionFilter

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created bug_subscription_filter.

newMilestone

Create a new milestone for this ProjectSeries.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: newMilestone

code_name

Code name

An alternative name for the milestone.

date_targeted

Date Targeted

Example: 2005-11-24

name

(required)

Name

Only letters, numbers, and simple punctuation are allowed.

summary

Summary

A summary of the features and status of this milestone.

On success, the response status will be 201 and the Location header will contain the link to the newly created milestone.

removeBugSubscription

Remove a subscription to bugs from this structure.

This will delete all associated filters.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: removeBugSubscription

subscriber

Link to a person.

Person to unsubscribe. If omitted, the requesting user will be unsubscribed.

(back to Table of Contents)

question

A single question, often a support request.

https://api.launchpad.net/1.0/<target.name>/+question/<question.id>

Default representation (application/json)

Key Value Description

http_etag

(read-only)

The value of the HTTP ETag for this resource.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

service_factory

Interface representing a factory used to access named services.

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

http_etag

(read-only)

The value of the HTTP ETag for this resource.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

sharing_service

https://api.launchpad.net/1.0

Default representation (application/json)

Key Value Description

http_etag

(read-only)

The value of the HTTP ETag for this resource.

name

(writeable)

Name

The name of the service, used to generate the url.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.
(back to Table of Contents)

source_package

A source package associated to a particular distribution series.

https://api.launchpad.net/1.0/<distribution.name>/<distro_series.name>/+source/<name>

Default representation (application/json)

Key Value Description

bug_reported_acknowledgement

(writeable)

After reporting a bug, I can expect the following.

This message of acknowledgement will be displayed to anyone after reporting a bug.

bug_reporting_guidelines

(writeable)

Helpful guidelines for reporting a bug

These guidelines will be shown to everyone reporting a bug and should be text or a bulleted list with your particular requirements, if any.

displayname

(read-only)

Display name

A displayname, constructed, for this package

distribution_link

(read-only)

Link to a distribution.

Distribution

The distribution for this source package.

distroseries_link

(read-only)

Link to a distro_series.

Distribution Series

The DistroSeries for this SourcePackage

http_etag

(read-only)

The value of the HTTP ETag for this resource.

latest_published_component_name

(read-only)

The name of the component in which the package was last published.

name

(read-only)

Name

The text name of this source package.

official_bug_tags

(read-only)

Official Bug Tags

The list of bug tags defined as official.

productseries_link

(read-only)

Link to a project_series.

Project series

The registered project series that this source package is based on. This series may be the same as the one that earlier versions of this source packages were based on.

resource_type_link

(read-only)

The link to the WADL description of this resource.

self_link

(read-only)

The canonical link to this resource.

web_link

(read-only)

The canonical human-addressable web link to this resource.

Standard methods

GET
Response contains the default application/json representation for this entry.
PATCH
Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT
Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getBranch

Get the official branch for this package in the given pocket.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getBranch

pocket

(required)

One of:

  • Release
  • Security
  • Updates
  • Proposed
  • Backports

Pocket

Response contains an application/json representation of a branch.

getBranches

Returns all branches with the given lifecycle status.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getBranches

modified_since

Limit the branches to those modified since this date.

status

A list of branch lifecycle statuses to filter by.

Response contains an application/json representation of a branch collection .

getMergeProposals

Returns all merge proposals of a given status.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getMergeProposals

status

A list of merge proposal statuses to filter by.

Response contains an application/json representation of a branch_merge_proposal collection .

getTranslationImportQueueEntries

Return entries in the translation import queue for this entity.

If one of both of 'import_status' or 'file_extension' are given, the returned entries are filtered based on those values.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getTranslationImportQueueEntries

file_extension

Filename extension

Show only entries with this filename suffix

import_status

One of:

  • Approved
  • Imported
  • Deleted
  • Failed
  • Needs Review
  • Blocked
  • Needs Information

Status

Show only entries with this status

Response contains an application/json representation of a translation_import_queue_entry collection .

getTranslationTemplates

Return an iterator over all its translation templates.

The returned templates are either obsolete or current.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: getTranslationTemplates

Response contains an application/json representation of a translation_template collection .

linkedBranches

Get the official branches for this package.

This operation returns a {Pocket-name : IBranch} dict.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: linkedBranches

Response (application/json)

A {Pocket-name : IBranch} dict.

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: searchTasks

affected_user

Link to a person.

assignee

Link to a person.

bug_commenter

Link to a person.

bug_reporter

Link to a person.

bug_subscriber

Link to a person.

bug_supervisor

Link to a person.

component

Component

Distribution package archive grouping. E.g. main, universe, multiverse

created_before

Search for bugs that were created before the given date.

created_since

Search for bugs that have been created since the given date.

hardware_bus

One of:

  • System
  • PCI
  • USB
  • IEEE1394
  • SCSI
  • Parallel Port
  • Serial port
  • IDE
  • ATA
  • Floppy
  • IPI
  • SATA
  • SAS
  • PC Card (32 bit)
  • PCMCIA (16 bit)

The bus of a hardware device related to a bug

hardware_driver_name

The driver controlling a hardware device related to a bug.

hardware_driver_package_name

The package of the driver which controls a hardware device related to a bug.

hardware_is_linked_to_bug

Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.

hardware_owner_is_affected_by_bug

Search for bugs where people affected by a bug own the given device or use the given hardware driver.

hardware_owner_is_bug_reporter

Search for bugs reported by people who own the given device or who use the given hardware driver.

hardware_owner_is_subscribed_to_bug

Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.

hardware_product_id

The product ID of a hardware device related to a bug.

Allowed values of the product ID depend on the bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

hardware_vendor_id

The vendor ID of a hardware device related to a bug.

Allowed values of the vendor ID depend on the bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.

has_cve

Show only bugs associated with a CVE

has_no_package

Exclude bugs with packages specified

has_patch

Show only bugs with patches available.

importance

Importance

Show only bugs with the given importance or list of importances.

information_type

Information Type

Show only bugs with the given information type or list of information types.

linked_branches

One of:

  • Show all bugs
  • Show only Bugs with linked Branches
  • Show only Bugs without linked Branches

Search for bugs that are linked to branches or for bugs that are not linked to branches.

milestone

Milestone

Show only bug tasks targeted to this milestone.

modified_since

Search for bugs that have been modified since the given date.

nominated_for

Link to a distro_series.

omit_duplicates

Omit bugs marked as duplicate,

omit_targeted

Omit bugs targeted to a series

order_by

List of fields by which the results are ordered.

owner

Link to a person.

search_text

Bug ID or search text.

status

Status

Show only bugs with the given status value or list of values.

status_upstream

Status upstream

Indicates the status of any remote watches associated with the bug. Possible values include: pending_bugwatch, hide_upstream, resolved_upstream, and open_upstream.

structural_subscriber

Link to a person.

tags

Tags

String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'

tags_combinator

One of:

  • Any
  • All

Tags combination

Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

Custom POST methods

newCodeImport

Create a new code import.

Parameters
ParameterValueDescription

ws.op

(required)

Fixed: newCodeImport

branch_name

Name of branch to create

cvs_module

CVS module to import

cvs_root

CVS root URL

owner

Link to a person.

Owner of the resulting branch

rcs_type

One of:

  • Concurrent Versions System
  • Subversion via CSCVS
  • Subversion via bzr-svn
  • Git
  • Mercurial
  • Bazaar

url

Foreign VCS URL

On success, the response status will be 201 and the Location header will contain the link to the newly created code_import.

setBranch

Set the official branch for the given pocket of this package.

Parameters
Parameter Value Description

ws.op

(required)

Fixed: setBranch

branch

Link to a branch.

Branch

pocket

(required)

One of:

  • Release
  • Security
  • Updates
  • Proposed
  • Backports

Pocket

Response (application/json)

None

(back to Table of Contents)

source_package_publishing_history

A source package publishing history record.

https://api.launchpad.net/1.0/<distribution>/+archive/<name>/+sourcepub/<id>

Default representation (application/json)

Key Value Description

archive_link

(read-only)

Link to a archive.

Archive ID

component_name

(read-only)

Component Name

creator_link

(read-only)

Link to a person.

Publication Creator

The IPerson who created this publication.

date_created

(writeable)

The date on which this record was created

date_made_pending

(writeable)

The date on which this record was set as pending removal

date_published

(writeable)

The date on which this record was published

date_removed

(writeable)

The date on which this record was removed from the published set

date_superseded

(writeable)

The date on which this record was marked superseded

display_name

(writeable)

Display Name

Text representation of the current record.

distro_series_link

(writeable)

Link to a distro_series.

The distro series being published into

http_etag

(read-only)

The value of the HTTP ETag for this resource.

package_creator_link

(read-only)

Link to a person.

Package Creator

The IPerson who created the source package.

package_maintainer_link

(read-only)

Link to a person.

Package Maintainer

The IPerson who maintains the source package.

package_signer_link

(read-only)

Link to a person.

Package Signer

The IPerson who signed the source package.

packageupload_link

(read-only)

Link to a package_upload.

Package upload

The Package Upload that caused the creation of this publication.

pocket

(read-only)

One of:

  • Release
  • Security
  • Updates
  • Proposed
  • Backports

Pocket

The pocket into which this entry is published

removal_comment

(writeable)

Reason why this publication is going to be removed.

removed_by_link

(writeable)

Link to a person.

The IPerson responsible for the removal

resource_type_link

(read-only)

The link to the WADL description of this resource.

scheduled_deletion_date

(writeable)

The date on which this record is scheduled for deletion

section_name

(read-only)

Section Name

self_link

(read-only)

The canonical link to this resource.

source_package_name

(read-only)

Source Package Name

source_package_version

(read-only)

Source Package Version

sponsor_link

(read-only)

Link to a person.

Publication sponsor

The IPerson who sponsored the creation of this publication.

status

(writeable)

One of:

  • Pending
  • Published
  • Superseded
  • Deleted
  • Obsolete

Pac