kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/api/packages/debian_project_distributions.md

9.1 KiB
Raw Blame History

stage group info
Package Package To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments

Debian project distributions API (FREE SELF)

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.

NOTE: The Debian registry is not FIPS compliant and is disabled when FIPS mode is enabled. These endpoints will all return 404 Not Found.

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.

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": "unstable",
    "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 integer 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": "unstable",
  "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 integer 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:

-----BEGIN PGP PUBLIC KEY BLOCK-----
Comment: Alice's OpenPGP certificate
Comment: https://www.ietf.org/id/draft-bre-openpgp-samples-01.html

mDMEXEcE6RYJKwYBBAHaRw8BAQdArjWwk3FAqyiFbFBKT4TzXcVBqPTB3gmzlC/U
b7O1u120JkFsaWNlIExvdmVsYWNlIDxhbGljZUBvcGVucGdwLmV4YW1wbGU+iJAE
ExYIADgCGwMFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AWIQTrhbtfozp14V6UTmPy
MVUMT0fjjgUCXaWfOgAKCRDyMVUMT0fjjukrAPoDnHBSogOmsHOsd9qGsiZpgRnO
dypvbm+QtXZqth9rvwD9HcDC0tC+PHAsO7OTh1S1TC9RiJsvawAfCPaQZoed8gK4
OARcRwTpEgorBgEEAZdVAQUBAQdAQv8GIa2rSTzgqbXCpDDYMiKRVitCsy203x3s
E9+eviIDAQgHiHgEGBYIACAWIQTrhbtfozp14V6UTmPyMVUMT0fjjgUCXEcE6QIb
DAAKCRDyMVUMT0fjjlnQAQDFHUs6TIcxrNTtEZFjUFm1M0PJ1Dng/cDW4xN80fsn
0QEA22Kr7VkCjeAEC08VSTeV+QFsmz55/lntWkwYWhmvOgE=
=iIGO
-----END PGP PUBLIC KEY BLOCK-----

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 architectures no The new Debian distribution's list of components.
architectures architectures 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=unstable"

Example response:

{
  "id": 1,
  "codename": "unstable",
  "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 architectures no The Debian distribution's new list of components.
architectures architectures 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": "unstable",
  "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 integer 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"