REST API Reference

pulpcore REST API

Each instance of Pulp hosts dynamically generated API documentation located at http://pulpserver/api/v3/docs/ if drf_openapi is installed. This documentation includes the installed pulp plugin endpoints and is a more complete version of the API documented below.

PUT /api/v3/repositorycontents/{id}/

/api/v3/repositorycontents/{id}/

  • Consumes: [‘application/json’]

Parameters

Name Position Description Type
id path A UUID string identifying this repository content. string
data body

Responses

200 - Success

DELETE /api/v3/repositorycontents/{id}/

/api/v3/repositorycontents/{id}/

Parameters

Name Position Description Type
id path A UUID string identifying this repository content. string

Responses

200 - Success

GET /api/v3/repositorycontents/{id}/

/api/v3/repositorycontents/{id}/

Parameters

Name Position Description Type
id path A UUID string identifying this repository content. string

Responses

200 - Success

Name Description Type
repository string
_href string
content string

PATCH /api/v3/repositorycontents/{id}/

/api/v3/repositorycontents/{id}/

  • Consumes: [‘application/json’]

Parameters

Name Position Description Type
id path A UUID string identifying this repository content. string
data body

Responses

200 - Success

POST /api/v3/users/{username}/jwt_reset/

/api/v3/users/{username}/jwt_reset/

  • Consumes: [‘application/json’]

Parameters

Name Position Description Type
username path string
data body

Responses

200 - Success

DELETE /api/v3/artifacts/{id}/

/api/v3/artifacts/{id}/

Parameters

Name Position Description Type
id path A UUID string identifying this artifact. string
md5 query string
sha1 query string
sha224 query string
sha256 query string
sha384 query string
sha512 query string

Responses

200 - Success

GET /api/v3/artifacts/{id}/

/api/v3/artifacts/{id}/

Parameters

Name Position Description Type
id path A UUID string identifying this artifact. string
md5 query string
sha1 query string
sha224 query string
sha256 query string
sha384 query string
sha512 query string

Responses

200 - Success

Name Description Type
file The stored file. string
sha224 The SHA-224 checksum of the file if available. string
sha384 The SHA-384 checksum of the file if available. string
_href string
sha512 The SHA-512 checksum of the file if available. string
sha1 The SHA-1 checksum of the file if available. string
md5 The MD5 checksum of the file if available. string
size The size of the file in bytes. integer
sha256 The SHA-256 checksum of the file if available. string

POST /api/v3/users/

/api/v3/users/

  • Consumes: [‘application/json’]

Parameters

Name Position Description Type
data body

Responses

200 - Success

GET /api/v3/users/

/api/v3/users/

Parameters

Name Position Description Type
cursor query The pagination cursor value. string

Responses

200 - Success

Name Description Type
previous string
next string
results array

GET /api/v3/repositories/{id}/content/

/api/v3/repositories/{id}/content/

Parameters

Name Position Description Type
id path A UUID string identifying this repository. string

Responses

200 - Success

GET /api/v3/docs/

/api/v3/docs/

  • Description: Override to mark schemas as public. :param request: :param version: :return:

Parameters

Name Position Description Type

Responses

200 - Success

PUT /api/v3/users/{username}/

/api/v3/users/{username}/

  • Consumes: [‘application/json’]

Parameters

Name Position Description Type
username path string
data body

Responses

200 - Success

DELETE /api/v3/users/{username}/

/api/v3/users/{username}/

Parameters

Name Position Description Type
username path string

Responses

200 - Success

GET /api/v3/users/{username}/

/api/v3/users/{username}/

Parameters

Name Position Description Type
username path string

Responses

200 - Success

Name Description Type
username Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. string
is_superuser Designates that this user has all permissions without explicitly assigning them. boolean
_href string
password Password string

PATCH /api/v3/users/{username}/

/api/v3/users/{username}/

  • Consumes: [‘application/json’]

Parameters

Name Position Description Type
username path string
data body

Responses

200 - Success

GET /api/v3/workers/{name}/

/api/v3/workers/{name}/

Parameters

Name Position Description Type
name path string

Responses

200 - Success

Name Description Type
online Whether the worker is online or not. Defaults to True. boolean
last_heartbeat Timestamp of the last time the worker talked to the service. string
_href string
name The name of the worker. string

POST /api/v3/repositorycontents/

/api/v3/repositorycontents/

  • Consumes: [‘application/json’]

Parameters

Name Position Description Type
data body

Responses

200 - Success

GET /api/v3/repositorycontents/

/api/v3/repositorycontents/

Parameters

Name Position Description Type
cursor query The pagination cursor value. string

Responses

200 - Success

Name Description Type
previous string
next string
results array

GET /api/v3/workers/

/api/v3/workers/

Parameters

Name Position Description Type
cursor query The pagination cursor value. string

Responses

200 - Success

Name Description Type
previous string
next string
results array

POST /api/v3/tasks/{id}/cancel/

/api/v3/tasks/{id}/cancel/

Parameters

Name Position Description Type
id path A UUID string identifying this task. string

Responses

200 - Success

GET /api/v3/status/

/api/v3/status/

  • Description: Returns app information including the version, known workers, database connection status, and messaging connection status Args: request (rest_framework.request.Request): container representing request state format (str): requested format of the status response (e.g. json) Returns: rest_framework.response.Response: container for the response information

Parameters

Name Position Description Type

Responses

200 - Success

POST /api/v3/artifacts/

/api/v3/artifacts/

  • Consumes: [‘application/json’]

Parameters

Name Position Description Type
data body

Responses

200 - Success

GET /api/v3/artifacts/

/api/v3/artifacts/

Parameters

Name Position Description Type
cursor query The pagination cursor value. string
md5 query string
sha1 query string
sha224 query string
sha256 query string
sha384 query string
sha512 query string

Responses

200 - Success

Name Description Type
previous string
next string
results array

GET /api/v3/tasks/{id}/

/api/v3/tasks/{id}/

Parameters

Name Position Description Type
id path A UUID string identifying this task. string
state query string
worker__name query string
tags query Multiple values may be separated by commas. string

Responses

200 - Success

Name Description Type
state The current state of the task. The possible values include: ‘waiting’, ‘skipped’, ‘running’, ‘completed’, ‘failed’ and ‘canceled’. string
worker The worker associated with this task. This field is empty if a worker is not yet assigned. string
error A JSON Object of a fatal error encountered during the execution of this task. string
group The group that this task belongs to. string
spawned_tasks Any tasks spawned by this task. array
parent The parent task that spawned this task. string
non_fatal_errors A JSON Object of non-fatal errors encountered during the execution of this task. string
tags array
finished_at Timestamp of the when this task stopped execution. string
_href string
started_at Timestamp of the when this task started execution. string
progress_reports array

POST /api/v3/repositories/

/api/v3/repositories/

  • Consumes: [‘application/json’]

Parameters

Name Position Description Type
data body

Responses

200 - Success

GET /api/v3/repositories/

/api/v3/repositories/

Parameters

Name Position Description Type
cursor query The pagination cursor value. string
name query string
name_in_list query Multiple values may be separated by commas. string
content_added_since query string

Responses

200 - Success

Name Description Type
previous string
next string
results array

PUT /api/v3/repositories/{id}/

/api/v3/repositories/{id}/

  • Consumes: [‘application/json’]
  • Description: Generates a Task to update a :class:`~pulpcore.app.models.Repository`

Parameters

Name Position Description Type
id path A UUID string identifying this repository. string
name query string
name_in_list query Multiple values may be separated by commas. string
content_added_since query string
data body

Responses

200 - Success

DELETE /api/v3/repositories/{id}/

/api/v3/repositories/{id}/

  • Description: Generates a Task to delete a :class:`~pulpcore.app.models.Repository`

Parameters

Name Position Description Type
id path A UUID string identifying this repository. string
name query string
name_in_list query Multiple values may be separated by commas. string
content_added_since query string

Responses

200 - Success

GET /api/v3/repositories/{id}/

/api/v3/repositories/{id}/

Parameters

Name Position Description Type
id path A UUID string identifying this repository. string
name query string
name_in_list query Multiple values may be separated by commas. string
content_added_since query string

Responses

200 - Success

Name Description Type
notes A mapping of string keys to string values, for storing notes on this object. string
content_summary A list of counts of each type of content in this repository. string
importers array
_href string
last_content_removed Timestamp of the most recent removal of content to this repository. string
publishers array
content string
description An optional description. string
last_content_added Timestamp of the most recent addition of content to this repository. string
name A unique name for this repository. string

PATCH /api/v3/repositories/{id}/

/api/v3/repositories/{id}/

  • Consumes: [‘application/json’]

Parameters

Name Position Description Type
id path A UUID string identifying this repository. string
name query string
name_in_list query Multiple values may be separated by commas. string
content_added_since query string
data body

Responses

200 - Success

GET /api/v3/tasks/

/api/v3/tasks/

Parameters

Name Position Description Type
cursor query The pagination cursor value. string
state query string
worker__name query string
tags query Multiple values may be separated by commas. string

Responses

200 - Success

Name Description Type
previous string
next string
results array

POST /api/v3/jwt/

/api/v3/jwt/

  • Consumes: [‘application/json’]
  • Description: API View that receives a POST with a user’s username and password. Returns a JSON Web Token that can be used for authenticated requests.

Parameters

Name Position Description Type
data body

Responses

200 - Success