Debian project distributions API

DETAILS: Tier: Free, Premium, Ultimate Offering: Self-managed

Introduced in GitLab 13.5.

Deployed behind a feature flag, disabled by default.

This is the reference documentation for the Debian project distributions API. This API is behind a feature flag that is disabled by default. To use this API, you must enable the Debian API.

WARNING: This API is under development and is not meant for production use.

For more information about working with Debian packages, see the Debian package registry documentation.

Enable the Debian API

The Debian API is behind a feature flag that is disabled by default. GitLab administrators with access to the GitLab Rails console can opt to enable it. To enable it, follow the instructions in Enable the Debian API.

Authenticate to the Debian distributions APIs

See Authenticate to the Debian distributions APIs.

List all Debian distributions in a project

Lists Debian distributions in the given project.

GET /projects/:id/debian_distributions

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the project.
`codename`	string	no	Filter with a specific `codename`.
`suite`	string	no	Filter with a specific `suite`.

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/debian_distributions"

Example response:

[
  {
    "id": 1,
    "codename": "sid",
    "suite": null,
    "origin": null,
    "label": null,
    "version": null,
    "description": null,
    "valid_time_duration_seconds": null,
    "components": [
      "main"
    ],
    "architectures": [
      "all",
      "amd64"
    ]
  }
]

Single Debian project distribution

Gets a single Debian project distribution.

GET /projects/:id/debian_distributions/:codename

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the project owned by the authenticated user.
`codename`	string	yes	The `codename` of a distribution.

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/debian_distributions/unstable"

Example response:

{
  "id": 1,
  "codename": "sid",
  "suite": null,
  "origin": null,
  "label": null,
  "version": null,
  "description": null,
  "valid_time_duration_seconds": null,
  "components": [
    "main"
  ],
  "architectures": [
    "all",
    "amd64"
  ]
}

Single Debian project distribution key

Gets a single Debian project distribution key.

GET /projects/:id/debian_distributions/:codename/key.asc

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the project owned by the authenticated user.
`codename`	string	yes	The `codename` of a distribution.

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/debian_distributions/unstable/key.asc"

Example response:

Create a Debian project distribution

Creates a Debian project distribution.

POST /projects/:id/debian_distributions

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the project owned by the authenticated user.
`codename`	string	yes	The Debian distribution's codename.
`suite`	string	no	The new Debian distribution's suite.
`origin`	string	no	The new Debian distribution's origin.
`label`	string	no	The new Debian distribution's label.
`version`	string	no	The new Debian distribution's version.
`description`	string	no	The new Debian distribution's description.
`valid_time_duration_seconds`	integer	no	The new Debian distribution's valid time duration (in seconds).
`components`	string array	no	The new Debian distribution's list of components.
`architectures`	string array	no	The new Debian distribution's list of architectures.

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/debian_distributions?codename=sid"

Example response:

{
  "id": 1,
  "codename": "sid",
  "suite": null,
  "origin": null,
  "label": null,
  "version": null,
  "description": null,
  "valid_time_duration_seconds": null,
  "components": [
    "main"
  ],
  "architectures": [
    "all",
    "amd64"
  ]
}

Update a Debian project distribution

Updates a Debian project distribution.

PUT /projects/:id/debian_distributions/:codename

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the project owned by the authenticated user.
`codename`	string	yes	The Debian distribution's codename.
`suite`	string	no	The Debian distribution's new suite.
`origin`	string	no	The Debian distribution's new origin.
`label`	string	no	The Debian distribution's new label.
`version`	string	no	The Debian distribution's new version.
`description`	string	no	The Debian distribution's new description.
`valid_time_duration_seconds`	integer	no	The Debian distribution's new valid time duration (in seconds).
`components`	string array	no	The Debian distribution's new list of components.
`architectures`	string array	no	The Debian distribution's new list of architectures.

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/debian_distributions/unstable?suite=new-suite&valid_time_duration_seconds=604800"

Example response:

{
  "id": 1,
  "codename": "sid",
  "suite": "new-suite",
  "origin": null,
  "label": null,
  "version": null,
  "description": null,
  "valid_time_duration_seconds": 604800,
  "components": [
    "main"
  ],
  "architectures": [
    "all",
    "amd64"
  ]
}

Delete a Debian project distribution

Deletes a Debian project distribution.

DELETE /projects/:id/debian_distributions/:codename

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the project owned by the authenticated user.
`codename`	string	yes	The Debian distribution's codename.

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/debian_distributions/unstable"