|
info:
|
|
description: ''
|
|
title: Pulp API
|
|
version: ''
|
|
openapi: 3.0.0
|
|
paths:
|
|
/pulp/api/v3/artifacts/:
|
|
get:
|
|
operationId: artifacts_list
|
|
parameters:
|
|
- in: query
|
|
name: page
|
|
schema:
|
|
description: A page number within the paginated result set.
|
|
title: !!python/tuple
|
|
- Page
|
|
type: integer
|
|
- in: query
|
|
name: page_size
|
|
schema:
|
|
description: Number of results to return per page.
|
|
title: !!python/tuple
|
|
- Page size
|
|
type: integer
|
|
- in: query
|
|
name: md5
|
|
schema:
|
|
description: Filter results where md5 matches value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: sha1
|
|
schema:
|
|
description: Filter results where sha1 matches value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: sha224
|
|
schema:
|
|
description: Filter results where sha224 matches value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: sha256
|
|
schema:
|
|
description: Filter results where sha256 matches value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: sha384
|
|
schema:
|
|
description: Filter results where sha384 matches value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: sha512
|
|
schema:
|
|
description: Filter results where sha512 matches value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
tags:
|
|
- artifacts
|
|
post:
|
|
operationId: artifacts_create
|
|
tags:
|
|
- artifacts
|
|
/pulp/api/v3/artifacts/{_id}/:
|
|
delete:
|
|
description: Remove Artifact only if it is not associated with any Content.
|
|
operationId: artifacts_delete
|
|
parameters:
|
|
- in: path
|
|
name: _id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this artifact.
|
|
title: !!python/tuple
|
|
- ' id'
|
|
type: integer
|
|
tags:
|
|
- artifacts
|
|
get:
|
|
operationId: artifacts_read
|
|
parameters:
|
|
- in: path
|
|
name: _id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this artifact.
|
|
title: !!python/tuple
|
|
- ' id'
|
|
type: integer
|
|
tags:
|
|
- artifacts
|
|
/pulp/api/v3/distributions/:
|
|
get:
|
|
operationId: distributions_list
|
|
parameters:
|
|
- in: query
|
|
name: page
|
|
schema:
|
|
description: A page number within the paginated result set.
|
|
title: !!python/tuple
|
|
- Page
|
|
type: integer
|
|
- in: query
|
|
name: page_size
|
|
schema:
|
|
description: Number of results to return per page.
|
|
title: !!python/tuple
|
|
- Page size
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
description: ''
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: name__in
|
|
schema:
|
|
description: Filter results where name is in a comma-separated list of values
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: base_path
|
|
schema:
|
|
description: ''
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: base_path__contains
|
|
schema:
|
|
description: Filter results where base_path contains value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: base_path__icontains
|
|
schema:
|
|
description: Filter results where base_path contains value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: base_path__in
|
|
schema:
|
|
description: Filter results where base_path is in a comma-separated list
|
|
of values
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
tags:
|
|
- distributions
|
|
post:
|
|
operationId: distributions_create
|
|
tags:
|
|
- distributions
|
|
/pulp/api/v3/distributions/{_id}/:
|
|
delete:
|
|
operationId: distributions_delete
|
|
parameters:
|
|
- in: path
|
|
name: _id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this distribution.
|
|
title: !!python/tuple
|
|
- ' id'
|
|
type: integer
|
|
tags:
|
|
- distributions
|
|
get:
|
|
operationId: distributions_read
|
|
parameters:
|
|
- in: path
|
|
name: _id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this distribution.
|
|
title: !!python/tuple
|
|
- ' id'
|
|
type: integer
|
|
tags:
|
|
- distributions
|
|
patch:
|
|
operationId: distributions_partial_update
|
|
parameters:
|
|
- in: path
|
|
name: _id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this distribution.
|
|
title: !!python/tuple
|
|
- ' id'
|
|
type: integer
|
|
tags:
|
|
- distributions
|
|
put:
|
|
operationId: distributions_update
|
|
parameters:
|
|
- in: path
|
|
name: _id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this distribution.
|
|
title: !!python/tuple
|
|
- ' id'
|
|
type: integer
|
|
tags:
|
|
- distributions
|
|
/pulp/api/v3/orphans/:
|
|
delete:
|
|
description: Cleans up all the Content and Artifact orphans in the system
|
|
operationId: orphans_delete
|
|
tags:
|
|
- orphans
|
|
/pulp/api/v3/publications/:
|
|
get:
|
|
operationId: publications_list
|
|
parameters:
|
|
- in: query
|
|
name: page
|
|
schema:
|
|
description: A page number within the paginated result set.
|
|
title: !!python/tuple
|
|
- Page
|
|
type: integer
|
|
- in: query
|
|
name: page_size
|
|
schema:
|
|
description: Number of results to return per page.
|
|
title: !!python/tuple
|
|
- Page size
|
|
type: integer
|
|
- in: query
|
|
name: ordering
|
|
schema:
|
|
description: Which field to use when ordering the results.
|
|
title: !!python/tuple
|
|
- Ordering
|
|
type: string
|
|
tags:
|
|
- publications
|
|
/pulp/api/v3/publications/{_id}/:
|
|
delete:
|
|
operationId: publications_delete
|
|
parameters:
|
|
- in: path
|
|
name: _id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this publication.
|
|
title: !!python/tuple
|
|
- ' id'
|
|
type: integer
|
|
tags:
|
|
- publications
|
|
get:
|
|
operationId: publications_read
|
|
parameters:
|
|
- in: path
|
|
name: _id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this publication.
|
|
title: !!python/tuple
|
|
- ' id'
|
|
type: integer
|
|
tags:
|
|
- publications
|
|
/pulp/api/v3/repositories/:
|
|
get:
|
|
operationId: repositories_list
|
|
parameters:
|
|
- in: query
|
|
name: page
|
|
schema:
|
|
description: A page number within the paginated result set.
|
|
title: !!python/tuple
|
|
- Page
|
|
type: integer
|
|
- in: query
|
|
name: page_size
|
|
schema:
|
|
description: Number of results to return per page.
|
|
title: !!python/tuple
|
|
- Page size
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
description: ''
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: name__in
|
|
schema:
|
|
description: Filter results where name is in a comma-separated list of values
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
tags:
|
|
- repositories
|
|
post:
|
|
operationId: repositories_create
|
|
tags:
|
|
- repositories
|
|
/pulp/api/v3/repositories/{_id}/:
|
|
delete:
|
|
description: Generates a Task to delete a Repository
|
|
operationId: repositories_delete
|
|
parameters:
|
|
- in: path
|
|
name: _id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this repository.
|
|
title: !!python/tuple
|
|
- ' id'
|
|
type: integer
|
|
tags:
|
|
- repositories
|
|
get:
|
|
operationId: repositories_read
|
|
parameters:
|
|
- in: path
|
|
name: _id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this repository.
|
|
title: !!python/tuple
|
|
- ' id'
|
|
type: integer
|
|
tags:
|
|
- repositories
|
|
patch:
|
|
operationId: repositories_partial_update
|
|
parameters:
|
|
- in: path
|
|
name: _id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this repository.
|
|
title: !!python/tuple
|
|
- ' id'
|
|
type: integer
|
|
tags:
|
|
- repositories
|
|
put:
|
|
description: Generates a Task to update a Repository
|
|
operationId: repositories_update
|
|
parameters:
|
|
- in: path
|
|
name: _id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this repository.
|
|
title: !!python/tuple
|
|
- ' id'
|
|
type: integer
|
|
tags:
|
|
- repositories
|
|
/pulp/api/v3/status/:
|
|
get:
|
|
description: 'Returns app information including the version of pulpcore and
|
|
loaded pulp plugins,
|
|
|
|
known workers, database connection status, and messaging connection status'
|
|
operationId: status_list
|
|
tags:
|
|
- status
|
|
/pulp/api/v3/tasks/:
|
|
get:
|
|
operationId: tasks_list
|
|
parameters:
|
|
- in: query
|
|
name: page
|
|
schema:
|
|
description: A page number within the paginated result set.
|
|
title: !!python/tuple
|
|
- Page
|
|
type: integer
|
|
- in: query
|
|
name: page_size
|
|
schema:
|
|
description: Number of results to return per page.
|
|
title: !!python/tuple
|
|
- Page size
|
|
type: integer
|
|
- in: query
|
|
name: ordering
|
|
schema:
|
|
description: Which field to use when ordering the results.
|
|
title: !!python/tuple
|
|
- Ordering
|
|
type: string
|
|
- in: query
|
|
name: state
|
|
schema:
|
|
description: ''
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: state__in
|
|
schema:
|
|
description: Filter results where state is in a comma-separated list of
|
|
values
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: worker
|
|
schema:
|
|
description: Foreign Key referenced by HREF
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: worker__in
|
|
schema:
|
|
description: Filter results where worker is in a comma-separated list of
|
|
values
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: started_at__lt
|
|
schema:
|
|
description: Filter results where started_at is less than value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: started_at__lte
|
|
schema:
|
|
description: Filter results where started_at is less than or equal to value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: started_at__gt
|
|
schema:
|
|
description: Filter results where started_at is greater than value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: started_at__gte
|
|
schema:
|
|
description: Filter results where started_at is greater than or equal to
|
|
value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: started_at__range
|
|
schema:
|
|
description: Filter results where started_at is between two comma separated
|
|
values
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: finished_at__lt
|
|
schema:
|
|
description: Filter results where finished_at is less than value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: finished_at__lte
|
|
schema:
|
|
description: Filter results where finished_at is less than or equal to value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: finished_at__gt
|
|
schema:
|
|
description: Filter results where finished_at is greater than value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: finished_at__gte
|
|
schema:
|
|
description: Filter results where finished_at is greater than or equal to
|
|
value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: finished_at__range
|
|
schema:
|
|
description: Filter results where finished_at is between two comma separated
|
|
values
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: parent
|
|
schema:
|
|
description: Foreign Key referenced by HREF
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: started_at
|
|
schema:
|
|
description: ISO 8601 formatted dates are supported
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: finished_at
|
|
schema:
|
|
description: ISO 8601 formatted dates are supported
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
tags:
|
|
- tasks
|
|
/pulp/api/v3/tasks/{_id}/:
|
|
delete:
|
|
operationId: tasks_delete
|
|
parameters:
|
|
- in: path
|
|
name: _id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this task.
|
|
title: !!python/tuple
|
|
- ' id'
|
|
type: integer
|
|
tags:
|
|
- tasks
|
|
get:
|
|
operationId: tasks_read
|
|
parameters:
|
|
- in: path
|
|
name: _id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this task.
|
|
title: !!python/tuple
|
|
- ' id'
|
|
type: integer
|
|
tags:
|
|
- tasks
|
|
/pulp/api/v3/tasks/{_id}/cancel/:
|
|
post:
|
|
operationId: tasks_cancel
|
|
parameters:
|
|
- in: path
|
|
name: _id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this task.
|
|
title: !!python/tuple
|
|
- ' id'
|
|
type: integer
|
|
tags:
|
|
- tasks
|
|
/pulp/api/v3/users/:
|
|
get:
|
|
operationId: users_list
|
|
parameters:
|
|
- in: query
|
|
name: page
|
|
schema:
|
|
description: A page number within the paginated result set.
|
|
title: !!python/tuple
|
|
- Page
|
|
type: integer
|
|
- in: query
|
|
name: page_size
|
|
schema:
|
|
description: Number of results to return per page.
|
|
title: !!python/tuple
|
|
- Page size
|
|
type: integer
|
|
- in: query
|
|
name: username
|
|
schema:
|
|
description: ''
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: username__in
|
|
schema:
|
|
description: Filter results where username is in a comma-separated list
|
|
of values
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
tags:
|
|
- users
|
|
post:
|
|
operationId: users_create
|
|
tags:
|
|
- users
|
|
/pulp/api/v3/users/{id}/:
|
|
delete:
|
|
operationId: users_delete
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this user.
|
|
title: !!python/tuple
|
|
- ID
|
|
type: integer
|
|
tags:
|
|
- users
|
|
get:
|
|
operationId: users_read
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this user.
|
|
title: !!python/tuple
|
|
- ID
|
|
type: integer
|
|
tags:
|
|
- users
|
|
patch:
|
|
operationId: users_partial_update
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this user.
|
|
title: !!python/tuple
|
|
- ID
|
|
type: integer
|
|
tags:
|
|
- users
|
|
put:
|
|
operationId: users_update
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this user.
|
|
title: !!python/tuple
|
|
- ID
|
|
type: integer
|
|
tags:
|
|
- users
|
|
/pulp/api/v3/workers/:
|
|
get:
|
|
operationId: workers_list
|
|
parameters:
|
|
- in: query
|
|
name: page
|
|
schema:
|
|
description: A page number within the paginated result set.
|
|
title: !!python/tuple
|
|
- Page
|
|
type: integer
|
|
- in: query
|
|
name: page_size
|
|
schema:
|
|
description: Number of results to return per page.
|
|
title: !!python/tuple
|
|
- Page size
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
description: ''
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: name__in
|
|
schema:
|
|
description: Filter results where name is in a comma-separated list of values
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: last_heartbeat__lt
|
|
schema:
|
|
description: Filter results where last_heartbeat is less than value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: last_heartbeat__lte
|
|
schema:
|
|
description: Filter results where last_heartbeat is less than or equal to
|
|
value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: last_heartbeat__gt
|
|
schema:
|
|
description: Filter results where last_heartbeat is greater than value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: last_heartbeat__gte
|
|
schema:
|
|
description: Filter results where last_heartbeat is greater than or equal
|
|
to value
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: last_heartbeat__range
|
|
schema:
|
|
description: Filter results where last_heartbeat is between two comma separated
|
|
values
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: online
|
|
schema:
|
|
description: ''
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: missing
|
|
schema:
|
|
description: ''
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
- in: query
|
|
name: last_heartbeat
|
|
schema:
|
|
description: ISO 8601 formatted dates are supported
|
|
title: !!python/tuple
|
|
- ''
|
|
type: string
|
|
tags:
|
|
- workers
|
|
/pulp/api/v3/workers/{_id}/:
|
|
get:
|
|
operationId: workers_read
|
|
parameters:
|
|
- in: path
|
|
name: _id
|
|
required: true
|
|
schema:
|
|
description: A unique integer value identifying this worker.
|
|
title: !!python/tuple
|
|
- ' id'
|
|
type: integer
|
|
tags:
|
|
- workers
|
|
servers:
|
|
- url: http://localhost:8000/pulp/api/v3/
|
|
|