REST API Reference

pulpcore REST API

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

GET /pulp/api/v3/artifacts/
Query Parameters:
 
  • md5 (string) – Filter results where md5 matches value
  • sha1 (string) – Filter results where sha1 matches value
  • sha224 (string) – Filter results where sha224 matches value
  • sha256 (string) – Filter results where sha256 matches value
  • sha384 (string) – Filter results where sha384 matches value
  • sha512 (string) – Filter results where sha512 matches value
  • page (integer) – A page number within the paginated result set.
  • page_size (integer) – Number of results to return per page.
Status Codes:
POST /pulp/api/v3/artifacts/
Status Codes:
GET {artifact_href}
Parameters:
  • artifact_href (string) – URI of Artifact. e.g.: /pulp/api/v3/artifacts/1/
Status Codes:
DELETE {artifact_href}

Remove Artifact only if it is not associated with any Content.

Parameters:
  • artifact_href (string) – URI of Artifact. e.g.: /pulp/api/v3/artifacts/1/
Status Codes:
GET /pulp/api/v3/content/file/files/

ViewSet for FileContent.

Query Parameters:
 
  • relative_path (string) – Filter results where relative_path matches value
  • digest (string) – Filter results where digest matches value
  • repository_version (string) – Repository Version referenced by HREF
  • repository_version_added (string) – Repository Version referenced by HREF
  • repository_version_removed (string) – Repository Version referenced by HREF
  • page (integer) – A page number within the paginated result set.
  • page_size (integer) – Number of results to return per page.
Status Codes:
POST /pulp/api/v3/content/file/files/

ViewSet for FileContent.

Status Codes:
GET {file_content_href}

ViewSet for FileContent.

Parameters:
  • file_content_href (string) – URI of File Content. e.g.: /pulp/api/v3/content/file/files/1/
Status Codes:
GET /pulp/api/v3/distributions/

Provides read and list methods and also provides asynchronous CUD methods to dispatch tasks with reservation that lock all Distributions preventing race conditions during base_path checking.

Query Parameters:
 
  • name (string) –
  • name__in (string) – Filter results where name is in a comma-separated list of values
  • base_path (string) –
  • base_path__contains (string) – Filter results where base_path contains value
  • base_path__icontains (string) – Filter results where base_path contains value
  • base_path__in (string) – Filter results where base_path is in a comma-separated list of values
  • page (integer) – A page number within the paginated result set.
  • page_size (integer) – Number of results to return per page.
Status Codes:
POST /pulp/api/v3/distributions/

Trigger an asynchronous create task

Status Codes:
GET {distribution_href}

Provides read and list methods and also provides asynchronous CUD methods to dispatch tasks with reservation that lock all Distributions preventing race conditions during base_path checking.

Parameters:
  • distribution_href (string) – URI of Distribution. e.g.: /pulp/api/v3/distributions/1/
Status Codes:
PUT {distribution_href}

Trigger an asynchronous update task

Parameters:
  • distribution_href (string) – URI of Distribution. e.g.: /pulp/api/v3/distributions/1/
Status Codes:
PATCH {distribution_href}

Trigger an asynchronous partial update task

Parameters:
  • distribution_href (string) – URI of Distribution. e.g.: /pulp/api/v3/distributions/1/
Status Codes:
DELETE {distribution_href}

Provides read and list methods and also provides asynchronous CUD methods to dispatch tasks with reservation that lock all Distributions preventing race conditions during base_path checking.

Parameters:
  • distribution_href (string) – URI of Distribution. e.g.: /pulp/api/v3/distributions/1/
Status Codes:
DELETE /pulp/api/v3/orphans/

Cleans up all the Content and Artifact orphans in the system

Status Codes:
GET /pulp/api/v3/publications/
Query Parameters:
 
  • ordering (string) – Which field to use when ordering the results.
  • page (integer) – A page number within the paginated result set.
  • page_size (integer) – Number of results to return per page.
Status Codes:
GET {publication_href}
Parameters:
  • publication_href (string) – URI of Publication. e.g.: /pulp/api/v3/publications/1/
Status Codes:
DELETE {publication_href}
Parameters:
  • publication_href (string) – URI of Publication. e.g.: /pulp/api/v3/publications/1/
Status Codes:
GET /pulp/api/v3/publishers/file/file/

ViewSet for File Publishers.

Query Parameters:
 
  • name (string) –
  • name__in (string) – Filter results where name is in a comma-separated list of values
  • _last_updated__lt (string) – Filter results where _last_updated is less than value
  • _last_updated__lte (string) – Filter results where _last_updated is less than or equal to value
  • _last_updated__gt (string) – Filter results where _last_updated is greater than value
  • _last_updated__gte (string) – Filter results where _last_updated is greater than or equal to value
  • _last_updated__range (string) – Filter results where _last_updated is between two comma separated values
  • _last_updated (string) – ISO 8601 formatted dates are supported
  • page (integer) – A page number within the paginated result set.
  • page_size (integer) – Number of results to return per page.
Status Codes:
POST /pulp/api/v3/publishers/file/file/

ViewSet for File Publishers.

Status Codes:
GET {file_publisher_href}

ViewSet for File Publishers.

Parameters:
  • file_publisher_href (string) – URI of File Publisher. e.g.: /pulp/api/v3/publishers/file/file/1/
Status Codes:
PUT {file_publisher_href}

Trigger an asynchronous update task

Parameters:
  • file_publisher_href (string) – URI of File Publisher. e.g.: /pulp/api/v3/publishers/file/file/1/
Status Codes:
PATCH {file_publisher_href}

Trigger an asynchronous partial update task

Parameters:
  • file_publisher_href (string) – URI of File Publisher. e.g.: /pulp/api/v3/publishers/file/file/1/
Status Codes:
DELETE {file_publisher_href}

Trigger an asynchronous delete task

Parameters:
  • file_publisher_href (string) – URI of File Publisher. e.g.: /pulp/api/v3/publishers/file/file/1/
Status Codes:
POST {file_publisher_href}publish/

Trigger an asynchronous task to publish file content.

Parameters:
  • file_publisher_href (string) – URI of File Publisher. e.g.: /pulp/api/v3/publishers/file/file/1/
Status Codes:
GET /pulp/api/v3/remotes/file/file/

ViewSet for File Remotes.

Query Parameters:
 
  • name (string) –
  • name__in (string) – Filter results where name is in a comma-separated list of values
  • _last_updated__lt (string) – Filter results where _last_updated is less than value
  • _last_updated__lte (string) – Filter results where _last_updated is less than or equal to value
  • _last_updated__gt (string) – Filter results where _last_updated is greater than value
  • _last_updated__gte (string) – Filter results where _last_updated is greater than or equal to value
  • _last_updated__range (string) – Filter results where _last_updated is between two comma separated values
  • _last_updated (string) – ISO 8601 formatted dates are supported
  • page (integer) – A page number within the paginated result set.
  • page_size (integer) – Number of results to return per page.
Status Codes:
POST /pulp/api/v3/remotes/file/file/

ViewSet for File Remotes.

Status Codes:
GET {file_remote_href}

ViewSet for File Remotes.

Parameters:
  • file_remote_href (string) – URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/
Status Codes:
PUT {file_remote_href}

Trigger an asynchronous update task

Parameters:
  • file_remote_href (string) – URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/
Status Codes:
PATCH {file_remote_href}

Trigger an asynchronous partial update task

Parameters:
  • file_remote_href (string) – URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/
Status Codes:
DELETE {file_remote_href}

Trigger an asynchronous delete task

Parameters:
  • file_remote_href (string) – URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/
Status Codes:
POST {file_remote_href}sync/

Trigger an asynchronous task to sync file content.

Parameters:
  • file_remote_href (string) – URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/
Status Codes:
GET /pulp/api/v3/repositories/
Query Parameters:
 
  • name (string) –
  • name__in (string) – Filter results where name is in a comma-separated list of values
  • page (integer) – A page number within the paginated result set.
  • page_size (integer) – Number of results to return per page.
Status Codes:
POST /pulp/api/v3/repositories/
Status Codes:
GET {repository_href}
Parameters:
  • repository_href (string) – URI of Repository. e.g.: /pulp/api/v3/repositories/1/
Status Codes:
PUT {repository_href}

Trigger an asynchronous task to updatea repository.

Parameters:
  • repository_href (string) – URI of Repository. e.g.: /pulp/api/v3/repositories/1/
Status Codes:
PATCH {repository_href}
Parameters:
  • repository_href (string) – URI of Repository. e.g.: /pulp/api/v3/repositories/1/
Status Codes:
DELETE {repository_href}

Trigger an asynchronous task to delete a repository.

Parameters:
  • repository_href (string) – URI of Repository. e.g.: /pulp/api/v3/repositories/1/
Status Codes:
GET {repository_href}versions/
Parameters:
  • repository_href (string) – URI of Repository. e.g.: /pulp/api/v3/repositories/1/
Query Parameters:
 
  • ordering (string) – Which field to use when ordering the results.
  • number (number) –
  • number__lt (number) – Filter results where number is less than value
  • number__lte (number) – Filter results where number is less than or equal to value
  • number__gt (number) – Filter results where number is greater than value
  • number__gte (number) – Filter results where number is greater than or equal to value
  • number__range (number) – Filter results where number is between two comma separated values
  • _created__lt (string) – Filter results where _created is less than value
  • _created__lte (string) – Filter results where _created is less than or equal to value
  • _created__gt (string) – Filter results where _created is greater than value
  • _created__gte (string) – Filter results where _created is greater than or equal to value
  • _created__range (string) – Filter results where _created is between two comma separated values
  • content (string) – Content Unit referenced by HREF
  • _created (string) – ISO 8601 formatted dates are supported
  • page (integer) – A page number within the paginated result set.
  • page_size (integer) – Number of results to return per page.
Status Codes:
POST {repository_href}versions/

Trigger an asynchronous task to create a new repository version.

Parameters:
  • repository_href (string) – URI of Repository. e.g.: /pulp/api/v3/repositories/1/
Status Codes:
GET {repository_version_href}
Parameters:
  • repository_version_href (string) – URI of Repository Version. e.g.: /pulp/api/v3/repositories/1/versions/1/
Status Codes:
PUT {repository_version_href}
Parameters:
  • repository_version_href (string) – URI of Repository Version. e.g.: /pulp/api/v3/repositories/1/versions/1/
Status Codes:
PATCH {repository_version_href}
Parameters:
  • repository_version_href (string) – URI of Repository Version. e.g.: /pulp/api/v3/repositories/1/versions/1/
Status Codes:
DELETE {repository_version_href}

Trigger an asynchronous task to delete a repositroy version.

Parameters:
  • repository_version_href (string) – URI of Repository Version. e.g.: /pulp/api/v3/repositories/1/versions/1/
Status Codes:
GET /pulp/api/v3/status/

Returns app information including the version of pulpcore and loaded pulp plugins, known workers, database connection status, and messaging connection status

Status Codes:
GET /pulp/api/v3/tasks/
Query Parameters:
 
  • ordering (string) – Which field to use when ordering the results.
  • state (string) –
  • state__in (string) – Filter results where state is in a comma-separated list of values
  • worker (string) – Foreign Key referenced by HREF
  • worker__in (string) – Filter results where worker is in a comma-separated list of values
  • name__contains (string) – Filter results where name contains value
  • started_at__lt (string) – Filter results where started_at is less than value
  • started_at__lte (string) – Filter results where started_at is less than or equal to value
  • started_at__gt (string) – Filter results where started_at is greater than value
  • started_at__gte (string) – Filter results where started_at is greater than or equal to value
  • started_at__range (string) – Filter results where started_at is between two comma separated values
  • finished_at__lt (string) – Filter results where finished_at is less than value
  • finished_at__lte (string) – Filter results where finished_at is less than or equal to value
  • finished_at__gt (string) – Filter results where finished_at is greater than value
  • finished_at__gte (string) – Filter results where finished_at is greater than or equal to value
  • finished_at__range (string) – Filter results where finished_at is between two comma separated values
  • parent (string) – Foreign Key referenced by HREF
  • name (string) –
  • started_at (string) – ISO 8601 formatted dates are supported
  • finished_at (string) – ISO 8601 formatted dates are supported
  • page (integer) – A page number within the paginated result set.
  • page_size (integer) – Number of results to return per page.
Status Codes:
GET {task_href}
Parameters:
  • task_href (string) – URI of Task. e.g.: /pulp/api/v3/tasks/1/
Status Codes:
DELETE {task_href}
Parameters:
  • task_href (string) – URI of Task. e.g.: /pulp/api/v3/tasks/1/
Status Codes:
POST {task_href}cancel/
Parameters:
  • task_href (string) – URI of Task. e.g.: /pulp/api/v3/tasks/1/
Status Codes:
GET /pulp/api/v3/uploads/

Handle GET requests.

Status Codes:
POST /pulp/api/v3/uploads/

Handle POST requests.

Status Codes:
PUT /pulp/api/v3/uploads/

Handle PUT requests.

Status Codes:
GET {upload_href}

Handle GET requests.

Parameters:
  • upload_href (string) – URI of Upload. e.g.: /pulp/api/v3/uploads/1/
Status Codes:
POST {upload_href}

Handle POST requests.

Parameters:
  • upload_href (string) – URI of Upload. e.g.: /pulp/api/v3/uploads/1/
Status Codes:
PUT {upload_href}

Handle PUT requests.

Parameters:
  • upload_href (string) – URI of Upload. e.g.: /pulp/api/v3/uploads/1/
Status Codes:
GET /pulp/api/v3/workers/
Query Parameters:
 
  • name (string) –
  • name__in (string) – Filter results where name is in a comma-separated list of values
  • last_heartbeat__lt (string) – Filter results where last_heartbeat is less than value
  • last_heartbeat__lte (string) – Filter results where last_heartbeat is less than or equal to value
  • last_heartbeat__gt (string) – Filter results where last_heartbeat is greater than value
  • last_heartbeat__gte (string) – Filter results where last_heartbeat is greater than or equal to value
  • last_heartbeat__range (string) – Filter results where last_heartbeat is between two comma separated values
  • online (string) –
  • missing (string) –
  • last_heartbeat (string) – ISO 8601 formatted dates are supported
  • page (integer) – A page number within the paginated result set.
  • page_size (integer) – Number of results to return per page.
Status Codes:
GET {worker_href}
Parameters:
  • worker_href (string) – URI of Worker. e.g.: /pulp/api/v3/workers/1/
Status Codes: